From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS20473 45.76.80.0/20 X-Spam-Status: No, score=-3.4 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_HI,SPF_HELO_NONE, SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.6 Received: from mail.smrk.net (mail.smrk.net [45.76.87.244]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA512) (No client certificate requested) by dcvr.yhbt.net (Postfix) with ESMTPS id 3CF221F55F for ; Sat, 2 Sep 2023 20:45:04 +0000 (UTC) Authentication-Results: dcvr.yhbt.net; dkim=pass (2048-bit key; unprotected) header.d=smrk.net header.i=@smrk.net header.a=rsa-sha256 header.s=20221002 header.b=LQhxL4Rd; dkim-atps=neutral DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=smrk.net; s=20221002; t=1693687501; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=YAgKEfth1EPJzbI4l8axxk/pK8/BWGbUJ5TsMmInUDQ=; b=LQhxL4Rd2liNKa46rHDqq37gLsFxrzCvN6y68aTzHrJV1HNMdVN/SBux8iiRkuXQeVNQlw TjMYITfO/6Ub1NNgi3EsW6EEX4G78bOLBtSya6SYcezrd5FW8TAXDuIxP3lAXpqBKUPtGv JnBVO1Ho8jMKdvOy3cl0+YkZNmZi3xpGFb/bsnsIW03TJAhatK+aoAmp0KoSvnWpckp8RN lWypwcxGiwgM0ut/vhOhc5SBp3SXFWlmKF01Naj2NXXN8d0xXKCBI4cXwd6tst41zTOnzU y5JknyXKqhXQSZS3q/qFxAF5rBiePfn1n9hHjOELVfTIIYEF9TrxQuKjaIUoMA== Received: from localhost ( [192.168.5.2]) by smrk (OpenSMTPD) with ESMTPSA id e9fd0297 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Sat, 2 Sep 2023 22:45:01 +0200 (CEST) From: =?utf-8?B?xaB0xJtww6FuIE7Em21lYw==?= To: Eric Wong Cc: meta@public-inbox.org Subject: Re: [PATCH v2] Clarify Inline::C dependency (optional on Linux, required elsewhere) In-Reply-To: <20230902194407.M464597@dcvr> References: <20230830051045.330641-1-e@80x24.org> <20230830143409+0200.929541-stepnem@smrk.net> <20230830211849.M275594@dcvr> <20230831111152+0200.360729-stepnem@smrk.net> <20230831192650+0200.929387-stepnem@smrk.net> <20230901110903.M876537@dcvr> <20230902125449+0200.22309-stepnem@smrk.net> <20230902130741+0200.224663-stepnem@smrk.net> <20230902185015.M198704@dcvr> <20230902210825+0200.747967-stepnem@smrk.net> <20230902194407.M464597@dcvr> User-Agent: Notmuch/0.37 (https://notmuchmail.org) Emacs/30.0.50 (x86_64-pc-linux-gnu) Date: Sat, 02 Sep 2023 22:45:01 +0200 Message-ID: <20230902224501+0200.863993-stepnem@smrk.net> MIME-Version: 1.0 Content-Type: text/plain List-Id: 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 is required, lei runs as a background daemon to reduce -startup costs and can provide real-time L/L -Maildir monitoring. L (p5-IO-KQueue on FreeBSD) and -L (liblinux-inotify2-perl and perl-Linux-Inotify2 in -.deb and .rpm-based distros, respectively) are recommended. +L 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/L Maildir monitoring. +L (p5-IO-KQueue on FreeBSD) and L +(liblinux-inotify2-perl and perl-Linux-Inotify2 in .deb and .rpm-based +distros, respectively) are recommended. L 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