user/dev discussion of public-inbox itself
 help / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH] doc: document PERL_INLINE_DIRECTORY usage
Date: Thu,  8 Sep 2016 20:23:13 +0000
Message-ID: <20160908202313.9759-1-e@80x24.org> (raw)

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(+)

diff --git a/Documentation/public-inbox-daemon.pod b/Documentation/public-inbox-daemon.pod
index 42beda6..72794a5 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
diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod
index 404303e..a59ba32 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)>
 
+=item PERL_INLINE_DIRECTORY
+
+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)>.
+
 =back
 
 =head1 CONTACT
-- 
EW


                 reply index

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20160908202313.9759-1-e@80x24.org \
    --to=e@80x24.org \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

user/dev discussion of public-inbox itself

Archives are clonable:
	git clone --mirror https://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.org/gmane.mail.public-inbox.general

 note: .onion URLs require Tor: https://www.torproject.org/
       or Tor2web: https://www.tor2web.org/

AGPL code for this site: git clone https://public-inbox.org/ public-inbox