From: Eric Wong <e@80x24.org>
Date: Thu, 24 Jun 2021 08:32:05 +0000 (+0000)
Subject: doc: tuning: add a note about Linux sys.vm.max_map_count
X-Git-Tag: v1.7.0~570
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;ds=sidebyside;h=792925ca3694111de6d275fd0d0af5c8ed0b8ece;p=public-inbox.git

doc: tuning: add a note about Linux sys.vm.max_map_count

git tends to die when mmap(2) fails on this limit, so let
users know about it.  Perhaps git could gracefully fallback.
---

diff --git a/Documentation/public-inbox-tuning.pod b/Documentation/public-inbox-tuning.pod
index 58937f73..67316fb1 100644
--- a/Documentation/public-inbox-tuning.pod
+++ b/Documentation/public-inbox-tuning.pod
@@ -34,6 +34,10 @@ Performance on solid state drives
 
 Read-only daemons
 
+=item 7
+
+Other OS tuning knobs
+
 =back
 
 =head2 New inboxes: public-inbox-init -V2
@@ -148,6 +152,15 @@ Transport Layer Security (IMAPS, NNTPS, or via STARTTLS) significantly
 increases memory use of client sockets, sure to account for that in
 capacity planning.
 
+=head2 Other OS tuning knobs
+
+Linux users: the C<sys.vm.max_map_count> sysctl may need to be increased if
+handling thousands of inboxes (with L<public-inbox-extindex(1)>) to avoid
+out-of-memory errors from git.
+
+Other OSes may have similar tuning knobs (patches appreciated).
+
+
 =head1 CONTACT
 
 Feedback encouraged via plain-text mail to L<mailto:meta@public-inbox.org>