X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-edit.pod;h=8014d7c37b6571d558059bdd351513aa5ade5c05;hb=af0b0fb7a454470a32c452119d0392e0dedb3fe1;hp=120f3c3b600ac519e2b5cae0b3affd36c302b147;hpb=73b984ffaea57d0b19fdfd1ded947d90918862b9;p=public-inbox.git diff --git a/Documentation/public-inbox-edit.pod b/Documentation/public-inbox-edit.pod index 120f3c3b..8014d7c3 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 @@ -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-2021 all contributors L License: AGPL-3.0+ L =head1 SEE ALSO -L +L