d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update mdoc(7) and mdoc.samples(7) to list the preferred order

Browse Source 
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
This commit is contained in:
mpp 1999-12-08 21:50:11 +00:00
parent c448976027
commit 261278a574
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
share/man/man7/mdoc.7
View File

@ -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.

6
share/man/man7/mdoc.samples.7
View File

@ -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