Re: [PATCH v2] Clarify Inline::C dependency (optional on Linux, required elsewhere)

[Eric Wong <e@80x24.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.