[PATCH] man-pages.7: Document CAVEATS section

Alejandro Colomar
2022-07-26T12:08:55Z

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