From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id BE1F520606 for ; Thu, 23 May 2019 09:37:11 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 18/26] doc: xcpdb: update to reflect the current state Date: Thu, 23 May 2019 09:36:56 +0000 Message-Id: <20190523093704.18367-19-e@80x24.org> In-Reply-To: <20190523093704.18367-1-e@80x24.org> References: <20190523093704.18367-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: It is no longer a wrapper around copydatabase(1), since copydatabase did not recover from DatabaseModifiedError. --- Documentation/public-inbox-xcpdb.pod | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod index 4ff5186..c47500b 100644 --- a/Documentation/public-inbox-xcpdb.pod +++ b/Documentation/public-inbox-xcpdb.pod @@ -8,13 +8,11 @@ public-inbox-xcpdb - copy Xapian DBs (for format upgrades) =head1 DESCRIPTION -public-inbox-xcpdb is a wrapper for L for +public-inbox-xcpdb is similar to L for upgrading to the latest database format supported by Xapian -(e.g. "glass" or "honey"). - -It locks the inbox and prevents other processes such as -L and L from -writing while it operates. +(e.g. "glass" or "honey"), but is designed to tolerate and +recover from Xapian database modifications from +L or L. This is intended for upgrading the database format used by Xapian. It DOES NOT upgrade the schema used by the @@ -29,6 +27,14 @@ public-inbox search interface (see L). The default config file, normally "~/.public-inbox/config". See L +=item XAPIAN_FLUSH_THRESHOLD + +The number of documents to update before committing changes to +disk. This environment is handled directly by Xapian, refer to +Xapian API documentation for more details. + +Default: 10000 + =back =head1 UPGRADING -- EW