LDP
/
man-pages
mirror of https://github.com/mkerrisk/man-pages
0
1
Fork 0
Code Releases Activity

man-pages.7: DESCRIPTION should note versions for new interface features or behavior 

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2013-07-24 04:33:49 +02:00
parent 343a2c3bda
commit 3c4e1fb27a
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
man7/man-pages.7
View File

@ -27,7 +27,7 @@
.\" 2007-05-30 created by mtk, using text from old man.7 plus .\" 2007-05-30 created by mtk, using text from old man.7 plus
.\" rewrites and additional text. .\" rewrites and additional text.
.\" .\"
.TH MAN-PAGES 7 2013-06-21 "Linux" "Linux Programmer's Manual" .TH MAN-PAGES 7 2013-07-24 "Linux" "Linux Programmer's Manual"
.SH NAME .SH NAME
man-pages \- conventions for writing Linux man pages man-pages \- conventions for writing Linux man pages
.SH SYNOPSIS .SH SYNOPSIS
@ -261,6 +261,23 @@ section.
.\" section (and just place an overview in the .\" section (and just place an overview in the
.\" .B DESCRIPTION .\" .B DESCRIPTION
.\" section). .\" section).
When describing new behavior or new flags for
a system call or library function,
be careful to note the kernel or C library version
that introduced the change.
The preferred method of noting this information for flags is as part of a
.B .TP
list, in the following form (here, for a new system call flag):
.RS 22
.TP
.BR XYZ_FLAG " (since Linux 3.7)"
Description of flag...
.RE
.IP
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).
.TP .TP
.B OPTIONS .B OPTIONS
describes the command-line options accepted by a describes the command-line options accepted by a