Message-ID: <YTjPHZEpjzn7Ufg/@b-tk.org>
Date:   Wed, 8 Sep 2021 14:56:29 +0000
From:   "Thaddeus H. Black" <thb@...ian.org>
To:     "Alejandro Colomar (man-pages)" <alx.manpages@...il.com>
Cc:     linux-man@...r.kernel.org,
        Michael Kerrisk <mtk.manpages@...il.com>,
        "Dr. Tobias Quathamer" <toddy@...ian.org>,
        linux-ext4@...r.kernel.org, debian-doc@...ts.debian.org,
        "G. Branden Robinson" <g.branden.robinson@...il.com>
Subject: Re: [PATCH] filename.7: new manual page

[To limit spam, I'll probably copy future emails only to Alejandro,
Branden, Michael and the linux-man list.]

Alejandro:

I am collecting and applying your and Branden's edits.  Meanwhile,
three questions and some comments occur.

On Mon, Sep 06, 2021 at 04:21:09PM +0200, Alejandro Colomar (man-pages) wrote:
> See man-pages(7):
> 
>    Sections within a manual page
> 
>               [...]              
>               DESCRIPTION
>               [...]              

When in doubt, consistency is best.  Good point.

> You could move sections into subsections of DESCRIPTION, and the current
> subsections into tagged paragraphs (.TP).

Question 1:  do you happen to know of a good example of an existing
manual page that already does this?  If you did, then I could follow the
example.  Otherwise, it might be tricky, for the existing subsections
already have tagged paragraphs and other structure within them.
Perhaps .RS/.RE could be used.  I am not sure.

I notice that bash(1) does not follow your advice but dash(1) does.
However, dash(1) has no subsubsections.  In any event, a manual
page *about* conventions, like filename(7), should *obey*
conventions.  I just need to figure out how to obey with good style
in this instance.

On the other hand, there is an alternative, though I do not say whether
it is a better alternative.  The alternative would be to avoid
subsubsections by using colons ':' in subsection titles, instead,
approximately as follows.

    NAME
    DESCRIPTION
        Legal filenames
        Legal filenames:  reserved characters
        Legal filenames:  reserved names
        Legal filenames:  long names
        Legal filenames:  non-UTF-8 names
        Conventional filenames
        Conventional filenames:  the POSIX Portable Filename Character Set
        Conventional filenames:  special semantics
        Conventional filenames:  the full stop to introduce a format extension
        Soft conventions
        Soft convention:  low line versus hyphen-minus
        Soft convention:  letter case
        Locales and Unicode
        Unconventional filenames
    CONFORMING TO
    SEE ALSO

Question 2:  within the constraints of established manual-page
conventions, which alternative would you and Branden advise?

> > +The format-extension convention is all but universally recognized.
> 
> Non-native English speakers may have trouble understanding "all but". Maybe
> s/all but/not/?

When a reviewer like you informs me that (for whatever reason) he or she
did not understand a sentence the first time he or she read it, this is
valuable feedback; for if the reviewer did not understand it the first
time, then other readers probably also will not understand it the first
time.  The sentence ought to be rewritten to make reading the sentence
twice unnecessary.

In the sentence in question, I did not mean "not" but rather "almost."

Question 3:  in your opinion, would s/all but/almost/ make the sentence
more readable?  If not, then another option would be s/all but/nearly/.

(For information, I have some time to work on the patch today but little
time during the following two or three weeks.  Therefore, if I am slow
to reply after today, this does not mean that I have forgotten!  If not
today, then I will deliver PATCH v2 some time on or before Sept. 28.)

Download attachment "signature.asc" of type "application/pgp-signature" (834 bytes)

Powered by blists - more mailing lists