diff options
| author | Alejandro Colomar <alx.manpages@gmail.com> | 2022-07-26 13:06:59 +0200 |
|---|---|---|
| committer | Alejandro Colomar <alx.manpages@gmail.com> | 2022-07-26 21:00:03 +0200 |
| commit | cb828372757301fbadc99d54ba9d0fe2a5dd4d96 (patch) | |
| tree | 766df75832e2c6a7b1a89f1020daa236aee2f039 | |
| parent | 334f6d9563c12b3bf118bdaf4e5b67b918d02b3d (diff) | |
man-pages.7: Document CAVEATS section
CAVEATS is an interesting section. 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.
This section has been used in manual pages by authors from a wide
range of projects including AT&T, Korn shell, Perl, GNU and BSD
since the early 1980s. Using the section was first officially
recommended in 2002 by the file </usr/share/misc/mdoc.template> in
NetBSD and OpenBSD.
Reported-by: Ingo Schwarze <schwarze@usta.de>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
| -rw-r--r-- | man7/man-pages.7 | 5 |
1 files changed, 5 insertions, 0 deletions
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. |