From: Eric Wong <e@yhbt.net>
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 [thread overview]
Message-ID: <20200810021205.18909-5-e@yhbt.net> (raw)
In-Reply-To: <20200810021205.18909-1-e@yhbt.net>
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<public-inbox-config(5)>
Only L<v2|public-inbox-v2-format(5)> repositories are supported.
+This is safe to run while normal inbox writing tools
+(L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
+L<public-inbox-learn(1)>) are active.
+
+Running this in parallel with L<public-inbox-xcpdb(1)> or
+C<"public-inbox-index --reindex"> can lead to errors or
+edited data remaining indexed.
+
+Incremental L<public-inbox-index(1)> (without C<--reindex>)
+is fine.
+
+Keep in mind this is a last resort, as it will be distruptive
+to anyone using L<git(1)> to mirror the inbox being edited.
+
=head1 CONTACT
Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
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<public-inbox-config(5)>
Only L<public-inbox-v2-format(5)> inboxes are supported.
+This is safe to run while normal inbox writing tools
+(L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
+L<public-inbox-learn(1)>) are active.
+
+Running this in parallel with L<public-inbox-xcpdb(1)> or
+C<"public-inbox-index --reindex"> can lead to errors or
+purged data remaining indexed.
+
+Incremental L<public-inbox-index(1)> (without C<--reindex>)
+is fine.
+
+Keep in mind this is a last resort, as it will be distruptive
+to anyone using L<git(1)> to mirror the inbox being purged.
+
=head1 CONTACT
Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
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<copydatabase(1)> 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<public-inbox-watch(1)> or L<public-inbox-mda(1)>.
+accept parallel Xapian database modifications from
+L<public-inbox-watch(1)>, L<public-inbox-mda(1)>,
+L<public-inbox-learn(1)>, and L<public-inbox-index(1)>.
=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<public-inbox-index(1)>).
+=head1 LIMITATIONS
+
+Do not use L<public-inbox-purge(1)> or L<public-inbox-edit(1)>
+while this is running; old (purged or edited data) may show up.
+
+Normal invocations L<public-inbox-index(1)> can safely run
+while this is running, too. However, reindexing via the
+L<public-inbox-index(1)/--reindex> switch will be a waste of
+computing resources.
+
=head1 CONTACT
Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
next prev parent reply other threads:[~2020-08-10 2:12 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-10 2:11 [PATCH 00/14] more indexing related improvements Eric Wong
2020-08-10 2:11 ` [PATCH 01/14] index: require --reindex when using --xapian-only Eric Wong
2020-08-10 2:11 ` [PATCH 02/14] index: --sequential-shard works incrementally Eric Wong
2020-08-10 2:11 ` [PATCH 03/14] doc: index: more notes about latest changes Eric Wong
2020-08-10 2:38 ` Kyle Meyer
2020-08-10 6:29 ` Eric Wong
2020-08-10 2:11 ` Eric Wong [this message]
2020-08-10 2:11 ` [PATCH 05/14] index+xcpdb: improve SIG{INT,TERM,HUP,PIPE} behavior Eric Wong
2020-08-10 2:11 ` [PATCH 06/14] msgmap: tmp_clone: simplify + meaningful filename Eric Wong
2020-08-10 2:11 ` [PATCH 07/14] avoid File::Temp::tempfile in more places Eric Wong
2020-08-10 2:11 ` [PATCH 08/14] admin: use a generic veriable name Eric Wong
2020-08-10 2:38 ` Kyle Meyer
2020-08-10 2:12 ` [PATCH 09/14] index: cleanup internal variables Eric Wong
2020-08-10 2:12 ` [PATCH 10/14] searchidx: use singular `$opt' for consistency with v2 Eric Wong
2020-08-10 2:12 ` [PATCH 11/14] convert: support new -index options Eric Wong
2020-08-10 2:12 ` [PATCH 12/14] convert: speed up --help Eric Wong
2020-08-10 2:12 ` [PATCH 13/14] convert: check ARGV more correctly Eric Wong
2020-08-10 2:12 ` [PATCH 14/14] convert: set No_COW on copied SQLite files Eric Wong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://public-inbox.org/README
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200810021205.18909-5-e@yhbt.net \
--to=e@yhbt.net \
--cc=meta@public-inbox.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).