Re: [PATCH] man-pages(7): Add attributive annotation advice

[Alejandro Colomar <alx@kernel.org>]

[-- Attachment #1.1: Type: text/plain, Size: 1581 bytes --]

On 2023-07-19 06:18, G. Branden Robinson wrote:
> From 0e3a24fda10445d6fd92c7dbbfb54106b1284931 Mon Sep 17 00:00:00 2001
> From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
> Date: Sat, 15 Jul 2023 14:54:32 -0500
> Subject: [PATCH] man-pages(7): Add attributive annotation advice
> 
> Cc: Alejandro Colomar <alx@kernel.org>
> Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
> ---
>  man7/man-pages.7 | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/man7/man-pages.7 b/man7/man-pages.7
> index d63f2d8f2..aa39dbfd2 100644
> --- a/man7/man-pages.7
> +++ b/man7/man-pages.7
> @@ -255,6 +255,13 @@ .SS Sections within a manual page
>  Including version information is especially useful to users
>  who are constrained to using older kernel or C library versions
>  (which is typical in embedded systems, for example).
> +.IP
> +When an aspect of an interface requires multiple annotations,
> +such as an applicable architecture,
> +data type,
> +or indication of read-only status,
> +include these before the version information and separate them
> +with semicolons.

I'm now doubting the necessity of this patch.  It's like very
obvious content when you already know what it talks about, and
not very clear until you know what it's talking about.  Maybe
following existing practice is just simpler.

Cheers,
Alex

>  .TP
>  .B OPTIONS
>  A description of the command-line options accepted by a

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5


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