summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorobrien <obrien@FreeBSD.org>2001-04-22 02:32:42 +0000
committerobrien <obrien@FreeBSD.org>2001-04-22 02:32:42 +0000
commit95ccde8ac80f0b9dbac5ee894f1a5c00d38477f8 (patch)
treeff114c3955e0a529f78ba261f78f2dd79cecd855 /share/man
parenta3d3df36dd32b4753238295185e731a1b06b04fa (diff)
downloadFreeBSD-src-95ccde8ac80f0b9dbac5ee894f1a5c00d38477f8.zip
FreeBSD-src-95ccde8ac80f0b9dbac5ee894f1a5c00d38477f8.tar.gz
Address $FreeBSD$ and `rcsid'.
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man9/style.928
1 files changed, 27 insertions, 1 deletions
diff --git a/share/man/man9/style.9 b/share/man/man9/style.9
index 61483e2..194fe53 100644
--- a/share/man/man9/style.9
+++ b/share/man/man9/style.9
@@ -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>,
OpenPOWER on IntegriCloud