* [PATCH 04/14] doc: add some notes around -xcpdb / -edit / -purge
2020-08-10 2:11 7% [PATCH 00/14] more indexing related improvements Eric Wong
@ 2020-08-10 2:11 5% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2020-08-10 2:11 UTC (permalink / raw)
To: meta
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>
^ permalink raw reply related [relevance 5%]
* [PATCH 00/14] more indexing related improvements
@ 2020-08-10 2:11 7% Eric Wong
2020-08-10 2:11 5% ` [PATCH 04/14] doc: add some notes around -xcpdb / -edit / -purge Eric Wong
0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2020-08-10 2:11 UTC (permalink / raw)
To: meta
publicInbox.indexSequentialShard now works incrementally
-convert also learned all the options -index learned,
so it can be less painful on HDDs.
Eric Wong (14):
index: require --reindex when using --xapian-only
index: --sequential-shard works incrementally
doc: index: some more notes about latest changes
doc: add some notes around -xcpdb / -edit / -purge
index+xcpdb: improve SIG{INT,TERM,HUP,PIPE} behavior
msgmap: tmp_clone: simplify + meaningful filename
avoid File::Temp::tempfile in more places
admin: use a generic veriable name
index: cleanup internal variables
searchidx: use singular `$opt' for consistency with v2
convert: support new -index options
convert: speed up --help
convert: check ARGV more correctly
convert: set No_COW on copied SQLite files
Documentation/public-inbox-convert.pod | 19 ++++
Documentation/public-inbox-edit.pod | 14 +++
Documentation/public-inbox-index.pod | 68 +++++++------
Documentation/public-inbox-init.pod | 2 +-
Documentation/public-inbox-purge.pod | 14 +++
Documentation/public-inbox-xcpdb.pod | 15 ++-
lib/PublicInbox/Admin.pm | 71 ++++++++++++--
lib/PublicInbox/Msgmap.pm | 19 ++--
lib/PublicInbox/SearchIdx.pm | 34 +++----
lib/PublicInbox/V2Writable.pm | 77 ++++++++-------
lib/PublicInbox/Xapcmd.pm | 28 ++++--
script/public-inbox-convert | 131 ++++++++++++++++---------
script/public-inbox-index | 69 ++++---------
script/public-inbox-init | 17 ++--
t/import.t | 5 +-
15 files changed, 357 insertions(+), 226 deletions(-)
^ permalink raw reply [relevance 7%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2020-08-10 2:11 7% [PATCH 00/14] more indexing related improvements Eric Wong
2020-08-10 2:11 5% ` [PATCH 04/14] doc: add some notes around -xcpdb / -edit / -purge Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
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).