update copyrights for 2021

[public-inbox.git] / Documentation / public-inbox-init.pod

diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod
index ea2b38dd27dbf60ccbe52ce4c0dde29435cf80ae..771775d31a6f09ff48bb1ca2fd75ca01ec8a6269 100644 (file)
--- a/Documentation/public-inbox-init.pod
+++ b/Documentation/public-inbox-init.pod
@@ -50,11 +50,11 @@ This may be set after-the-fact via C<publicinbox.$NAME.newsgroup>
 in the configuration file.  See L<public-inbox-config(5)> for more
 info.
 
 in the configuration file.  See L<public-inbox-config(5)> for more
 info.
 

-Available since public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.

 
 Default: none.
 
 
 Default: none.
 

-=item -N, --skip-artnum
+=item --skip-artnum

 
 This option allows archivists to publish incomplete archives
 with only new mail while allowing NNTP article numbers
 
 This option allows archivists to publish incomplete archives
 with only new mail while allowing NNTP article numbers


@@ -66,7 +66,7 @@ but may be of use to L<public-inbox-v1-format(5)> users.
 There is no automatic way to use reserved NNTP article numbers
 when old mail is found, yet.
 
 There is no automatic way to use reserved NNTP article numbers
 when old mail is found, yet.
 

-Available since public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.

 
 Default: unset, no NNTP article numbers are skipped
 
 
 Default: unset, no NNTP article numbers are skipped
 


@@ -86,14 +86,31 @@ Default: unset, no epochs are skipped
 Control the number of Xapian index shards in a
 C<-V2> (L<public-inbox-v2-format(5)>) inbox.
 
 Control the number of Xapian index shards in a
 C<-V2> (L<public-inbox-v2-format(5)>) inbox.
 

-It is useful to use a single shard (C<-j1>) for inboxes on
+It can be useful to use a single shard (C<-j1>) for inboxes on

 high-latency storage (e.g. rotational HDD) unless the system has
 enough RAM to cache 5-10x the size of the git repository.
 
 high-latency storage (e.g. rotational HDD) unless the system has
 enough RAM to cache 5-10x the size of the git repository.
 

-It is generally not useful to specify higher values than the
-default due to contention in the top-level producer process.
+Another approach for HDDs is to use the
+L<public-inbox-index(1)/publicInbox.indexSequentialShard> option
+and many shards, so each shard may fit into the kernel page
+cache.  Unfortunately, excessive shards slows down read-only
+query performance.

 
 

-Default: the number of online CPUs, up to 4
+For fast storage, it is generally not useful to specify higher
+values than the default due to the top-level producer process
+being a bottleneck.
+
+Default: the number of online CPUs, up to 4 (3 shard workers, 1 producer)
+
+=item --skip-docdata
+
+Do not store document data in Xapian, reducing Xapian storage
+overhead by around 1.5%.
+
+Warning: this option prevents rollbacks to public-inbox 1.5.0
+and earlier.
+
+Available in public-inbox 1.6.0+.

 
 =back
 
 
 =back
 


@@ -125,7 +142,7 @@ and L<http://hjrcffqmbrq6wope.onion/meta/>
 
 =head1 COPYRIGHT
 
 
 =head1 COPYRIGHT
 

-Copyright 2019-2020 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2019-2021 all contributors L<mailto:meta@public-inbox.org>

 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>