d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Address $FreeBSD$ and `rcsid'.

Browse Source
This commit is contained in:
David E. O'Brien 2001-04-22 02:32:42 +00:00
parent 1076a975f5
commit 58eac5ef6a
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=75820
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
share/man/man9/style.9
View File

@ -36,7 +36,10 @@ This file specifies the preferred style for kernel source files in the
source tree. It is also a guide for preferred userland code style.
.Bd -literal
/*
* Style guide for the FreeBSD. Based on KNF (Kernel Normal Form).
* Style guide for FreeBSD. Based on the CSRG's KNF (Kernel Normal Form).
*
* @(#)style 1.14 (Berkeley) 4/28/95
* $FreeBSD$
*/
/*
@ -51,6 +54,29 @@ source tree. It is also a guide for preferred userland code style.
*/
.Ed
.Pp
After any copyright header, there is a blank line, and the
.Va rcsid
for source files.
Version control system ID tags should only exist once in a file
(unlike this one).
Non-C/C++ source files follow the above example, while C/C++ source files
follow the below one.
All VCS revision identification from files obtained from elsewhere should be
maintained, including if there are multiple IDs showing a file's history.
In general, keep the IDs in tact, including any `$'s.
Most non-FreeBSD VCS IDs should be indented by a tab if in a comment.
.Bd -literal
#ifndef lint
#if 0
static char sccsid[] = "@(#)style 1.14 (Berkeley) 4/28/95";
#endif
static const char rcsid[] =
"$FreeBSD$";
#endif /* not lint */
.Ed
.Pp
Followed by another blank line.
.Pp
Kernel include files (i.e. sys/*.h) come first; normally, you'll need
<sys/types.h>
OR <sys/param.h>, but not both! <sys/types.h> includes <sys/cdefs.h>,