diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2013-07-24 04:33:49 +0200 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2013-07-24 04:33:49 +0200 |
| commit | 3c4e1fb27ac29e5e922463eabf9ddcbba5461ece (patch) | |
| tree | 1177eacd3ca3fad4082d258a8e6bd7ec829e6aa2 /man7 | |
| parent | 343a2c3bda8e1e2cab599358af1b69de661ab79f (diff) | |
| download | man-pages-3c4e1fb27ac29e5e922463eabf9ddcbba5461ece.tar.gz | |
man-pages.7: DESCRIPTION should note versions for new interface features or behavior
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Diffstat (limited to 'man7')
| -rw-r--r-- | man7/man-pages.7 | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/man7/man-pages.7 b/man7/man-pages.7 index b27bd98767..7574ae3f02 100644 --- a/man7/man-pages.7 +++ b/man7/man-pages.7 @@ -27,7 +27,7 @@ .\" 2007-05-30 created by mtk, using text from old man.7 plus .\" 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 man-pages \- conventions for writing Linux man pages .SH SYNOPSIS @@ -261,6 +261,23 @@ section. .\" section (and just place an overview in the .\" .B DESCRIPTION .\" 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 .B OPTIONS describes the command-line options accepted by a |