summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorimp <imp@FreeBSD.org>2001-12-13 01:29:34 +0000
committerimp <imp@FreeBSD.org>2001-12-13 01:29:34 +0000
commitec1cf4cdf97e57b2ca2a8dcc5237312651fb6314 (patch)
tree0af69d790264b48c989160ba020bf63d5804c5cc /share
parentc0159cc50ea4b54d03d9f5f2b32069f3d3ca26c5 (diff)
downloadFreeBSD-src-ec1cf4cdf97e57b2ca2a8dcc5237312651fb6314.zip
FreeBSD-src-ec1cf4cdf97e57b2ca2a8dcc5237312651fb6314.tar.gz
Add two clarifying commnets:
1) Note that this file is also by example. 2) Note that you should not use files from /usr/include in kernel files.
Diffstat (limited to 'share')
-rw-r--r--share/man/man9/style.98
1 files changed, 8 insertions, 0 deletions
diff --git a/share/man/man9/style.9 b/share/man/man9/style.9
index fd8cf46..422e5a7 100644
--- a/share/man/man9/style.9
+++ b/share/man/man9/style.9
@@ -34,6 +34,10 @@ This file specifies the preferred style for kernel source files in the
.Fx
source tree.
It is also a guide for preferred userland code style.
+Many of the style rules are implicit in the examples.
+Be careful to check the examples before assuming that
+.Xr style 9
+is silent on an issue.
.Bd -literal
/*
* Style guide for FreeBSD. Based on the CSRG's KNF (Kernel Normal Form).
@@ -104,6 +108,10 @@ For a network program, put the network include files next.
#include <protocols/rwhod.h>
.Ed
.Pp
+Do not use files in
+.Pa /usr/include
+for files in the kernel.
+.Pp
Leave a blank line before the next group, the
.Pa /usr
include files,
OpenPOWER on IntegriCloud