doc: post-1.6 updates, start 1.7

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

diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod
index b25dd1e4d02e373b83e64ac5edd29cacf81969be..f1ec05de0a5e2bbad426153715cf7f64f37dbdb8 100644 (file)
--- a/Documentation/public-inbox-init.pod
+++ b/Documentation/public-inbox-init.pod
@@ -50,7 +50,7 @@ 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.
 


@@ -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,21 @@ 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
 
 
 =item --skip-docdata
 


@@ -103,7 +110,7 @@ overhead by around 1.5%.
 Warning: this option prevents rollbacks to public-inbox 1.5.0
 and earlier.
 
 Warning: this option prevents rollbacks to public-inbox 1.5.0
 and earlier.
 

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

 
 =back
 
 
 =back