about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2016-09-08 20:15:25 +0000
committerEric Wong <e@80x24.org>2016-09-08 20:19:14 +0000
commitaac5361cf9f2d71bc1429e909f8664b0abbe31ae (patch)
treecd264af45b805df4f18c69dc91c7ae235d3ae0f0 /Documentation
parent75d9216d604a2e31201f1833e655a6f71296d05c (diff)
For now, we will document this since it allows better
performance without the burden of extensions.  Perhaps one day
far in the future Perl can natively support vfork(2) AND that
version of Perl will be widely available, but I suspect that day
is at least a decade away, if not two:

Diffstat (limited to 'Documentation')
2 files changed, 18 insertions, 0 deletions
diff --git a/Documentation/public-inbox-daemon.pod b/Documentation/public-inbox-daemon.pod
index 42beda69..72794a51 100644
--- a/Documentation/public-inbox-daemon.pod
+++ b/Documentation/public-inbox-daemon.pod
@@ -133,6 +133,18 @@ See L<public-inbox-config(5)>
 Used by systemd (and compatible) installations for socket
 activation.  See L<systemd.socket(5)> and L<sd_listen_fds(3)>.
+Pointing this to point to a writable directory enables the use
+of L<Inline> and L<Inline::C> extensions which may provide
+platform-specific performance improvements.  Currently, this
+enables the use of L<vfork(2)> which speeds up subprocess
+spawning with the Linux kernel.
+public-inbox will never enable L<Inline::C> automatically without
+this environment variable set.  See L<Inline> and L<Inline::C>
+for more details.
diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod
index 404303e8..a59ba32b 100644
--- a/Documentation/public-inbox-watch.pod
+++ b/Documentation/public-inbox-watch.pod
@@ -101,6 +101,12 @@ startup.
 config file. default: ~/.public-inbox/config
 See L<public-inbox-config(5)>
+This may affect any public-inbox processes, but is intended
+for long-lived ones such as C<public-inbox-watch> or network
+daemons.  See L<public-inbox-daemon(8)>.
 =head1 CONTACT