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-v1-format.pod | 4 ++++
 1 file changed, 4 insertions(+)

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

diff --git a/Documentation/public-inbox-v1-format.pod b/Documentation/public-inbox-v1-format.pod
index 2a6b8d3c..3b0e70e1 100644
--- a/Documentation/public-inbox-v1-format.pod
+++ b/Documentation/public-inbox-v1-format.pod
@@ -134,6 +134,10 @@ Since SCHEMA_VERSION 15 and the development of the v2 format,
 the "overview" DB also exists in the xapian directory for v1
 repositories.  See L<public-inbox-v2-format(5)/OVERVIEW DB>
 
+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.
+
 =item $GIT_DIR/ssoma.index
 
 This file is no longer used or created by public-inbox, but it is
-- 
cgit v1.2.3-24-ge0c7