X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-init.pod;h=5a875f9d20d7f924a4012e66fed56f0006add851;hb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;hp=ea2b38dd27dbf60ccbe52ce4c0dde29435cf80ae;hpb=6f5b7803c82c45105272802b818df684b87bd2ec;p=public-inbox.git diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod index ea2b38dd..5a875f9d 100644 --- 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 in the configuration file. See L for more info. -Available since public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. 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 @@ -66,7 +66,7 @@ but may be of use to L users. 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 @@ -86,14 +86,31 @@ Default: unset, no epochs are skipped Control the number of Xapian index shards in a C<-V2> (L) 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. -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 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 @@ -120,12 +137,12 @@ to a given inbox. Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT -Copyright 2019-2020 all contributors L +Copyright 2019-2021 all contributors L License: AGPL-3.0+ L