diff options
| author | mpp <mpp@FreeBSD.org> | 1999-12-08 21:50:11 +0000 |
|---|---|---|
| committer | mpp <mpp@FreeBSD.org> | 1999-12-08 21:50:11 +0000 |
| commit | 8c96c247df9af76d8b4eb3f6c3cde085fb1ab256 (patch) | |
| tree | de99b50a260cda9c7cb9835ad13aa02350109847 /share/man/man7 | |
| parent | 33380017bbbb9ebffe881fdf765354a826dcb3d1 (diff) | |
| download | FreeBSD-src-8c96c247df9af76d8b4eb3f6c3cde085fb1ab256.zip FreeBSD-src-8c96c247df9af76d8b4eb3f6c3cde085fb1ab256.tar.gz | |
Update mdoc(7) and mdoc.samples(7) to list the preferred order
of manual page sections. Make the two man pages consistent
with each other in the headers they list and they order they list
them in.
Note: this is the preferred ordering. All new man pages/additions
to man pages should try and follow this. Existing man pages
should be left alone, unless you are making major changes in
the man page and re-ordering of the sections is only a
minor part of the change.
PR: doc/15352, doc/15353
Diffstat (limited to 'share/man/man7')
| -rw-r--r-- | share/man/man7/mdoc.7 | 6 | ||||
| -rw-r--r-- | share/man/man7/mdoc.samples.7 | 6 |
2 files changed, 8 insertions, 4 deletions
diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 9c27ea5..d34904c 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -110,6 +110,8 @@ Files associated with the subject. Examples and suggestions. .It Ar DIAGNOSTICS Normally used for section four device interface diagnostics. +.It Ar COMPATIBILITY +Known compatibility issues. .It Ar ERRORS Sections two and three error and signal handling. @@ -120,10 +122,10 @@ Conformance to standards if applicable. .It Ar HISTORY If a standard is not applicable, the history of the subject should be given. -.It Ar BUGS -Gotchas and caveats. .It Ar AUTHORS Credits, if need be, should be placed here. +.It Ar BUGS +Gotchas and caveats. .It Ar other Customized headers may be added at the authors discretion. diff --git a/share/man/man7/mdoc.samples.7 b/share/man/man7/mdoc.samples.7 index 29a2637..ad3b016 100644 --- a/share/man/man7/mdoc.samples.7 +++ b/share/man/man7/mdoc.samples.7 @@ -458,8 +458,9 @@ in \&.Sh SYNOPSIS \&.Sh DESCRIPTION \&.\e" The following requests should be uncommented and -\&.\e" used where appropriate. This next request is -\&.\e" for sections 2, 3 and 9 function return values only. +\&.\e" used where appropriate. +\&.\e" .Sh IMPLEMENTATION NOTES +\&.\e" This next request is for sections 2, 3 and 9 function return values only. \&.\e" .Sh RETURN VALUES \&.\e" This next request is for sections 1, 6, 7, 8 & 9 only \&.\e" .Sh ENVIRONMENT @@ -469,6 +470,7 @@ in \&.\e" (command return values (to shell) and \&.\e" fprintf/stderr type diagnostics) \&.\e" .Sh DIAGNOSTICS +\&.\e" .Sh COMPATIBILITY \&.\e" The next request is for sections 2, 3 and 9 error \&.\e" and signal handling only. \&.\e" .Sh ERRORS |
