summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbde <bde@FreeBSD.org>2001-10-25 11:20:15 +0000
committerbde <bde@FreeBSD.org>2001-10-25 11:20:15 +0000
commit6425b36e620052fa0f2fb463020d88a6a4b30efd (patch)
tree8a537a27d0b4bc86c6454eac4f6c295d52845065
parent82e0d8c4573e9ef4c4e46a2306c717cd624ea211 (diff)
downloadFreeBSD-src-6425b36e620052fa0f2fb463020d88a6a4b30efd.zip
FreeBSD-src-6425b36e620052fa0f2fb463020d88a6a4b30efd.tar.gz
Fixed some English errors, mainly ones not fixed in the previous commit.
The previous commit message should have said this too (the only BSDism fixed was punctuation for non-sentences). Neither these changes nor the ones in the previous commit were exactly as submitted by me.
-rw-r--r--share/man/man9/style.911
1 files changed, 3 insertions, 8 deletions
diff --git a/share/man/man9/style.9 b/share/man/man9/style.9
index d09a162..bf10edf 100644
--- a/share/man/man9/style.9
+++ b/share/man/man9/style.9
@@ -161,15 +161,10 @@ by size, and then by alphabetical order. The first category normally
doesn't apply, but there are exceptions. Each one gets its own line.
Try to make the structure
readable by aligning the member names using either one or two tabs
-depending upon your judgement.
+depending upon your judgment.
You should use one tab if it suffices to align most of the member names.
Names following extremely long types
-should be separated from it by a single space, i.e. use
-.Ql "int^I^Ix;"
-and
-.Ql "struct foo^I*x;"
-but
-.Ql "struct verylongtypename *baz;" .
+should be separated by a single space.
.Pp
Major structures should be declared at the top of the file in which they
are used, or in separate header files if they are used in multiple
@@ -192,7 +187,7 @@ the previous example would be better written:
.Bd -literal
#include <sys/queue.h>
struct foo {
- LIST_ENTRY(foo) link; /* Queue macro for foo lists. */
+ LIST_ENTRY(foo) link; /* Use queue macros for foo lists. */
struct mumble amumble; /* Comment for mumble. */
int bar; /* Try to align the comments. */
struct verylongtypename *baz; /* Won't fit in 2 tabs. */
OpenPOWER on IntegriCloud