public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
To: linux-man@vger.kernel.org
Cc: alx@kernel.org
Subject: [PATCH] man-pages(7): Add attributive annotation advice
Date: Tue, 18 Jul 2023 23:18:32 -0500	[thread overview]
Message-ID: <20230719041832.ulsigsjae42rqh3g@illithid> (raw)

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

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.
 .TP
 .B OPTIONS
 A description of the command-line options accepted by a
-- 
2.30.2

Regards,
Branden

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

             reply	other threads:[~2023-07-19  4:18 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-19  4:18 G. Branden Robinson [this message]
2023-07-19 20:01 ` [PATCH] man-pages(7): Add attributive annotation advice Alejandro Colomar
2023-07-20  2:13   ` G. Branden Robinson
2023-07-20  8:24     ` Alejandro Colomar
2023-07-20  9:14       ` G. Branden Robinson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230719041832.ulsigsjae42rqh3g@illithid \
    --to=g.branden.robinson@gmail.com \
    --cc=alx@kernel.org \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox