Documentation/public-inbox-edit.pod | 14 ++++++++++++++ Documentation/public-inbox-purge.pod | 14 ++++++++++++++ Documentation/public-inbox-xcpdb.pod | 15 +++++++++++++-- diff --git a/Documentation/public-inbox-edit.pod b/Documentation/public-inbox-edit.pod index c64b4da84c131042a7c1295f1dbc31e23530d0cd..3853fa9c118fce4c7574f40bed65b27dede76978 100644 --- a/Documentation/public-inbox-edit.pod +++ b/Documentation/public-inbox-edit.pod @@ -91,6 +91,20 @@ =head1 LIMITATIONS 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 distruptive +to anyone using L to mirror the inbox being edited. + =head1 CONTACT Feedback welcome via plain-text mail to L diff --git a/Documentation/public-inbox-purge.pod b/Documentation/public-inbox-purge.pod index 56a3f95a7cca8bdacc7ffd275c135e91b49bb3a4..e20e18dfccb90d7c67e2b0ffaec9d0e06f1d3184 100644 --- a/Documentation/public-inbox-purge.pod +++ b/Documentation/public-inbox-purge.pod @@ -51,6 +51,20 @@ =head1 LIMITATIONS Only L inboxes 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 +purged data remaining indexed. + +Incremental L (without C<--reindex>) +is fine. + +Keep in mind this is a last resort, as it will be distruptive +to anyone using L to mirror the inbox being purged. + =head1 CONTACT Feedback welcome via plain-text mail to L diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod index 89eed079ddc497bc43986efffd70e2739831704e..2ed4c5821087b8cc637935391cd4f3c8d8e19c0a 100644 --- a/Documentation/public-inbox-xcpdb.pod +++ b/Documentation/public-inbox-xcpdb.pod @@ -11,8 +11,9 @@ public-inbox-xcpdb is similar to L for upgrading to the latest database format supported by Xapian (e.g. "glass" or "honey"), but is designed to tolerate and -recover from Xapian database modifications from -L or L. +accept parallel Xapian database modifications from +L, L, +L, and L. =head1 OPTIONS @@ -79,6 +80,16 @@ used by public-inbox, NOT users upgrading public-inbox itself. In particular, it DOES NOT upgrade the schema used by the PSGI search interface (see L). + +=head1 LIMITATIONS + +Do not use L or L +while this is running; old (purged or edited data) may show up. + +Normal invocations L can safely run +while this is running, too. However, reindexing via the +L switch will be a waste of +computing resources. =head1 CONTACT