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 5848B1FD57 for ; Sun, 2 Feb 2020 06:52:24 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 8/9] doc: -convert: document switches Date: Sun, 2 Feb 2020 06:52:21 +0000 Message-Id: <20200202065222.14966-9-e@yhbt.net> In-Reply-To: <20200202065222.14966-1-e@yhbt.net> References: <20200202065222.14966-1-e@yhbt.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: These switches have always been there, but were not documented until now. --- Documentation/public-inbox-convert.pod | 41 ++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/Documentation/public-inbox-convert.pod b/Documentation/public-inbox-convert.pod index 4c790dee..417e5e4e 100644 --- a/Documentation/public-inbox-convert.pod +++ b/Documentation/public-inbox-convert.pod @@ -4,7 +4,7 @@ public-inbox-convert - convert v1 inboxes to v2 =head1 SYNOPSIS - public-inbox-convert OLD_DIR NEW_DIR + public-inbox-convert [OPTIONS] OLD_DIR NEW_DIR =head1 DESCRIPTION @@ -14,6 +14,27 @@ and users are expected to update the "inboxdir" path in L to point to the path of NEW_DIR once they are satisfied with the conversion. +=head1 OPTIONS + +=over + +=item --no-index + +Disables Xapian and overview DB indexing on the new repository. +By default, public-inbox-convert creates a new index in the v2 +repository and indexes all existing messages, a lengthy +operation for large inboxes. + +=item -j JOBS, --jobs=JOBS + +Control the number of indexing jobs and Xapian shards of the v2 +inbox. By default, this is the detected CPU count but capped +at 4 due to various bottlenecks. The number of Xapian shards +will be 1 less than the JOBS value, since there is a single +process which distributes work to the Xapian shards. + +=back + =head1 ENVIRONMENT =over 8 @@ -27,6 +48,21 @@ See L =head1 UPGRADING +Editing "~/.public-inbox/config" (or whatever C is +set to) will be required to start using the new directory. + +=head1 BUGS + +Writes from L or L to the v1 +inbox which occur after the start of the conversion will not +be picked up in the v2 inbox. + +Users of L do not have to worry about +this. They only need to update the config file to point to the +v2 inbox, send C public-inbox-watch process to reload +the config file, and then C to rescan existing +Maildirs. + =head1 CONTACT Feedback welcome via plain-text mail to L @@ -42,4 +78,5 @@ License: AGPL-3.0+ L =head1 SEE ALSO -L, L +L, L, L, +L, L