All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx.manpages@gmail.com>
To: Ingo Schwarze <schwarze@usta.de>, linux-man@vger.kernel.org
Cc: Alejandro Colomar <alx.manpages@gmail.com>
Subject: [PATCH] man-pages.7: Document CAVEATS section
Date: Tue, 26 Jul 2022 14:08:18 +0200	[thread overview]
Message-ID: <20220726120817.100462-1-alx.manpages@gmail.com> (raw)

CAVEATS is an interesting section from OpenBSD.  There's a slight
difference between CAVEATS and BUGS.  We usually have a hard time
fitting what would go into CAVEATS into other sections (usually
BUGS and NOTES); it would be easier if we had the section.  Let's
add it.

Reported-by: Ingo Schwarze <schwarze@usta.de>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
 man7/man-pages.7 | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/man7/man-pages.7 b/man7/man-pages.7
index 99bfa400f..e88b98ddb 100644
--- a/man7/man-pages.7
+++ b/man7/man-pages.7
@@ -174,6 +174,7 @@ VERSIONS	[Normally only in Sections 2, 3]
 ATTRIBUTES	[Normally only in Sections 2, 3]
 CONFORMING TO
 NOTES
+CAVEATS
 BUGS
 EXAMPLES
 .\" AUTHORS sections are discouraged
@@ -421,6 +422,10 @@ to mark off notes that describe the differences (if any) between
 the C library wrapper function for a system call and
 the raw system call interface provided by the kernel.
 .TP
+.B CAVEATS
+Warnings about typical user misuse of an API,
+that don't constitute an API bug or design defect.
+.TP
 .B BUGS
 A list of limitations, known defects or inconveniences,
 and other questionable activities.
-- 
2.36.1


             reply	other threads:[~2022-07-26 12:08 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-26 12:08 Alejandro Colomar [this message]
2022-07-26 13:54 ` [PATCH] man-pages.7: Document CAVEATS section Ingo Schwarze
2022-07-26 14:29   ` Alejandro Colomar
2022-07-26 15:37     ` Ingo Schwarze
2022-07-26 19:02       ` Alejandro Colomar
2022-07-27  9:14         ` Ingo Schwarze
2022-07-27  9:23           ` Alejandro Colomar (man-pages)

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=20220726120817.100462-1-alx.manpages@gmail.com \
    --to=alx.manpages@gmail.com \
    --cc=linux-man@vger.kernel.org \
    --cc=schwarze@usta.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.