From 16a7ef93273aed07828814b04e75a598f999f5db Mon Sep 17 00:00:00 2001 From: "David E. O'Brien" Date: Thu, 19 Jul 2001 18:03:43 +0000 Subject: [PATCH] State explicitly how the manpage "DESCRIPTION" options should be listed. --- share/man/man9/style.9 | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/share/man/man9/style.9 b/share/man/man9/style.9 index 3bce05921830..9696f5c33064 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