From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 19D511F670 for ; Mon, 10 Aug 2020 02:12:06 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 04/14] doc: add some notes around -xcpdb / -edit / -purge Date: Mon, 10 Aug 2020 02:11:55 +0000 Message-Id: <20200810021205.18909-5-e@yhbt.net> In-Reply-To: <20200810021205.18909-1-e@yhbt.net> References: <20200810021205.18909-1-e@yhbt.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: These rarely-used commands have some caveats that needed expanding on. --- Documentation/public-inbox-edit.pod | 14 ++++++++++++++ Documentation/public-inbox-purge.pod | 14 ++++++++++++++ Documentation/public-inbox-xcpdb.pod | 15 +++++++++++++-- 3 files changed, 41 insertions(+), 2 deletions(-) diff --git a/Documentation/public-inbox-edit.pod b/Documentation/public-inbox-edit.pod index c64b4da8..3853fa9c 100644 --- a/Documentation/public-inbox-edit.pod +++ b/Documentation/public-inbox-edit.pod @@ -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 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 56a3f95a..e20e18df 100644 --- a/Documentation/public-inbox-purge.pod +++ b/Documentation/public-inbox-purge.pod @@ -51,6 +51,20 @@ See L 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 89eed079..2ed4c582 100644 --- a/Documentation/public-inbox-xcpdb.pod +++ b/Documentation/public-inbox-xcpdb.pod @@ -11,8 +11,9 @@ public-inbox-xcpdb - upgrade Xapian DB formats 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 @@ -80,6 +81,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 Feedback welcome via plain-text mail to L