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

From: G. Branden Robinson <hidden>
Date: 2023-07-19 04:18:58
Subsystem: the rest · Maintainer: Linus Torvalds

From 0e3a24fda10445d6fd92c7dbbfb54106b1284931 Mon Sep 17 00:00:00 2001
From: "G. Branden Robinson" <redacted>
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 <redacted>
---
 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.
 .TP
 .B OPTIONS
 A description of the command-line options accepted by a

-- 
2.30.2

Regards,
Branden

Attachments

signature.asc [application/pgp-signature] 833 bytes

`h`	back out one level
`j`	next message in thread
`k`	previous message in thread
`l`	drill in
`Esc`	close help / fold thread tree
`?`	toggle this help