On Sat, 02 Sep 2023 19:44:07 +0000 Eric Wong wrote: > Perhaps the per-module "optional, for .." statements should be > "only for ...".
Well, if that's really true (i.e., they're not needed/useful for anything else)... I guess you see INSTALL as mainly for public-inbox without lei (and indeed the first sentence is "This is for folks who want to set up their own public-inbox instance."), so from that perspective saying "optional" about something that is optional for public-inbox but required for lei makes sense, but lei is then mentioned repeatedly in the dependencies section, and it seems a safe bet there are much more people using lei than there are people setting up public-inbox instances, so I'm not sure maintaining that perspective in INSTALL is the best way to help those users. Then again, maybe it's just in my head and I might as well let such users speak for themselves if they exist and ever wish to do so. So here's just a reroll with your suggestions implemented: -- 8< -- Subject: [PATCH v3] Clarify Inline::C dependency (optional on Linux, required elsewhere) Link: https://public-inbox.org/meta/20230901110903.M876537@dcvr/ Link: https://public-inbox.org/meta/20230902194407.M464597@dcvr/ Fixes: 88c7c7c26b44 ("lei: wire up pure Perl sendmsg/recvmsg for Linux users") Fixes: acefd91b302d ("syscall: implement sendmsg+recvmsg in pure Perl") --- changes since v2: - add another Link: to the parent of this message - don't change "optional" to "other", focus is on public-inbox - don't repeat "optional" in individual module items, say "only for" Documentation/lei-overview.pod | 12 +++++++----- INSTALL | 11 ++++++----- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 7095b504cdb8..e9a97d64fb56 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -119,11 +119,13 @@ code repository. =head1 PERFORMANCE NOTES -L<Inline::C> is required, lei runs as a background daemon to reduce -startup costs and can provide real-time L<kqueue(2)>/L<inotify(7)> -Maildir monitoring. L<IO::KQueue> (p5-IO-KQueue on FreeBSD) and -L<Linux::Inotify2> (liblinux-inotify2-perl and perl-Linux-Inotify2 in -.deb and .rpm-based distros, respectively) are recommended. +L<Inline::C> is required on BSDs and can speed things up on Linux. + +lei runs as a background daemon to reduce startup costs and can +provide real-time L<kqueue(2)>/L<inotify(7)> Maildir monitoring. +L<IO::KQueue> (p5-IO-KQueue on FreeBSD) and L<Linux::Inotify2> +(liblinux-inotify2-perl and perl-Linux-Inotify2 in .deb and .rpm-based +distros, respectively) are recommended. L<Socket::MsgHdr> is optional (libsocket-msghdr-perl in Debian), and further improves startup performance. Its effect is most felt diff --git a/INSTALL b/INSTALL index 5f080f2889ce..2e1c7ef7bb0a 100644 --- a/INSTALL +++ b/INSTALL @@ -76,7 +76,8 @@ Numerous optional modules are likely to be useful as well: - Inline::C deb: libinline-c-perl pkg: p5-Inline-C rpm: perl-Inline (or perl-Inline-C) - (speeds up process spawning on Linux, + (required for lei on *BSD; + speeds up process spawning on Linux, see public-inbox-daemon(8)) - Email::Address::XS deb: libemail-address-xs-perl @@ -88,17 +89,17 @@ Numerous optional modules are likely to be useful as well: - Parse::RecDescent deb: libparse-recdescent-perl pkg: p5-Parse-RecDescent rpm: perl-ParseRecDescent - (optional, for public-inbox-imapd(1)) + (only for public-inbox-imapd(1)) - Mail::IMAPClient deb: libmail-imapclient-perl pkg: p5-Mail-IMAPClient rpm: perl-Mail-IMAPClient - (optional for lei and public-inbox-watch) + (only for lei and public-inbox-watch) - BSD::Resource deb: libbsd-resource-perl pkg: p5-BSD-Resource rpm: perl-BSD-Resource - (optional, for PSGI limiters + (only for PSGI limiters, see public-inbox-config(5)) - Plack::Middleware::ReverseProxy deb: libplack-middleware-reverseproxy-perl @@ -113,7 +114,7 @@ Numerous optional modules are likely to be useful as well: * xapian-compact (tool) deb: xapian-tools pkg: xapian-core rpm: xapian-core - (optional, for public-inbox-compact(1)) + (only for public-inbox-compact(1)) * curl (tool) deb, pkg, rpm: curl (for HTTP(S) externals with curl) -- 2.42.0
