X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-edit.pod;h=55d1c1630533fd126f36f28ec34dfc31235e9c40;hb=933fce93167eba8645e637c363561575db9f9420;hp=97c7c92aeb37fd796ccfb926f05f4e09cb9163e4;hpb=d9aad3a7988262b31ab2171f2c982daf04ac822c;p=public-inbox.git diff --git a/Documentation/public-inbox-edit.pod b/Documentation/public-inbox-edit.pod index 97c7c92a..55d1c163 100644 --- a/Documentation/public-inbox-edit.pod +++ b/Documentation/public-inbox-edit.pod @@ -1,6 +1,6 @@ =head1 NAME -public-inbox-edit - edit messages in a public inbox +public-inbox-edit - destructively edit messages in a public inbox =head1 SYNOPSIS @@ -73,10 +73,10 @@ Default: none =over 8 -=for comment MAIL_EDITOR is undocumented (unstable, don't want naming conflicts) - =item GIT_EDITOR / VISUAL / EDITOR +=for comment MAIL_EDITOR is undocumented (unstable, don't want naming conflicts) + public-inbox-edit will fall back to using one of these variables (in that order) if C is unset. @@ -91,6 +91,20 @@ See L Only L repositories are supported. +This is safe to run while normal inbox writing tools +(L, L, +L) are active. + +Running this in parallel with L or +C<"public-inbox-index --reindex"> can lead to errors or +edited data remaining indexed. + +Incremental L (without C<--reindex>) +is fine. + +Keep in mind this is a last resort, as it will be disruptive +to anyone using L to mirror the inbox being edited. + =head1 CONTACT Feedback welcome via plain-text mail to L @@ -100,10 +114,10 @@ and L =head1 COPYRIGHT -Copyright 2019 all contributors L +Copyright 2019-2020 all contributors L License: AGPL-3.0+ L =head1 SEE ALSO -L +L