Kyle Evans
37394a5d7e
style(9): add some additional useful FILES/xref information
...
Submitted by: 0mp
Reviewed by: imp
Differential Revision: https://reviews.freebsd.org/D15196
2018-05-04 03:23:45 +00:00
Warner Losh
57b4b5f816
Remove reference to lint. We no longer support it, so exceptions for
...
it are no longer relevant.
2018-03-20 21:37:33 +00:00
Warner Losh
793c98590a
Update to include information about using SPDX-License-Identifier
...
lines.
2018-03-20 21:31:18 +00:00
Warner Losh
c3d171bd18
Remove K&R stuff: never use it in new code.
...
Remove how to format K&R stuff. The project hasn't been using it in
new code for a long time. It's so obsolete, we don't need a statement
to never use it. Add a statement requesting that comments about
parameters be preserved when converting to ASNI style, per Kirk.
Differential Revision: https://reviews.freebsd.org/D14051
2018-03-09 17:54:14 +00:00
Warner Losh
d3de39bff0
Bump .Dd date for c99 change
2018-01-25 15:55:58 +00:00
Warner Losh
88c53cfda1
Add info about c99 designationed initializers.
...
Differential Revision: https://reviews.freebsd.org/D13975
2018-01-25 15:42:21 +00:00
Warner Losh
4e617d8cb9
No need for the zero width space now that I put the comma in.
2018-01-18 22:23:16 +00:00
Warner Losh
36a910fba3
Make igor happier with this file:
...
o Don't use contractions.
o Add common after e.g. where needed
2018-01-18 22:20:30 +00:00
Konstantin Belousov
d7ff64a9b1
Bump dates after lint removal.
...
Noted by: wblock
Sponsored by: The FreeBSD Foundation
2017-11-17 19:10:10 +00:00
Konstantin Belousov
9898800172
Remove xlint(1).
...
xlint is currently a fossil. We have much more useful and alive tools
to do now what xlint did twenty years ago.
I did not cleared some stuff which makes lint operational, in
sys/x86/include and sys/sys, but I might do it as followup. The
x86/include/ucontext.h and _types.h hacks made to please lint was the
main reason for my initial proposal to classify xlint as obsolete and
to remove it.
Also I do not intend to clear sccs ids.
Reviewed by: bapt, brooks, emaste, jhb, pfg
Sponsored by: The FreeBSD Foundation
Differential revision: https://reviews.freebsd.org/D13015
2017-11-16 14:37:18 +00:00
Conrad Meyer
8eb92614fd
style(9): Some additional clarification
...
Prompted by an email from bde@.
Reviewed by: emaste, imp (earlier version)
With input from: wblock
Sponsored by: Dell EMC Isilon
Differential Revision: https://reviews.freebsd.org/D7983
2016-10-06 01:52:00 +00:00
Warner Losh
8c3dc1fb05
Spell alphabetically correctly both in the commit message AND in the
...
actual man page. Sigh.
Submitted by: David A Bright and Pedro Giffuni
2016-09-20 15:14:33 +00:00
Warner Losh
19b7fe02c4
Document existing practice and be more clear about sys/foo.h files
...
being alphabetical with sys/param.h or sys/types.h being first. Expand
the example to hopefully make this (slightly) clearer.
Noticed by: cem@
2016-09-20 04:50:53 +00:00
Conrad Meyer
3f07044f5b
style.9: Add a small blurb about allowing bool
...
It was allowed before, but make it very explicit it is allowed now. And
prefer 'bool' to older types that were used for the same purpose -- int and
boolean_t.
Like with the C99 fixed-width types, use common sense when changing old
code.
No igor regressions.
Suggested by: bde <20151205031713.T3286@besplex.bde.org>
Reviewed by: glebius, davide, bapt (earlier versions)
Reviewed by: imp
Feedback from: julian
Sponsored by: EMC / Isilon Storage Division
Differential Revision: https://reviews.freebsd.org/D4384
2015-12-05 17:01:38 +00:00
Enji Cooper
6c4edcb26a
Bump .Dd
2015-11-22 23:16:15 +00:00
Enji Cooper
d1241b1501
Recommend cc -Wall instead of gcc -Wall
...
MFC after: 1 week
2015-11-22 23:15:44 +00:00
Warner Losh
abb14e5ded
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.
2015-07-06 20:10:47 +00:00
Warner Losh
196f0f2b53
Back out contested change until dispute is resolved. This proved to be
...
more contentious than I expected.
2015-06-19 21:30:45 +00:00
Warner Losh
c97426f4d7
Bump date.
...
Submitted by: Xin Li
2015-06-17 22:06:27 +00:00
Warner Losh
b6c9950099
Update style.9 to reflect consensus on developer's mailing list
...
allowing redundant braces.
Differential Revision: https://reviews.freebsd.org/D2842
2015-06-17 21:25:36 +00:00
Edward Tomasz Napierala
102f2f352f
Restore comment describing /* NOTREACHED */, updated to match reality.
2011-01-07 08:34:12 +00:00
Edward Tomasz Napierala
0b13dbc38b
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.
2011-01-06 08:33:48 +00:00
Ulrich Spörlein
0d9deed52c
mdoc: drop redundant .Pp and .LP calls
...
They have no effect when coming in pairs, or before .Bl/.Bd
2010-10-08 12:40:16 +00:00
Colin Percival
bb48785424
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.
2010-06-27 02:30:19 +00:00
Dag-Erling Smørgrav
a1432b4c99
Boot out <sysexits.h> once and for all.
...
MFC after: 1 week
2008-12-17 13:01:19 +00:00
Robert Watson
3c8d4fc09b
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
2008-11-27 08:42:58 +00:00
Robert Watson
c2911a7ac0
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
2008-10-31 14:47:15 +00:00
Daniel Gerzo
6b527d112c
Back-out my previous change. See the thread at
...
http://lists.freebsd.org/pipermail/cvs-all/2008-July/263779.html
2008-07-10 11:24:41 +00:00
Daniel Gerzo
1249a78860
- nested functions are a GCC extensions and should not be used
...
Submitted by: gahr
MFC after: 3 days
2008-07-09 14:04:28 +00:00
David E. O'Brien
16ea8822d9
Add to the history section.
2008-01-27 03:58:22 +00:00
Greg Lehey
efcb0d7834
"redacted" replaced for clarity.
2008-01-05 21:39:21 +00:00
Joel Dahl
9eca1342f5
Line break before "All rights reserved" in the license example.
...
Reveiwed by: bde, rwatson
2007-01-28 20:51:04 +00:00
David E. O'Brien
861ed04477
Clarify case body indention.
2006-11-26 21:22:49 +00:00
Hiten Pandya
571dba6ec9
Use 'manual page' instead of 'man page' for consistency.
...
Approved by: re (hrs)
2005-06-28 20:15:19 +00:00
David E. O'Brien
6ffd2f532c
Clarify the header.
2005-05-17 15:03:50 +00:00
Ruslan Ermilov
580325d4cf
Recover the original Berkeley RCS id, and fix the description of
...
format for source files when it comes to $FreeBSD$.
2005-05-17 14:20:42 +00:00
Giorgos Keramidas
b31dd0b724
Remove a duplicate 'comment' to fix the syntax of a sentence.
2005-05-17 01:25:57 +00:00
Ruslan Ermilov
6b806d21d1
Fixed the misplaced $FreeBSD$.
2005-02-09 18:07:17 +00:00
Ruslan Ermilov
7d64886df5
Add a few colons.
...
Submitted by: Joel Dahl
2005-01-26 20:50:52 +00:00
Ruslan Ermilov
6b13dcc062
Nits.
2005-01-13 09:33:06 +00:00
Giorgos Keramidas
4b928b1d1f
Fix typos and add .Pp after the end of a display to separate the
...
displayed text from the paragraph right after it.
2005-01-09 22:49:24 +00:00
Warner Losh
da52f590b5
Clarify /*- convention.
2005-01-05 21:27:01 +00:00
Warner Losh
56c7363ae8
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.
2005-01-05 19:16:01 +00:00
Diomidis Spinellis
7078127540
Clarify the structure element size ordering.
...
Obtained from: OpenBSD style.9 1.38
2004-12-02 23:20:17 +00:00
Ruslan Ermilov
5203edcdc5
Mechanically kill hard sentence breaks and double whitespaces.
2004-07-03 18:29:24 +00:00
Bruce Evans
00ff1f7c0a
Fixed a style bug in the previous commit.
2004-06-26 09:02:44 +00:00
David E. O'Brien
7549cb8489
Embellish the getopt(3) example with mixed case.
...
Reviewed by: bde
2004-06-26 05:15:00 +00:00
Ruslan Ermilov
bf7f20c2b6
Assorted markup, spelling, and grammar fixes.
2004-06-16 08:33:57 +00:00
Lukas Ertl
63b3701deb
What world have we come to when even style(9) isn't unfailable:
...
correct style nit in an example.
2004-06-13 21:24:56 +00:00
Tony Finch
f004a9739c
Better English usage.
...
Submitted by: wollman
2003-11-12 10:53:52 +00:00