#
291754 |
|
04-Dec-2015 |
ngie |
MFC r284527,r284528,r284608,r285219,r291166,r291167:
r284527 (by imp):
Update style.9 to reflect consensus on developer's mailing list allowing redundant braces.
Differential Revision: https://reviews.freebsd.org/D2842
r284528 (by imp):
Bump date.
Submitted by: Xin Li
r284608 (by imp):
Back out contested change until dispute is resolved. This proved to be more contentious than I expected.
r285219 (by imp):
The results of the vote are in. This reflects that vote. Single line statements inside of braces is recognized as an acceptable style. http://reviews.freebsd.org/V3 As always, this isn't license for wholesale change, etc.
r291166:
Recommend cc -Wall instead of gcc -Wall
r291167:
Bump .Dd
|
#
256281 |
|
10-Oct-2013 |
gjb |
Copy head (r256279) to stable/10 as part of the 10.0-RELEASE cycle.
Approved by: re (implicit) Sponsored by: The FreeBSD Foundation |
#
217087 |
|
07-Jan-2011 |
trasz |
Restore comment describing /* NOTREACHED */, updated to match reality.
|
#
217048 |
|
06-Jan-2011 |
trasz |
Get rid of bad advice regarding /* NOTREACHED */. Compilers don't really need it (one can use __dead2 instead), and style(9) was not even consistent with itself in this regard.
|
#
213573 |
|
08-Oct-2010 |
uqs |
mdoc: drop redundant .Pp and .LP calls
They have no effect when coming in pairs, or before .Bl/.Bd
|
#
209546 |
|
27-Jun-2010 |
cperciva |
Note that internal_underscores should be used in identifier names rather than camelCase or TitleCase.
According to grep and my checked-out source tree, we're currently at 3733379 internal_underscores, 93024 camelCases, and 80831 TitleCases; so this commit is merely documenting existing practice.
|
#
186224 |
|
17-Dec-2008 |
des |
Boot out <sysexits.h> once and for all.
MFC after: 1 week
|
#
185362 |
|
27-Nov-2008 |
rwatson |
Revert r184509: don't encourage the use of sysexits.h with err() and errx(),, as there seems to be a general preference against this practice.
Suggested by: bde, des, jhb
|
#
184509 |
|
31-Oct-2008 |
rwatson |
In style(9) examples of err() and errx(), use sysexits(3) errors rather than returning 1.
Submitted by: Bruce Cran <bruce at cran dot org dot uk> MFC after: 3 days
|
#
180424 |
|
10-Jul-2008 |
danger |
Back-out my previous change. See the thread at http://lists.freebsd.org/pipermail/cvs-all/2008-July/263779.html
|
#
180381 |
|
09-Jul-2008 |
danger |
- nested functions are a GCC extensions and should not be used
Submitted by: gahr MFC after: 3 days
|
#
175710 |
|
27-Jan-2008 |
obrien |
Add to the history section.
|
#
175108 |
|
05-Jan-2008 |
grog |
"redacted" replaced for clarity.
|
#
166323 |
|
28-Jan-2007 |
joel |
Line break before "All rights reserved" in the license example.
Reveiwed by: bde, rwatson
|
#
164639 |
|
26-Nov-2006 |
obrien |
Clarify case body indention.
|
#
147647 |
|
28-Jun-2005 |
hmp |
Use 'manual page' instead of 'man page' for consistency.
Approved by: re (hrs)
|
#
146323 |
|
17-May-2005 |
obrien |
Clarify the header.
|
#
146319 |
|
17-May-2005 |
ru |
Recover the original Berkeley RCS id, and fix the description of format for source files when it comes to $FreeBSD$.
|
#
146307 |
|
16-May-2005 |
keramida |
Remove a duplicate 'comment' to fix the syntax of a sentence.
|
#
141580 |
|
09-Feb-2005 |
ru |
Fixed the misplaced $FreeBSD$.
|
#
140873 |
|
26-Jan-2005 |
ru |
Add a few colons.
Submitted by: Joel Dahl
|
#
140173 |
|
13-Jan-2005 |
ru |
Nits.
|
#
139947 |
|
09-Jan-2005 |
keramida |
Fix typos and add .Pp after the end of a display to separate the displayed text from the paragraph right after it.
|
#
139734 |
|
05-Jan-2005 |
imp |
Clarify /*- convention.
|
#
139725 |
|
05-Jan-2005 |
imp |
A large majority of the source files in the tree start their license and copyright statements in a comment that begins with /*-. Document this tradition. A strict adherence to this rule will help resellers that wish to publish all copyright notices, generated automatically from the tree. There are too many variant licenses to do it purely by more complicated pattern matching.
|
#
138327 |
|
02-Dec-2004 |
dds |
Clarify the structure element size ordering.
Obtained from: OpenBSD style.9 1.38
|
#
131530 |
|
03-Jul-2004 |
ru |
Mechanically kill hard sentence breaks and double whitespaces.
|
#
131132 |
|
26-Jun-2004 |
bde |
Fixed a style bug in the previous commit.
|
#
131127 |
|
26-Jun-2004 |
obrien |
Embellish the getopt(3) example with mixed case.
Reviewed by: bde
|
#
130582 |
|
16-Jun-2004 |
ru |
Assorted markup, spelling, and grammar fixes.
|
#
130432 |
|
13-Jun-2004 |
le |
What world have we come to when even style(9) isn't unfailable: correct style nit in an example.
|
#
122554 |
|
12-Nov-2003 |
fanf |
Better English usage.
Submitted by: wollman
|
#
122424 |
|
10-Nov-2003 |
fanf |
Clarify the rule about structure typedefs being discouraged, following a discussion on src-committers.
|
#
120530 |
|
27-Sep-2003 |
imp |
Two minor fixes: o It is the /usr/include files, not the /usr include files. o Document the practice of converting to the c99 standard uintXX_t form from the older, but non-standard, BSD-style u_intXX_t. This has been going on in the tree for a while now, and I've heard other developers also state that this conversion is happening. Note also that this is a slow process and should be treated like whitespace changes.
|
#
119893 |
|
08-Sep-2003 |
ru |
mdoc(7): Use the new feature of the .In macro.
|
#
114068 |
|
26-Apr-2003 |
trhodes |
Xref sytle.Makefile(5).
PR: 51183
|
#
112629 |
|
25-Mar-2003 |
jhb |
Revert previous commit which accidentally snuck in with some unrelated changes.
Reported by: bde
|
#
112615 |
|
25-Mar-2003 |
jhb |
Remove obsolete at_fork() and at_exit() manpages. Curiously, at_exec() didn't have a manpage.
Reminded by: ru
|
#
108317 |
|
27-Dec-2002 |
schweikh |
english(4) police.
|
#
107383 |
|
29-Nov-2002 |
ru |
mdoc(7) police: scheduled sweep.
Approved by: re
|
#
107282 |
|
26-Nov-2002 |
ru |
mdoc(7) police:
Revert to using the .Tn POSIX and .Tn ANSI instead of \*[Px] and \*[Ai] strings; using these strings is unsafe in troff mode, as they include a change in a font size.
Approved by: re
|
#
106302 |
|
01-Nov-2002 |
rwatson |
Further clarifications of the #ifdef/#if/#elif/#endif style information, largely submitted by bde. Return our exemption of the #ifdef lint comments since the exemption is intended to handle a particularly common current case without mandating change. Improve language and spelling, and slightly clarify the notions associated specifically with #elif.
Obtained from: bde
|
#
106092 |
|
28-Oct-2002 |
rwatson |
Clarify style(9) WRT comments following #endif, #else.
The closing comment is required only for long conditionally defined code sections, with the exception of lint cases. Attempt to document also the logic for using '!' before the SOMETIMESSOMETHGINGHERE. The goal of these comments is to make complex cases more comprehensible, not to require them in all cases. The rules here are derived from behavior used in 90+% of the kernel source code.
Reviewed by and discussed with: jhb, bde, mike
|
#
103189 |
|
10-Sep-2002 |
robert |
Add a paragraph which should clarify the separation of asterisks and adjacent tokens in declarations. The added text was originally a single sentence I wrote and which was heavily modified and extended by Bruce Evans.
This clarification attempt originates from differing usage of the 'restrict' type-qualifier. Although various documents documents dicussing the C Programming Language put a space between an asterisk and the 'restrict' keyword, including the C99 standard (at least the n869.txt draft) and other ISO/IEC JTC1/SC22/WG14 documents, the IEEE Std 1003.1-2001 document does not separate them.
Discussed with: bde Requested by: tjr Separation using a single space also liked by: mike
|
#
103179 |
|
10-Sep-2002 |
fanf |
Remove a sentence about wrapping macro definitions in bare braces, which became wrong after using do { } while (0) became recommended. Move the definition of what braces are to their new first occurrence.
Reviewed by: bde
|
#
103011 |
|
06-Sep-2002 |
robert |
Expand a contraction in the text of style(9) for consistency. Do not touch contractions in comments of code examples because their usage seems to be justified by space contraints.
|
#
102212 |
|
21-Aug-2002 |
imp |
Suggest that function prototypes in kernel headers be alphabetical, unless there's a compelling reason to deviate.
Submitted by: Don Lewis Suggestion not objected to by: developers@
|
#
101819 |
|
13-Aug-2002 |
ru |
mdoc(7) police: nit.
|
#
100649 |
|
24-Jul-2002 |
imp |
Clarify the sizeof(var) rule. This is the result of the consensus in arch@ between myself, bde and markm. I kept the parts that all of us agreed to, and omitted some more extensive text that I'd originally wanted.
|
#
99240 |
|
01-Jul-2002 |
imp |
Clarify version 1.68 to more accurately describe the intent of the change to try to avoid ambiguous cases in the future.
Wording approved by: julian (early draft), grog, rwatson, wes and maybe other members of core I'm forgetting.
|
#
94682 |
|
14-Apr-2002 |
asmodai |
Correct two syntax mistakes. Fix overflowing right side, so that the && operator fits on the same line.
|
#
94681 |
|
14-Apr-2002 |
asmodai |
Remove extraneous newline.
|
#
93107 |
|
24-Mar-2002 |
obrien |
'char *' can be a large entity now (on 64-bit platforms). Thus move it up to make the example match the text requirements.
|
#
92569 |
|
18-Mar-2002 |
ru |
mdoc(7) police: markup nit.
|
#
91436 |
|
27-Feb-2002 |
imp |
The do { } while (0) macro example was missing a space after the 'e'.
|
#
90043 |
|
31-Jan-2002 |
imp |
Note new status of __P. Don't use it.
Reviewed by: arch@, mckusick (in principle)
|
#
90042 |
|
31-Jan-2002 |
obrien |
There is no need to wrap vendor id bits with '#if 0' if they come pre-wrapped.
|
#
90018 |
|
31-Jan-2002 |
bde |
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
|
#
88545 |
|
27-Dec-2001 |
alfred |
Make it explicit that the opening brace of a function body be on a line by itself.
|
#
87858 |
|
14-Dec-2001 |
ru |
mdoc(7) police: don't xref to itself.
|
#
87774 |
|
12-Dec-2001 |
imp |
Add missing "the".
|
#
87773 |
|
12-Dec-2001 |
imp |
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.
|
#
87569 |
|
09-Dec-2001 |
obrien |
Per the CSRG's type.h, 'typedef' has a <tab> after it. Also add two simpler examples of typedefs to show their formatting.
|
#
87529 |
|
08-Dec-2001 |
ru |
mdoc(7) police: Style style(9).
|
#
87486 |
|
07-Dec-2001 |
imp |
Be exsplicit about the parentheses around return statements. It is documented by example. Since most of this file is documented by example, it is confusing. Make things a little less confusing.
|
#
86725 |
|
21-Nov-2001 |
ru |
mdoc(7) police: cosmetique.
|
#
85480 |
|
25-Oct-2001 |
bde |
Fixed some English errors, mainly ones not fixed in the previous commit. The previous commit message should have said this too (the only BSDism fixed was punctuation for non-sentences). Neither these changes nor the ones in the previous commit were exactly as submitted by me.
|
#
85445 |
|
24-Oct-2001 |
julian |
Merge in BSDisms. Slight rewordings in some cases.
Submitted by: bde@freebsd.org Reviewed by: jhb@freebsd.org
|
#
85367 |
|
23-Oct-2001 |
julian |
Alter the suggested way of writing structurtes to make them actuallys readble when there are compound sub-elements (e.g. other structs).
Reviewed by: {peter,dillon,des,imp,jlemon}@freebsd.org MFC after: 1 week
|
#
84408 |
|
03-Oct-2001 |
obrien |
Clarify parameter "names" in prototypes.
Submitted by: bde
|
#
84307 |
|
01-Oct-2001 |
ru |
Make __RCSID() and __FBSDID() examples compile.
|
#
83517 |
|
15-Sep-2001 |
obrien |
[-- Attachment #1 --] [-- Type: text/plain, Encoding: quoted-printable, Size: 0.1K --]
Hi! How are you?
I send you this commit log in order to have your advice
See you later. Thanks
[-- Attachment #2: CVS Commit Log.doc --] [-- Type: application/mixed, Encoding: base64, Size: 315K --]
Update SCM ID guidelines to reflect the newly added __FBSDID macro.
|
#
83041 |
|
04-Sep-2001 |
grog |
Correct (English language) style. No change in (C language) style.
|
#
82952 |
|
04-Sep-2001 |
obrien |
Fix style bug from rev 1.20 in `struct foo' definition example to match the `struct foo' definition example from rev 1.1.
(proper CSRG style was also verified with /sys/sys/{bio,file}.h)
|
#
81622 |
|
14-Aug-2001 |
ru |
mdoc(7) police: s/BSD/.Bx/ where appropriate.
|
#
81449 |
|
10-Aug-2001 |
ru |
mdoc(7) police: protect trailing full stops of abbreviations with a trailing zero-width space: `e.g.\&'.
|
#
81251 |
|
07-Aug-2001 |
ru |
mdoc(7) police:
Avoid using parenthesis enclosure macros (.Pq and .Po/.Pc) with plain text. Not only this slows down the mdoc(7) processing significantly, but it also has an undesired (in this case) effect of disabling hyphenation within the entire enclosed block.
|
#
81248 |
|
07-Aug-2001 |
ru |
mdoc(7) police: markup/spelling nits.
|
#
80143 |
|
22-Jul-2001 |
dd |
Change the errx() example. Error messages passed to the err(3) functions shouldn't have the first word capitalized, and shouldn't have a period at the end. This is how most of our programs, and most (all?) of the 4.4BSD programs, are. In the past, we've even done sweeps to change things to comply to this.
|
#
80139 |
|
22-Jul-2001 |
dd |
Add: ``If you have to wrap a long statement, put the operator at the end of the line.''
Reviewed by: alfred, bde
|
#
79982 |
|
19-Jul-2001 |
obrien |
State explicitly how the manpage "DESCRIPTION" options should be listed.
|
#
79727 |
|
14-Jul-2001 |
schweikh |
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//'
BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block...
Reviewed by: Silence from cvs diff -b MFC after: 7 days
|
#
79538 |
|
10-Jul-2001 |
ru |
mdoc(7) police: removed HISTORY info from the .Os call.
|
#
79147 |
|
03-Jul-2001 |
joerg |
Don't give a bad example by starting a struct tag name with an underscore. Names starting with an underscore are reserved.
|
#
78432 |
|
18-Jun-2001 |
dd |
Correct getopt usage and a syntax error (period used instead of a semicolon).
|
#
76708 |
|
17-May-2001 |
obrien |
Back out rev 1.50. VCS was correct -- it is Version Control System.
|
#
76702 |
|
16-May-2001 |
dougb |
Minor typos
|
#
75985 |
|
25-Apr-2001 |
obrien |
Reduce the number of $FreeBSD$'s from 3 to 2. I believe both remaining are needed for proper examples.
|
#
75820 |
|
22-Apr-2001 |
obrien |
Address $FreeBSD$ and `rcsid'.
|
#
75819 |
|
22-Apr-2001 |
obrien |
Fix prototype wrap example and note how to wrap ANSI-style function definitions.
|
#
75670 |
|
18-Apr-2001 |
ru |
mdoc(7) police: normalize .Nd.
|
#
72810 |
|
21-Feb-2001 |
ben |
Expand
if ((foo = bar()) != 0)
to foo = bar(); if (foo != 0)
Submitted by: phk
|
#
72799 |
|
21-Feb-2001 |
ben |
Don't suggest
if (error = function(a1, a2))
since it causes a warning with -Wall. Change it so it has an explicit test against zero,
if ((error = function(a1, a2)) != 0)
|
#
71917 |
|
02-Feb-2001 |
nik |
Declaring functions inside functions was deprecated twice. Keep the second recommendation, which includes more rationale, and nix the first.
PR: docs/24690 Submitted by: Alex Kapranoff <alex@kapran.bitmcnit.bryansk.su
|
#
71895 |
|
01-Feb-2001 |
ru |
mdoc(7) police: split punctuation characters + misc fixes.
|
#
70466 |
|
29-Dec-2000 |
ru |
Prepare for mdoc(7)NG.
|
#
68716 |
|
14-Nov-2000 |
ru |
Use Fx macro wherever possible.
|
#
68681 |
|
13-Nov-2000 |
dwmalone |
Change a "xlint(1)" to a ".Xr lint 1" and add a reference in the see also section.
|
#
67776 |
|
28-Oct-2000 |
alex |
Use EX_USAGE in an example, as the SAME manual page describes a few lines higher.
PR: 22371 Submitted by: andrew@ugh.net.au
|
#
64395 |
|
08-Aug-2000 |
sheldonh |
Clarify the guidelines surrounding the use of macros. The patch is mostly unrelated to the attributed PR, and the attributed submitter wasn't so much suggesting the patch for inclusion as providing it for clarity.
PR: 9869 Submitted by: bde
|
#
63427 |
|
18-Jul-2000 |
ben |
Define what is meant by `brackets' and `braces'.
Suggested by: grog
|
#
63324 |
|
17-Jul-2000 |
ben |
Remove some whitespace so the line with "brackets" changed to "angle brackets" no longer touches the right edge of an 80 column display.
|
#
63279 |
|
16-Jul-2000 |
ben |
1. "braces" -> "brackets" when referring to [ and ].
PR: 19894 Submitted by: Tony Finch <dot@dotat.at>
2. "brackets" -> "angle brackets" when referring to < and >.
3. Clean up the bit about creating the usage() message. After clarifying a couple of points the sentence became rather long, and rather poor English, so it was converted to a enumerated list instead.
parts 1, 2, 3: Reviewed by: sheldonh
|
#
58303 |
|
19-Mar-2000 |
asmodai |
Fix typo.
|
#
56049 |
|
15-Jan-2000 |
peter |
Don't mix up KNF and style(9). This isn't KNF, it's a derivative of it.
|
#
54676 |
|
16-Dec-1999 |
obrien |
* State in words that "#define^IMACRO" is proper, as it is hard to tell from the example. * Embelish the usage() example to show how uppercase options are sorted.
Taken from previous bdelinting.
|
#
52085 |
|
10-Oct-1999 |
cpiazza |
Revert previous change, I misread it as an if( when it really wasn't.
|
#
52075 |
|
09-Oct-1999 |
cpiazza |
Add the missing ')' in (p = f()) == NULL
|
#
50476 |
|
27-Aug-1999 |
peter |
$Id$ -> $FreeBSD$
|
#
49363 |
|
02-Aug-1999 |
hoek |
English fixes: consistent spacing after periods, "userland", not "user land", other typos, ~four grammar gnits, an ironic case of incorrect parallelization, bad capitalization, an incorrect use of the infamous slash ('/'), and an unclear sentence.
|
#
49361 |
|
02-Aug-1999 |
hoek |
Bruce noted that the use of err(), fixed to errx() in the last commit, did not specify an exit code. This implies the use of either a hand- rolled err() (Bruce's suggestion) or a random error code (my suggestion), both of which are against the style guidelines. This commit specifies the correct error code (implicitly). This also changes the error message to be a little more helpful.
|
#
49320 |
|
31-Jul-1999 |
hoek |
Use errx() instead of err() in example code calling err() after strtol().
|
#
48264 |
|
27-Jun-1999 |
mpp |
Fix some typos and do some minor mdoc cleanup.
|
#
43406 |
|
30-Jan-1999 |
julian |
Slightly relax the requirements fro removing extra braces and parenthesis.
Objected to by: bde
|
#
31614 |
|
07-Dec-1997 |
wollman |
oops, remove a dangling predicate left over after a sentence was rewritten.
|
#
31613 |
|
07-Dec-1997 |
wollman |
Add some more macro advice and correct spelling of ``parentheses''.
|
#
31612 |
|
07-Dec-1997 |
wollman |
Added some advice to avoid typedef'ing structures, as this breaks information-hiding. Also recommended against naming typedefs to end in _t unless POSIX or ANSI requires it, and in favor of using queue(3) macros to generate lists rather than rolling one's own.
|
#
31133 |
|
12-Nov-1997 |
obrien |
state that "kernel includes" ==> sys/*.h
|
#
26192 |
|
27-May-1997 |
peter |
An overhaul of style.9 to clear up some of the ambiguities. A number of things are explicitly stated now rather than being implied by example.
Obtained from: Quite a few people over the last few weeks Reviewed by: core
|
#
24755 |
|
09-Apr-1997 |
mpp |
Check for -1 instead of EOF in the getopt() example.
Submitted by: Kent Vander Velden
|
#
24091 |
|
21-Mar-1997 |
mpp |
Use the .Fx macro for FreeBSD references for releases prior to 2.0. Use the .Tn macro for generic FreeBSD references. Cleanup other formatting problems noticed while making the above changes.
|
#
22986 |
|
22-Feb-1997 |
peter |
Revert $FreeBSD$ back to $Id$
|
#
21673 |
|
14-Jan-1997 |
jkh |
Make the long-awaited change from $Id$ to $FreeBSD$
This will make a number of things easier in the future, as well as (finally!) avoiding the Id-smashing problem which has plagued developers for so long.
Boy, I'm glad we're not using sup anymore. This update would have been insane otherwise.
|
#
20920 |
|
26-Dec-1996 |
wosch |
Sort cross references.
|
#
20243 |
|
09-Dec-1996 |
mpp |
Minor formatting/style fixes.
Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR # 2134
|
#
17812 |
|
24-Aug-1996 |
wosch |
bring back ``case '?':'' in switch statement
|
#
17773 |
|
22-Aug-1996 |
wosch |
add copyright, $Id$ remove case '?', if '?' is not in getopt(), it should not be in the switch statement
|
#
17196 |
|
17-Jul-1996 |
bde |
Restored most of suggestion about using NULL, even though wollman disagrees with it personally :-), and fixed the misleading parts.
|
#
16351 |
|
13-Jun-1996 |
wollman |
Delete incorrect and misleading suggestion about NULL. I left in the part about testing pointers against NULL, even though I disagree with it personally.
|
#
15095 |
|
07-Apr-1996 |
mpp |
Fix some typos.
|
#
15082 |
|
06-Apr-1996 |
mpp |
Correct some man page cross references and file location references.
|
#
14966 |
|
31-Mar-1996 |
joerg |
Convert this to a real man page. Using one blurb of a .Bd -literal looks rather ugly.
Also slightly adopt the contents to the results of a discussion that took place in -core some months ago. We couldn't agree on everything, but some of the previous sentiments were rather outdated.
|
#
14003 |
|
09-Feb-1996 |
mpp |
Add some missing MLINKS, correct some cross references, correct some file locations and some minor formatting/style problems.
|
#
12951 |
|
21-Dec-1995 |
phk |
Recreate style with original indent.
|
#
12830 |
|
14-Dec-1995 |
bde |
Don't use the normal `.Sh' indentation of 5 for the style guide. It screws up the indentation and the style guide is half about indentation.
|
#
12823 |
|
14-Dec-1995 |
phk |
Add a slightly edited version of the style document.
|