Modified the rules for vendor ids:
- explictly say not to edit infrastructure for vendor ids (not just the ids). - say to enclose vendor ids and their infrastucture in ``#if 0'', and partly explain why. - don't set a bad example by mangling the Berkeley id infrastructure from ``static char sccsid[] ...'' to ``__RCSID(...)''. - show a blank line between the vendor id cruft and the FreeeBSD if cruft in the example. - relaxed the rule about adding "From: " to say that "From: " is actually useful if the file has been renamed. - minor English improvements. Discussed with: obrien
This commit is contained in:
parent
066f7169c1
commit
96cb532cb8
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=90018
@ -62,23 +62,28 @@ 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).
|
||||
(unlike in this one).
|
||||
Non-C/C++ source files follow the example above, while C/C++ source files
|
||||
follow the one below.
|
||||
All VCS (version control system) revision identification from files obtained
|
||||
All VCS (version control system) revision identification in files obtained
|
||||
from elsewhere should be maintained, including, where applicable, multiple IDs
|
||||
showing a file's history.
|
||||
In general, keep the IDs intact, including any
|
||||
.So Li $ Sc Ns s .
|
||||
There is no reason to add
|
||||
.Qq Li "From"
|
||||
in front of foreign VCS IDs.
|
||||
Most
|
||||
.No non- Ns Fx
|
||||
VCS IDs should be indented by a tab if in a comment.
|
||||
In general, do not edit foreign IDs or their infrastructure;
|
||||
enclose both in
|
||||
.Dq Li "#if 0 ... #endif"
|
||||
to hide any uncompilable bits
|
||||
and to keep the IDs out of object files.
|
||||
Only add
|
||||
.Dq Li "From: "
|
||||
in front of foreign VCS IDs if the file is renamed.
|
||||
.Bd -literal
|
||||
#if 0
|
||||
#ifndef lint
|
||||
static char sccsid[] = "@(#)style 1.14 (Berkeley) 4/28/95";
|
||||
#endif /* not lint */
|
||||
#endif
|
||||
|
||||
#include <sys/cdefs.h>
|
||||
__RCSID("@(#)style 1.14 (Berkeley) 4/28/95");
|
||||
__FBSDID("$FreeBSD$");
|
||||
.Ed
|
||||
.Pp
|
||||
|
Loading…
Reference in New Issue
Block a user