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.2 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS, T_SCC_BODY_TEXT_LINE 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 2863C1F44D for ; Sat, 16 Mar 2024 22:37:22 +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=n/oirq4F; dkim-atps=neutral DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=smrk.net; s=20221002; t=1710628640; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=3LVg/wclijlVjRRfAFLT+EEeXSVmIirHTXX43bVRd2o=; b=n/oirq4FWS4ZPPE0CNB94VmeN9/dPewjPS/ZeFFPbQlxrF/01jiJ/rSIE5ePFl7ofb+6H5 AX/NaDxxfbdraLmLfYXslP9b+QilAPFw6mJVsjbh8C+zMziqFKdgtWNTeP+QcpCMIDiIlq /ApEr+aSXb26ZyxeXiLCu0NYv9eDjlMYKn23qZNecriQMd4D3zaHk3kPb7SwqwGCeznlf3 Yh8J1XSBCtZmjxmg+bn0jHml7RYI7vAPmMVdYZZfyW0+7h26CpP2da/QBmGb7f4q/FYLxo hL6nv9GtYqPXEgB+/JAqiXBKm40Q1NqWxo3eiXAPJu94bDyPPvOkqWI+QeK1BQ== Received: from localhost ( [192.168.5.2]) by smrk (OpenSMTPD) with ESMTPSA id 64292c78 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Sat, 16 Mar 2024 23:37:20 +0100 (CET) From: =?utf-8?B?xaB0xJtww6FuIE7Em21lYw==?= To: Eric Wong Cc: meta@public-inbox.org Subject: Re: [PATCH (RFC) 2/2] INSTALL: try to be less confusing about optional modules In-Reply-To: <20240316212756.M816616@dcvr> References: <20240315143049.1590728-1-stepnem@smrk.net> <20240315143049.1590728-2-stepnem@smrk.net> <20240316212756.M816616@dcvr> User-Agent: Notmuch/0.38.2 (https://notmuchmail.org) Emacs/30.0.50 (x86_64-pc-linux-gnu) Date: Sat, 16 Mar 2024 23:37:18 +0100 Message-ID: <20240316233718+0100.795197-stepnem@smrk.net> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable List-Id: On Sat, 16 Mar 2024 21:27:56 +0000 Eric Wong wrote: > =C5=A0t=C4=9Bp=C3=A1n N=C4=9Bmec wrote: >> The difference between the "numerous optional modules" >> section (containing only two modules) and the "everything >> else optional" section was unclear (to me, at least). >> Just put both under a single heading. > > > >> +++ b/INSTALL >> @@ -58,7 +58,8 @@ Where "deb" indicates package names for Debian-derived= distributions, >> "pkgin" for NetBSD, "apk" for Alpine Linux and "rpm" is for RPM-based >> distributions (only known to work on Fedora). >>=20=20 >> -Numerous optional modules are likely to be useful as well: >> +Numerous optional modules might be useful as well, depending >> +on your use case and preferences: >>=20=20 > > OK, I like the first change. > >> - DBD::SQLite deb: libdbd-sqlite3-perl >> pkg: p5-DBD-SQLite >> @@ -71,8 +72,6 @@ Numerous optional modules are likely to be useful as w= ell: >> rpm: perl-Search-Xapian >> (required for lei; HTTP and IMAP sea= rch) >>=20=20 >> -Every effort has been to make everything else optional: >> - > > I consider DBD::SQLite and Xapian significantly more important > than the rest, so I favor keeping the above line. The main issue I see with that (as mentioned in my commit message) is that you first say numerous optional modules are useful, list only two modules after that, then say everything else is optional. "else"? So, all modules are optional, but some are more optional than others? :-P I'd say a single heading and keeping further details to the parentheticals pertaining to specific modules is both clearer and easier to maintain, but whatever version you choose, I as reader see the following issues with the old text (and at least some of those issues would remain if you kept my first hunk and not the second, as you suggest): - the difference between the two sections is unclear - it doesn't make sense to first single out two modules as optional, and then continue with "make everything else optional" - two are not "numerous" - "Every effort has been to make everything else optional" sounds weird to me. Is "made" missing after "been"? Or maybe "We've tried to make everything else optional" or "Everything else is supposed to be optional"? - Perhaps "optional" isn't really the right word for the general description to begin with, given that some modules are required in some cases (indicated by parentheticals)? A different attempt based on your feedback: -- >8 -- Subject: [PATCH] INSTALL: try to be less confusing about optional modules --- INSTALL | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/INSTALL b/INSTALL index c04831c2fb5b..3c5890b43517 100644 --- a/INSTALL +++ b/INSTALL @@ -58,7 +58,7 @@ Where "deb" indicates package names for Debian-derived di= stributions, "pkgin" for NetBSD, "apk" for Alpine Linux and "rpm" is for RPM-based distributions (only known to work on Fedora). =20 -Numerous optional modules are likely to be useful as well: +Most users will likely also want the following: =20 - DBD::SQLite deb: libdbd-sqlite3-perl pkg: p5-DBD-SQLite @@ -71,7 +71,8 @@ Numerous optional modules are likely to be useful as well: rpm: perl-Search-Xapian (required for lei; HTTP and IMAP search) =20 -Every effort has been to make everything else optional: +Other modules might be useful as well, depending on your use case and +preferences: =20 - Plack deb: libplack-perl pkg: p5-Plack base-commit: 5e8068b28aa01befa9c6fa7368db956148816189 prerequisite-patch-id: fc68213abff90eb709806fcae4dad389f2e59959 --=20 2.44.0 Thanks, =C5=A0t=C4=9Bp=C3=A1n