[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Groff] [PATCH] Expand portable escape section of groff_man(7).
From: |
Ingo Schwarze |
Subject: |
Re: [Groff] [PATCH] Expand portable escape section of groff_man(7). |
Date: |
Sat, 28 Oct 2017 15:18:18 +0200 |
User-agent: |
Mutt/1.8.0 (2017-02-23) |
Hi Branden,
G. Branden Robinson wrote on Thu, Oct 26, 2017 at 02:48:11AM -0400:
> The idea was that "green" isn't the only color one can specify, but in
> any case I agree with you. The whole .gcolor example can go, and I
> realize it probably grates because that example itself is of a
> non-portable request. :) What do you think?
The new text,
Using a boot argument of
\&'sound=0' disables the sound driver, according to J.\&
Alfred Prufrock.
is all about non-portable concepts as well - many operating systems
don't even have boot arguments. But that's OK: An example need not
document something portable. Ideally, it should be a sentence
* demonstrates the features (that's the case here)
* has no other formatting issues (violated here: If you wanted to
escape anything is this case, you would say "J.\ Alfred".
* isn't contrived (violated here: In a real manual,
you would simply write "argument of 'sound=0' disables...")
* has content that could actually occur in a manual (violated
here: manuals don't report hearsay)
But it's still good enough.
The rest of your commit looks good.
Yours,
Ingo