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.
This commit is contained in:
Warner Losh 2001-12-13 01:29:34 +00:00
parent 5b7cc8d153
commit 2b6f1df3bd
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=87773

View File

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