X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-tuning.pod;h=53668eccb7cb85a7a7c0f6149c0c8c54189614e2;hb=0ae89efce11e1e3b10a067c61c5b4cde30fa2b3b;hp=67316fb11109b4071197a2db9788dc254eb9a1d0;hpb=792925ca3694111de6d275fd0d0af5c8ed0b8ece;p=public-inbox.git diff --git a/Documentation/public-inbox-tuning.pod b/Documentation/public-inbox-tuning.pod index 67316fb1..53668ecc 100644 --- a/Documentation/public-inbox-tuning.pod +++ b/Documentation/public-inbox-tuning.pod @@ -16,7 +16,7 @@ New inboxes: public-inbox-init -V2 =item 2 -Process spawning +Optional Inline::C use =item 3 @@ -38,6 +38,10 @@ Read-only daemons Other OS tuning knobs +=item 8 + +Scalability to many inboxes + =back =head2 New inboxes: public-inbox-init -V2 @@ -46,7 +50,7 @@ If you're starting a new inbox (and not mirroring an existing one), the L<-V2|public-inbox-v2-format(5)> requires L, but is orders of magnitude more scalable than the original C<-V1> format. -=head2 Process spawning +=head2 Optional Inline::C use Our optional use of L speeds up subprocess spawning from large daemon processes. @@ -56,17 +60,16 @@ environment variable to point to a writable directory, or create C<~/.cache/public-inbox/inline-c> for any user(s) running public-inbox processes. -More (optional) L use will be introduced in the future -to lower memory use and improve scalability. - -=head2 libgit2 usage via Inline::C - If libgit2 development files are installed and L is enabled (described above), per-inbox C processes are replaced with a single L process running -C in read-only daemons. +C in read-only daemons. libgit2 use +will be available in public-inbox 1.7.0+ -Available as of public-inbox 1.7.0. +More (optional) L use will be introduced in the future +to lower memory use and improve scalability. + +Note: L is required for L, but not public-inbox-* =head2 Performance on rotational hard disk drives @@ -160,6 +163,17 @@ out-of-memory errors from git. Other OSes may have similar tuning knobs (patches appreciated). +=head2 Scalability to many inboxes + +L allows any number of public-inboxes +to share the same Xapian indices. + +git 2.33+ startup time is orders-of-magnitude faster and uses +less memory when dealing with thousands of alternates required +for thousands of inboxes with L. + +Frequent packing (via L) both improves performance +and reduces the need to increase C. =head1 CONTACT @@ -173,6 +187,6 @@ L, =head1 COPYRIGHT -Copyright 2020-2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L