summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorobrien <obrien@FreeBSD.org>2001-07-19 18:03:43 +0000
committerobrien <obrien@FreeBSD.org>2001-07-19 18:03:43 +0000
commit81a0125a69cc46a8385482be64b0c3e3a7f66f81 (patch)
tree82f69a2f82cbdd48722bb590116bc83a14c53e4d /share/man
parent9cac33d71fc5f6846362da63a753c08e90efa427 (diff)
downloadFreeBSD-src-81a0125a69cc46a8385482be64b0c3e3a7f66f81.zip
FreeBSD-src-81a0125a69cc46a8385482be64b0c3e3a7f66f81.tar.gz
State explicitly how the manpage "DESCRIPTION" options should be listed.
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man9/style.98
1 files changed, 7 insertions, 1 deletions
diff --git a/share/man/man9/style.9 b/share/man/man9/style.9
index 3bce059..9696f5c 100644
--- a/share/man/man9/style.9
+++ b/share/man/man9/style.9
@@ -560,13 +560,19 @@ placed in a single set of brackets.
}
.Ed
.Pp
+Note that the manual page options description should list the options in
+pure alphabetical order.
+That is, with out reguard to whether an option takes arguments or not.
+The alphabetical ordering should take into account the case ordering
+shown above.
+.Pp
New core kernel code should be reasonably compliant with the style guides.
The guidelines for third-party maintained modules and device drivers are more
relaxed but at a minimum should be internally consistent with their style.
.Pp
Stylistic changes (including whitespace changes) are hard on the source
repository and are to be avoided without good reason. Code that is
-approximately
+approximately FreeBSD KNF
.Xr style 9
compliant in the repository must not diverge from compliance.
.Pp
OpenPOWER on IntegriCloud