about summary refs log tree commit homepage
path: root/Documentation/public-inbox-purge.pod
diff options
authorEric Wong <e@yhbt.net>2020-08-10 02:11:55 +0000
committerEric Wong <e@yhbt.net>2020-08-10 05:56:02 +0000
commit425acc673f5394b0e8472558921db949eac034a5 (patch)
tree3173ebfaabda7d1e0be11bc6338145215843c91d /Documentation/public-inbox-purge.pod
parentc1e29b1a8ef1aeafc21c5524ae7e20b467627cf5 (diff)
These rarely-used commands have some caveats that needed
expanding on.
Diffstat (limited to 'Documentation/public-inbox-purge.pod')
1 files changed, 14 insertions, 0 deletions
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>