From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <e@80x24.org>
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on dcvr.yhbt.net
X-Spam-Level: 
X-Spam-ASN:  
X-Spam-Status: No, score=-4.1 required=3.0 tests=ALL_TRUSTED,AWL,BAYES_00,
	DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF shortcircuit=no
	autolearn=ham autolearn_force=no version=3.4.6
Received: from localhost (dcvr.yhbt.net [127.0.0.1])
	by dcvr.yhbt.net (Postfix) with ESMTP id 476461F55F;
	Sat,  2 Sep 2023 18:50:15 +0000 (UTC)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=80x24.org;
	s=selector1; t=1693680615;
	bh=+l1A6FsbOaKFo9heVdeXmmBM5GRZ/InQNwY9RtZ6HkA=;
	h=Date:From:To:Cc:Subject:References:In-Reply-To:From;
	b=max+NOyLQ8kxTLtd6WcDacobmwvMEBZizPjauH1GLMF4gmlJRZ/1ZrM9FKB+BWFA5
	 EJFK3jjSOAkoYQOKe7btZnqL+vhX62Y5wjDI90JhPTFfo6HsnmA89/A/xvAisGiFii
	 /7QMtpSZEELrrUZ2ShHurI0eqy6byCidSydwlnrU=
Date: Sat, 2 Sep 2023 18:50:15 +0000
From: Eric Wong <e@80x24.org>
To: =?utf-8?B?xaB0xJtww6FuIE7Em21lYw==?= <stepnem@smrk.net>
Cc: meta@public-inbox.org
Subject: Re: [PATCH v2] Clarify Inline::C dependency (optional on Linux,
 required elsewhere)
Message-ID: <20230902185015.M198704@dcvr>
References: <20230830051045.330641-1-e@80x24.org>
 <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>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <20230902130741+0200.224663-stepnem@smrk.net>
List-Id: <meta.public-inbox.org>

Štěpán Němec <stepnem@smrk.net> wrote:
> +++ 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.

Thanks, this hunk I agree with.

>  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..8f08a11f7ee1 100644
> --- a/INSTALL
> +++ b/INSTALL
> @@ -60,7 +60,7 @@ Where "deb" indicates package names for Debian-derived distributions,
>  "pkg" is for the FreeBSD package (maybe other common BSDs, too), and
>  "rpm" is for RPM-based distributions (only known to work on Fedora).
>  
> -Numerous optional modules are likely to be useful as well:
> +Numerous other modules are likely to be useful as well:

What is the reasoning for this change?
"optional" is an important point to state, IMHO.
Using "other" is more ambiguous, I think.

> @@ -76,8 +76,9 @@ 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,
> -                                    see public-inbox-daemon(8))
> +                                   (required for lei on *BSD; speeds up process
> +                                    spawning on Linux, see
> +                                    public-inbox-daemon(8))

I think breaking up the lines on punctuation improves readability:

                                   (required for lei on *BSD;
                                    speeds up process spawning on Linux,
                                    see public-inbox-daemon(8))

I particularly dislike having "process" and "spawning"
being on separate lines.

Thanks.