d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
62,716 Commits 6 Branches 133 Tags
Commit Graph

58 Commits

Author SHA1 Message Date
Dima Dorfman
3b08168907 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.
 2001-07-22 11:47:15 +00:00
Dima Dorfman
ebb02791f2 Add: ``If you have to wrap a long statement, put the operator at the 
end of the line.''

Reviewed by:	alfred, bde
 2001-07-22 10:35:02 +00:00
David E. O'Brien
16a7ef9327 State explicitly how the manpage "DESCRIPTION" options should be listed. 2001-07-19 18:03:43 +00:00
Jens Schweikhardt
c1f3e4bf21 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
 2001-07-14 19:41:16 +00:00
Ruslan Ermilov
3d45e180f4 mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00
Joerg Wunsch
72fb076dce Don't give a bad example by starting a struct tag name with an 
underscore.  Names starting with an underscore are reserved.
 2001-07-03 16:22:42 +00:00
Dima Dorfman
c91ed2eb6c Correct getopt usage and a syntax error (period used instead of a semicolon). 2001-06-18 20:36:06 +00:00
David E. O'Brien
19d4c7b3d7 Back out rev 1.50. VCS was correct -- it is Version Control System. 2001-05-17 02:05:36 +00:00
Doug Barton
6c7344c5dd Minor typos 2001-05-17 01:36:01 +00:00
David E. O'Brien
d6eb63ec62 Reduce the number of $FreeBSD$'s from 3 to 2. I believe both remaining 
are needed for proper examples.
 2001-04-25 20:58:28 +00:00
David E. O'Brien
58eac5ef6a Address $FreeBSD$ and `rcsid'. 2001-04-22 02:32:42 +00:00
David E. O'Brien
1076a975f5 Fix prototype wrap example and note how to wrap ANSI-style function 
definitions.
 2001-04-22 02:00:39 +00:00
Ruslan Ermilov
eb0838029f mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00
Ben Smithurst
31e230ad42 Expand 
if ((foo = bar()) != 0)

to
	foo = bar();
	if (foo != 0)

Submitted by:	phk
 2001-02-21 20:43:55 +00:00
Ben Smithurst
06c8ab0c3c 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)
 2001-02-21 12:10:19 +00:00
Nik Clayton
4444ad36bf 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
 2001-02-02 03:11:22 +00:00
Ruslan Ermilov
d0353b836e mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00
Ruslan Ermilov
3136363f3e Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00
Ruslan Ermilov
b5c508fba3 Use Fx macro wherever possible. 2000-11-14 11:20:58 +00:00
David Malone
9704bfcdfb Change a "xlint(1)" to a ".Xr lint 1" and add a reference in the see also 
section.
 2000-11-13 16:18:46 +00:00
Alexander Langer
b7f4c6bf0e Use EX_USAGE in an example, as the SAME manual page describes a 
few lines higher.

PR:		22371
Submitted by:	andrew@ugh.net.au
 2000-10-28 10:02:23 +00:00
Sheldon Hearn
f0cddd5353 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
 2000-08-08 09:54:57 +00:00
Ben Smithurst
dff9235e4a Define what is meant by brackets' and braces'. 
Suggested by:	grog
 2000-07-18 14:41:01 +00:00
Ben Smithurst
de9bd90aa8 Remove some whitespace so the line with "brackets" changed to "angle 
brackets" no longer touches the right edge of an 80 column display.
 2000-07-17 19:05:57 +00:00
Ben Smithurst
044e09a0a8 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
 2000-07-16 20:46:43 +00:00
Jeroen Ruigrok van der Werven
338c4376cf Fix typo. 2000-03-19 16:52:59 +00:00
Peter Wemm
3c2c970655 Don't mix up KNF and style(9). This isn't KNF, it's a derivative of it. 2000-01-15 16:34:07 +00:00
David E. O'Brien
b7c42f7dde * 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.
 1999-12-16 10:02:20 +00:00
Chris Piazza
20d8fa6f36 Revert previous change, I misread it as an if( when it really 
wasn't.
 1999-10-10 09:28:14 +00:00
Chris Piazza
133dba33b6 Add the missing ')' in 
(p = f()) == NULL
 1999-10-09 23:12:57 +00:00
Peter Wemm
7f3dea244c $Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00
Tim Vanderhoek
0983f2b022 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.
 1999-08-02 04:00:33 +00:00
Tim Vanderhoek
4ac29fd62e 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.
 1999-08-02 03:18:17 +00:00
Tim Vanderhoek
b787fc933a Use errx() instead of err() in example code calling err() after strtol(). 1999-07-31 15:04:37 +00:00
Mike Pritchard
5d70612b3f Fix some typos and do some minor mdoc cleanup. 1999-06-27 02:38:46 +00:00
Julian Elischer
2755f9f602 Slightly relax the requirements fro removing extra braces and parenthesis. 
Objected to by: bde
 1999-01-30 04:17:14 +00:00
Garrett Wollman
a873f07c1c oops, remove a dangling predicate left over after a sentence was rewritten. 1997-12-07 20:25:45 +00:00
Garrett Wollman
25a5737a0f Add some more macro advice and correct spelling of ``parentheses''. 1997-12-07 20:19:20 +00:00
Garrett Wollman
c9c42d0aa7 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.
 1997-12-07 19:53:44 +00:00
David E. O'Brien
d927c2c392 state that "kernel includes" ==> sys/*.h 1997-11-12 06:29:10 +00:00
Peter Wemm
122c2021d3 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
 1997-05-27 10:00:08 +00:00
Mike Pritchard
405eecfbb1 Check for -1 instead of EOF in the getopt() example. 
Submitted by:	Kent Vander Velden
 1997-04-09 19:03:14 +00:00
Mike Pritchard
dd5527c607 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.
 1997-03-21 20:14:15 +00:00
Peter Wemm
e25aeca937 Revert $FreeBSD$ back to $Id$ 1997-02-22 13:26:29 +00:00
Jordan K. Hubbard
1130b656e5 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.
 1997-01-14 07:20:47 +00:00
Wolfram Schneider
0b992c1d66 Sort cross references. 1996-12-26 16:16:37 +00:00
Mike Pritchard
aab5e1b6d0 Minor formatting/style fixes. 
Submitted by:	Sandro Sigala <sandro@cat.local.net> as part of PR # 2134
 1996-12-09 07:45:59 +00:00
Wolfram Schneider
f31078c2f7 bring back ``case '?':'' in switch statement 1996-08-24 10:49:09 +00:00
Wolfram Schneider
7416827fb1 add copyright, $Id$ 
remove case '?', if '?' is not in getopt(), it should
not be in the switch statement
 1996-08-22 16:55:15 +00:00
Bruce Evans
0ba27adc20 Restored most of suggestion about using NULL, even though wollman 
disagrees with it personally :-), and fixed the misleading parts.
 1996-07-17 12:32:18 +00:00