diff options
| author | Eric Wong <e@80x24.org> | 2019-05-23 10:37:38 +0000 |
|---|---|---|
| committer | Eric Wong <e@80x24.org> | 2019-05-23 17:43:51 +0000 |
| commit | 666f1b8f5c7c76333df4e1296c1668abf04f210f (patch) | |
| tree | 127e4befde4493285217e269d0b037e3829b5212 /Documentation/public-inbox-compact.pod | |
| parent | bb279f4f305649c99dabdbcc0f45fc42c9be8e7e (diff) | |
| download | public-inbox-666f1b8f5c7c76333df4e1296c1668abf04f210f.tar.gz | |
-index documentation avoid redundant v1 information and refers readers to apropriate v1/v2 manpages. Search::Xapian can also be optional, now, as only the PSGI search interface uses it. Favor "INBOX_DIR" where appropriate, since "REPO_DIR" can be confused for code repos which we also support. XAPIAN_FLUSH_THRESHOLD is documented for all relevant bulk commands.
Diffstat (limited to 'Documentation/public-inbox-compact.pod')
| -rw-r--r-- | Documentation/public-inbox-compact.pod | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod index 4a519ce9..7d37f6fb 100644 --- a/Documentation/public-inbox-compact.pod +++ b/Documentation/public-inbox-compact.pod @@ -9,15 +9,12 @@ public-inbox-compact - compact Xapian DBs =head1 DESCRIPTION public-inbox-compact is a wrapper for L<xapian-compact(1)> -designed for "v2" inboxes. It combines multiple Xapian -partitions into one to reduce space overhead after an initial -mass import (using multiple partitions) is done. +which locks the inbox and prevents other processes such as +L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from +writing while it operates. -It locks the inbox and prevents other processes such as -L<public-inbox-watch(1)> from writing while it operates. - -It also supports "v1" (ssoma) inboxes with limited -usefulness over L<xapian-compact(1)> +It enforces the use of the C<--no-renumber> option of +L<xapian-compact(1)> =head1 ENVIRONMENT @@ -28,9 +25,15 @@ usefulness over L<xapian-compact(1)> The default config file, normally "~/.public-inbox/config". See L<public-inbox-config(5)> -=back +=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. -=head1 UPGRADING +Default: 10000 + +=back =head1 CONTACT @@ -41,7 +44,7 @@ and L<http://hjrcffqmbrq6wope.onion/meta/> =head1 COPYRIGHT -Copyright 2018 all contributors L<mailto:meta@public-inbox.org> +Copyright 2018-2019 all contributors L<mailto:meta@public-inbox.org> License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> |