From d2de7f85982da35d2e8a6fda48784946f6443f65 Mon Sep 17 00:00:00 2001
From: Eric Wong <e@80x24.org>
Date: Thu, 23 May 2019 09:36:41 +0000
Subject: doc: document the reason for --no-renumber

We're going to need copydatabase, too
---
 Documentation/public-inbox-v2-format.pod | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'Documentation/public-inbox-v2-format.pod')

diff --git a/Documentation/public-inbox-v2-format.pod b/Documentation/public-inbox-v2-format.pod
index 7dfe3296..bc58074e 100644
--- a/Documentation/public-inbox-v2-format.pod
+++ b/Documentation/public-inbox-v2-format.pod
@@ -117,6 +117,10 @@ Rotational storage devices are NOT recommended for indexing of
 large mail archives; but are fine for backup and usable for
 small instances.
 
+Our use of the L</OVERVIEW DB> requires Xapian document IDs to
+remain stable.  Thus, use of L<xapian-compact(1)> and
+L<copydatabase(8)> require the use of C<--no-renumber> switch.
+
 =head2 OVERVIEW DB
 
 Towards the end of v2 development, it became apparent Xapian did
-- 
cgit v1.2.3-24-ge0c7