about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2019-05-23 09:36:41 +0000
committerEric Wong <e@80x24.org>2019-05-23 17:43:50 +0000
commitd2de7f85982da35d2e8a6fda48784946f6443f65 (patch)
tree186524d2e277a98ab810350f99ce17bfc03d04c4 /Documentation
parent96a27a0a073b61c465240bbbbb05a4c16f67c8d4 (diff)
downloadpublic-inbox-d2de7f85982da35d2e8a6fda48784946f6443f65.tar.gz
We're going to need copydatabase, too
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/public-inbox-v1-format.pod4
-rw-r--r--Documentation/public-inbox-v2-format.pod4
2 files changed, 8 insertions, 0 deletions
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
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