From d87053bf6cae0258125e84e1531d5f1206c53288 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 22 Feb 2020 08:27:29 +0000 Subject: doc: improve wording of "inbox" vs "repository" Since v2 inboxes contain multiple git repositories, avoid the use of the word "repository" when referring to inboxes as a whole in most places. --- Documentation/public-inbox-convert.pod | 6 +++--- Documentation/public-inbox-daemon.pod | 3 +-- Documentation/public-inbox-index.pod | 6 +++--- Documentation/public-inbox-overview.pod | 5 ++--- Documentation/public-inbox-v2-format.pod | 4 ++-- Documentation/public-inbox-watch.pod | 2 +- 6 files changed, 12 insertions(+), 14 deletions(-) (limited to 'Documentation') diff --git a/Documentation/public-inbox-convert.pod b/Documentation/public-inbox-convert.pod index fc5c4762..a8a5658c 100644 --- a/Documentation/public-inbox-convert.pod +++ b/Documentation/public-inbox-convert.pod @@ -20,9 +20,9 @@ once they are satisfied with the conversion. =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 +Disables Xapian and overview DB indexing on the new inbox. +By default, public-inbox-convert creates a new index in the +v2 inbox and indexes all existing messages, a lengthy operation for large inboxes. =item -j JOBS, --jobs=JOBS diff --git a/Documentation/public-inbox-daemon.pod b/Documentation/public-inbox-daemon.pod index cb903df2..6091e8e6 100644 --- a/Documentation/public-inbox-daemon.pod +++ b/Documentation/public-inbox-daemon.pod @@ -12,8 +12,7 @@ public-inbox-daemon - common usage for public-inbox network daemons This manual describes common options and behavior for public-inbox network daemons. Network daemons for public-inbox provide read-only NNTP and HTTP access to public-inboxes. Write -access to a public-inbox repository will never be required to -run these. +access to a public-inbox will never be required to run these. These daemons are implemented with a common core using non-blocking sockets and optimized for fairness; even with diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod index 7c04f753..14113ec8 100644 --- a/Documentation/public-inbox-index.pod +++ b/Documentation/public-inbox-index.pod @@ -34,8 +34,8 @@ normal search functionality. =item --reindex -Forces a search engine re-index of all messages in the -repository. This can be used for in-place upgrades while +Forces a re-index of all messages in the inbox. +This can be used for in-place upgrades and bugfixes while NNTP/HTTP server processes are utilizing the index. Keep in mind this roughly doubles the size of the already-large Xapian database. Running L @@ -58,7 +58,7 @@ For v1 (ssoma) repositories described in L. All public-inbox-specific files are contained within the C<$GIT_DIR/public-inbox/> directory. -v2 repositories are described in L. +v2 inboxes are described in L. =head1 ENVIRONMENT diff --git a/Documentation/public-inbox-overview.pod b/Documentation/public-inbox-overview.pod index 583aea87..44989e6e 100644 --- a/Documentation/public-inbox-overview.pod +++ b/Documentation/public-inbox-overview.pod @@ -70,7 +70,7 @@ your mirror to other readers. Mirroring mailing lists may be done by any reader of a mailing list using L. - # This will create a new git repository: + # This will create a new v2 inbox: public-inbox-init -V2 NAME INBOX_DIR MY_URL LIST_ADDRESS Then, see the L manual for configuring @@ -109,8 +109,7 @@ See L and L for more information on using these daemons. Hosting a public-inbox over HTTP or NNTP will never require -write access to any files in the git repository, including -the search indices or article number map database. +write access to any files in the inbox directory. Users familiar with PSGI and L may also use L with the preferred server instead of diff --git a/Documentation/public-inbox-v2-format.pod b/Documentation/public-inbox-v2-format.pod index 730f6633..d87a717d 100644 --- a/Documentation/public-inbox-v2-format.pod +++ b/Documentation/public-inbox-v2-format.pod @@ -2,7 +2,7 @@ =head1 NAME -public-inbox v2 repository description +public-inbox v2 format description =head1 DESCRIPTION @@ -226,7 +226,7 @@ no sense in a public archive. =head1 THANKS Thanks to the Linux Foundation for sponsoring the development -and testing of the v2 repository format. +and testing of the v2 format. =head1 COPYRIGHT diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod index 87e4da49..8a3ef076 100644 --- a/Documentation/public-inbox-watch.pod +++ b/Documentation/public-inbox-watch.pod @@ -37,7 +37,7 @@ In ~/.public-inbox/config: public-inbox-watch allows watching a mailbox (currently only Maildir) for the arrival of new messages and automatically -importing them into a public-inbox (git) repository. +importing them into public-inbox git repositories and indices. public-inbox-watch is useful in situations when a user wishes to mirror an existing mailing list, but has no access to run L on a server. Unlike public-inbox-mda -- cgit v1.2.3-24-ge0c7