about summary refs log tree commit homepage
path: root/Documentation/public-inbox-daemon.pod
diff options
context:
space:
mode:
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/public-inbox-daemon.pod
parent75d9216d604a2e31201f1833e655a6f71296d05c (diff)
downloadpublic-inbox-aac5361cf9f2d71bc1429e909f8664b0abbe31ae.tar.gz
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:

	https://rt.perl.org/Ticket/Display.html?id=128227
Diffstat (limited to 'Documentation/public-inbox-daemon.pod')
-rw-r--r--Documentation/public-inbox-daemon.pod12
1 files changed, 12 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)>.
 
+=item PERL_INLINE_DIRECTORY
+
+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.
+
 =back
 
 =head1 UPGRADING