Re: Issue in man page namespaces.7

["G. Branden Robinson" <g.branden.robinson@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 1511 bytes --]

Hi Alex,

At 2023-01-22T21:17:40+0100, Alejandro Colomar wrote:
> On 1/22/23 20:31, Helge Kreutzmann wrote:
> > Without further ado, the following was found:
> > 
> > Issue:    /proc/sys/user → I</proc/sys/user>
> 
> Please review the following patch.
> --- a/man7/namespaces.7
> +++ b/man7/namespaces.7
> @@ -270,7 +270,7 @@ .SS The /proc/[pid]/ns/ directory
>  .\"
>  .\" ==================== The /proc/sys/user directory ====================
>  .\"
> -.SS The /proc/sys/user directory
> +.SS The \fI/proc/sys/user\fR directory
>  The files in the
>  .I /proc/sys/user
>  directory (which is present since Linux 4.9) expose limits

I would use \fP instead of \fR, this way you return to the "previous"
font, not the roman style in the current family.  This is important in
(sub)section headings because they are normally set in boldface, so
switching to roman explicitly would unintentionally put "directory" on a
diet (i.e., cause it to lose [stroke] weight).

With that correction, I'm +1.

But I would also quote multi-word arguments to _any_ man(7) macro.

Thus:

> +.SS "The \fI/proc/sys/user\fP directory"

Equivalently, if one doesn't care about portability to ancient
formatters...

> +.SS "The \f[I]/proc/sys/user\f[] directory"

...will suffice.

(One might reasonably wonder why "\fI" doesn't cause a loss of stroke
weight, too.  In groff 1.22.4 and earlier, it does.  In groff 1.23.0,
the man(7) package remaps the "I" to "BI".)

Regards,
Branden

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]