From aac5361cf9f2d71bc1429e909f8664b0abbe31ae Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 8 Sep 2016 20:15:25 +0000 Subject: doc: document PERL_INLINE_DIRECTORY usage 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 --- Documentation/public-inbox-daemon.pod | 12 ++++++++++++ Documentation/public-inbox-watch.pod | 6 ++++++ 2 files changed, 18 insertions(+) (limited to 'Documentation') 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 Used by systemd (and compatible) installations for socket activation. See L and L. +=item PERL_INLINE_DIRECTORY + +Pointing this to point to a writable directory enables the use +of L and L extensions which may provide +platform-specific performance improvements. Currently, this +enables the use of L which speeds up subprocess +spawning with the Linux kernel. + +public-inbox will never enable L automatically without +this environment variable set. See L and L +for more details. + =back =head1 UPGRADING 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 +=item PERL_INLINE_DIRECTORY + +This may affect any public-inbox processes, but is intended +for long-lived ones such as C or network +daemons. See L. + =back =head1 CONTACT -- cgit v1.2.3-24-ge0c7