From 666f1b8f5c7c76333df4e1296c1668abf04f210f Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 23 May 2019 10:37:38 +0000 Subject: doc: various updates to reflect current state -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. --- Documentation/public-inbox-compact.pod | 25 +++++----- Documentation/public-inbox-index.pod | 80 ++++++++++++-------------------- Documentation/public-inbox-v1-format.pod | 12 ++++- Documentation/public-inbox-v2-format.pod | 5 +- Documentation/public-inbox-xcpdb.pod | 5 +- 5 files changed, 59 insertions(+), 68 deletions(-) (limited to 'Documentation') 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 -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 or L from +writing while it operates. -It locks the inbox and prevents other processes such as -L from writing while it operates. - -It also supports "v1" (ssoma) inboxes with limited -usefulness over L +It enforces the use of the C<--no-renumber> option of +L =head1 ENVIRONMENT @@ -28,9 +25,15 @@ usefulness over L The default config file, normally "~/.public-inbox/config". See L -=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 =head1 COPYRIGHT -Copyright 2018 all contributors L +Copyright 2018-2019 all contributors L License: AGPL-3.0+ L diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod index acc90392..2e0ff693 100644 --- a/Documentation/public-inbox-index.pod +++ b/Documentation/public-inbox-index.pod @@ -4,14 +4,15 @@ public-inbox-index - create and update search indices =head1 SYNOPSIS -public-inbox-index [OPTIONS] REPO_DIR +public-inbox-index [OPTIONS] INBOX_DIR =head1 DESCRIPTION -public-inbox-index creates and updates the search and NNTP -article number database used by the read-only public-inbox HTTP -and NNTP interfaces. Currently, this requires L -and L and L Perl modules. +public-inbox-index creates and updates the search, overview and +NNTP article number database used by the read-only public-inbox +HTTP and NNTP interfaces. Currently, this requires +L and L Perl modules. L +is optional, only to support the PSGI search interface. Once the initial indices are created by public-inbox-index, L and L will @@ -22,10 +23,10 @@ relying on L to mirror an existing public-inbox; or if upgrading to a new version of public-inbox using the C<--reindex> option. -Having a search and article number database is essential to +Having the overview and article number database is essential to running the NNTP interface, and strongly recommended for the -HTTP interface as it provides thread grouping in addition -to normal search functionality. +HTTP interface as it provides thread grouping in addition to +normal search functionality. =head1 OPTIONS @@ -45,50 +46,11 @@ This does not touch the NNTP article number database. =head1 FILES +For v1 (ssoma) repositories described in L. All public-inbox-specific files are contained within the -C<$REPO_DIR/public-inbox/> directory. All files are expected to -grow in size as more messages are archived, so using compaction -commands (e.g. L) is not recommended unless -the list is no longer active. +C<$GIT_DIR/public-inbox/> directory. -=over - -=item $REPO_DIR/public-inbox/msgmap.sqlite3 - -The stable NNTP article number to Message-ID mapping is -stored in an SQLite3 database. - -This is required for users of L, but -users of the L interface will find it -useful for attempting recovery from copy-paste truncations of -URLs containing long Message-IDs. - -Avoid removing this file and regenerating it; it may cause -existing NNTP readers to lose sync and miss (or see duplicate) -messages. - -This file is relatively small, and typically less than 5% -of the space of the mail stored in a packed git repository. - -=item $REPO_DIR/public-inbox/xapian* - -The database used by L. This directory name is -followed by a number indicating the index schema version this -installation of public-inbox uses. - -These directories may be safely deleted or removed in full -while the NNTP and HTTP interfaces are no longer accessing -them. - -In addition to providing a search interface for the HTTP -interface, the Xapian database is used to group and combine -related messages into threads. For NNTP servers, it also -provides a cache of metadata and header information often -requested by NNTP clients. - -This directory is large, often two to three times the size of -the objects stored in a packed git repository. Using the -C<--reindex> option makes it larger, still. +v2 repositories are described in L. =back @@ -100,8 +62,24 @@ C<--reindex> option makes it larger, still. Used to override the default "~/.public-inbox/config" value. +=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: our indexing code flushes every megabyte of mail seen +to keep memory usage low. Setting this environment variable to +any positive value will switch to a document count-based +threshold in Xapian. + =back +=head1 UPGRADING + +Occasionally, public-inbox will update it's schema version and +require a full index by running this command. + =head1 CONTACT Feedback welcome via plain-text mail to L @@ -111,7 +89,7 @@ and L =head1 COPYRIGHT -Copyright 2016-2018 all contributors L +Copyright 2016-2019 all contributors L License: AGPL-3.0+ L diff --git a/Documentation/public-inbox-v1-format.pod b/Documentation/public-inbox-v1-format.pod index 3b0e70e1..c960913d 100644 --- a/Documentation/public-inbox-v1-format.pod +++ b/Documentation/public-inbox-v1-format.pod @@ -104,6 +104,10 @@ SQLite3 database maintaining a stable mapping of Message-IDs to NNTP article numbers. Used by L and created and updated by L. +Users of the L interface will find it +useful for attempting recovery from copy-paste truncations of +URLs containing long Message-IDs. + Automatically updated by L, L and L. @@ -135,8 +139,12 @@ the "overview" DB also exists in the xapian directory for v1 repositories. See L Our use of the L requires Xapian document IDs to -remain stable. Thus, use of L and -L require the use of C<--no-renumber> switch. +remain stable. Using L and +L wrappers are recommended over tools +provided by Xapian. + +This directory is large, often two to three times the size of +the objects stored in a packed git repository. =item $GIT_DIR/ssoma.index diff --git a/Documentation/public-inbox-v2-format.pod b/Documentation/public-inbox-v2-format.pod index bc58074e..65a85c19 100644 --- a/Documentation/public-inbox-v2-format.pod +++ b/Documentation/public-inbox-v2-format.pod @@ -118,8 +118,9 @@ large mail archives; but are fine for backup and usable for small instances. Our use of the L requires Xapian document IDs to -remain stable. Thus, use of L and -L require the use of C<--no-renumber> switch. +remain stable. Using L and +L wrappers are recommended over tools +provided by Xapian. =head2 OVERVIEW DB diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod index c47500b6..5697dcdd 100644 --- a/Documentation/public-inbox-xcpdb.pod +++ b/Documentation/public-inbox-xcpdb.pod @@ -1,6 +1,6 @@ =head1 NAME -public-inbox-xcpdb - copy Xapian DBs (for format upgrades) +public-inbox-xcpdb - upgrade Xapian DB formats =head1 SYNOPSIS @@ -16,7 +16,8 @@ L or L. This is intended for upgrading the database format used by Xapian. It DOES NOT upgrade the schema used by the -public-inbox search interface (see L). +public-inbox PSGI search interface (see +L). =head1 ENVIRONMENT -- cgit v1.2.3-24-ge0c7