Commit Graph

353 Commits

Author SHA1 Message Date
Mark Murray
dfea8241e6 Grammar police; make the English style more consistent throughout,
and give suser_xxx some more airtime.
2000-08-16 19:52:03 +00:00
Mark Murray
38bd736e76 Grammar police; "has been written by" --> "was written by". 2000-08-15 15:23:46 +00:00
Mark Murray
4fea914dda Improve the cross-references. 2000-08-15 15:14:13 +00:00
Mark Murray
3e36b6ef41 Fix grammar and a function name. 2000-08-15 15:09:13 +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
Mark Murray
1e42415db0 Remove references to the (removed) kern.timecounter.method sysctl. 2000-07-23 11:12:59 +00:00
Sheldon Hearn
785c4f1a3d Clean up this new manual page. This delta includes content and
whitespace changes, which should not be a problem because this
is only the second revision of the file and translators are
unlikely to have gotten started yet.

Reviewed by:	abial
2000-07-19 06:33:34 +00:00
Ben Smithurst
dff9235e4a Define what is meant by brackets' and braces'.
Suggested by:	grog
2000-07-18 14:41:01 +00:00
Sheldon Hearn
9400b2896e Order the cross-references in the SEE ALSO section correctly. 2000-07-18 13:03:09 +00:00
Sheldon Hearn
3ae5a45440 Clean up this new manual page. This delta includes content and
whitespace changes, which should not be a problem because this
is only the second revision of the file and translators are
unlikely to have gotten started yet.

Reviewed by:	abial
2000-07-18 07:46:14 +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
Ben Smithurst
3fd5156000 "VFS entry point" -> "entry point", to be consistent with other VOP_*(9)
manual pages.

PR:		18593
Submitted by:	Anatoly Vorobey <mellon@pobox.com>
2000-07-15 22:28:16 +00:00
Andrzej Bialecki
bd3cdc3105 These patches implement dynamic sysctls. It's possible now to add
and remove sysctl oids at will during runtime - they don't rely on
linker sets. Also, the node oids can be referenced by more than
one kernel user, which means that it's possible to create partially
overlapping trees.

Add sysctl contexts to help programmers manage multiple dynamic
oids in convenient way.

Please see the manpages for detailed discussion, and example module
for typical use.

This work is based on ideas and code snippets coming from many
people, among them:  Arun Sharma, Jonathan Lemon, Doug Rabson,
Brian Feldman, Kelly Yancey, Poul-Henning Kamp and others. I'd like
to specially thank Brian Feldman for detailed review and style
fixes.

PR:		kern/16928
Reviewed by:	dfr, green, phk
2000-07-15 10:26:04 +00:00
Jeroen Ruigrok van der Werven
7bca8b217f Install accept_filter.9
Forgotten by:	alfred
2000-07-11 13:50:04 +00:00
Alfred Perlstein
ad9bccc5f7 attrib properly.
Pointed out by: asmodai
2000-07-10 19:20:08 +00:00
Alfred Perlstein
fb567cd9eb Document the kernel interface for accept filters.
Thanks to sheldonh for cleaning up the rough initial manpage.
2000-07-10 17:23:53 +00:00
Nick Hibma
fd473ea108 Correct the text for the return value.
Submitted by:	phk
2000-07-04 12:45:56 +00:00
Alexander Langer
aa3524dbd4 mdoc style cleanup: newline for new sentence.
Submitted by:	sheldonh
2000-06-20 15:05:06 +00:00
Alexander Langer
8f8b4df79a Fix typo (accessable --> accessible) and add period.
PR:		18588
Submitted by:	Anatoly Vorobey <mellon@pobox.com>
Reviewed by:	asmodai
2000-06-14 17:53:11 +00:00
Alexander Langer
505f2a7ecf Document possible values for the waitfor arg.
PR:		18627, 18628
Reviewed by:	asmodai
2000-06-12 13:53:04 +00:00
Alexander Langer
dc661e78a8 Remove XXX: Describe if_init().
Reviewed by:	asmodai
2000-06-10 10:23:06 +00:00
Alexander Langer
9092a4bca7 Add bus_alloc_resource.9 and bus_release_resource.9.
bus_release_resource.9 contains a paragraph obtained from a mail
by Warner Losh <imp@FreeBSD.org> to myself.

Reviewed by:	asmodai, hoek;  in parts by msmith, mdodd and imp
2000-06-08 21:00:12 +00:00
Jeroen Ruigrok van der Werven
7603b950ef VFS_CHECKEXP.9:
Fix typo.
	Fix description.

VFS_FHTOVP.9:
	Fix order in which the manpage says the calls should be made.

PR:		18590
Submitted by:	Anatoly Vorobey <mellon@pobox.com>
2000-06-04 15:31:12 +00:00
Doug Rabson
823234556f Add documentation for taskqueue apis. 2000-05-28 16:53:50 +00:00
Tim Vanderhoek
bca1f3c245 The LOCKPARENT flag is singular. It doesn't work causing complications
is also a singular fact.
2000-05-21 03:23:10 +00:00
Chris Costello
878f9ca614 Replace a manual.section file reference with a proper mdoc(7) .Xr
reference.

PR:		18625
Submitted by:	Alexander Langer <alex@cichlids.com>
2000-05-18 00:20:55 +00:00
Paul Richards
1c7d91744e Correct duplicate use of word "been" in a sentence. 2000-05-12 15:31:54 +00:00
Bruce Evans
1c171d7474 Abuse .Fn for macros better (don't hand-format the parameter string by
quoting it all and adding commas).

Don't say that the expression in KASSERT() is an int.  It is a collection
of tokens forming a C expression that can be compared with 0.
2000-05-11 16:54:52 +00:00
Bruce Evans
7925aadbe5 Removed bogus quoting of single tokens in a .Fn invocation. This helps
my synopsis checker decide which .Fn's are for prototypes (most function
parameters require quoting because they have multiple tokens).
2000-05-11 16:39:33 +00:00
Bruce Evans
b1f2329c99 Fixed bitrot. The changes from buf to bio had not reached here. 2000-05-11 16:25:03 +00:00
Darren Reed
08aa4ea3b8 patch from Alexey Zelkin 2000-05-11 00:44:35 +00:00
Darren Reed
e9c7bebf95 Add pfil(9) subroutines and manpage from NetBSD. 2000-05-10 13:37:51 +00:00
Sheldon Hearn
0f5fcaa3f1 Supply only one author name per instance of %A, as per mdoc.samples(7).
PR:		18465
Submitted by:	Kazu TAKAMUNE <takamune@avrl.mei.co.jp>
2000-05-10 09:49:04 +00:00
Tim Vanderhoek
b17407bbe3 Small grammar gnit. 2000-05-09 20:35:13 +00:00
Mike Pritchard
b68d89eb4c Spelling fix: despatching -> dispatching. This makes the
spelling consistent throughout the man page.

PR:		docs/18467
Submitted by:	Alexander N. Kabaev <ak03@gte.com>
2000-05-09 18:52:26 +00:00
Mike Pritchard
9dca1aebb4 Correct a patch name and use the correct macro for displaying it.
PR:		docs/18468
Submitted by:	Anatoly Vorobey <mellon@pobox.com>
2000-05-09 18:44:34 +00:00
Matthew Hunt
0486ee6f1f Correct "it's" to "its".
PR:		18469
Submitted by:	Anatoly Vorobey <mellon@pobox.com>
2000-05-09 18:08:52 +00:00
Sheldon Hearn
f167d7fb3e Fix miscellaneous mdoc macro argument limit infringements.
PR:		18465
Reported by:	Kazu TAKAMUNE <takamune@avrl.mei.co.jp>
2000-05-09 14:02:06 +00:00
Garrett Wollman
5d5e482682 Add punctuation to make a sentence more readable. 2000-04-25 16:40:57 +00:00
Brian Feldman
2b191cdcc1 Poul-Henning's changes necessitate s/bp->b_flags/bp->b_io/bio_cmd/. 2000-04-21 01:19:53 +00:00
Brian Feldman
447bb3d818 s/of possible/if possible/ 2000-04-21 01:14:33 +00:00
Chris Costello
5135e05024 Add a .Pp between the forklist_fn typedef and the at_fork prototype. 2000-04-19 02:43:04 +00:00
Chris Costello
72090231ad Replace a literal vertical space with a .Pp macro. 2000-04-19 02:42:11 +00:00
Chris Costello
98914f5e46 Fill in a missing word (`it'). 2000-04-19 02:32:41 +00:00
Doug Rabson
4bfe86c042 Use the existing Fx macros for rendering "FreeBSD ver".
Submitted by: Sheldon Hearn <sheldonh@uunet.co.za>
2000-04-10 08:21:16 +00:00
Doug Rabson
c685012659 Add manpage for kernel object system. 2000-04-08 13:24:40 +00:00
Chris Costello
2b66e5a322 - Add HPFS and NWFS vnode tags.
- Update ``struct vnode'' changes from revisions 1.91, 1.94, 1.98, 1.101,
  1.102.

Reviewed by:	alfred
2000-04-02 23:53:57 +00:00
Jeroen Ruigrok van der Werven
42a3fc35e6 Add and install BUS_SETUP_INTR.9.
This effectively replaces BUS_CREATE_INTR.9 and BUS_CONNECT_INTR.9.

Reviewed by:	n_hibma
2000-04-02 12:00:52 +00:00
Jeroen Ruigrok van der Werven
03be717064 Get rid of the manpages for BUS_CREATE_INTR() and BUS_CONNECT_INTR().
These got replaced by BUS_SETUP_INTR().

This once again illustrates an API change without informing -doc, so
that these sort post cleanup actions could've been avoided.

And then people wonder why the docs suck so much at times.

Reviewed by:	peter
2000-04-02 09:25:15 +00:00
Jeroen Ruigrok van der Werven
b25cda8a80 Remove spurious .Fc which caused this manpage to be closed
prematurely.
2000-04-01 20:31:07 +00:00
Mike Pritchard
d905b0b639 Minor style fixes: freebsd.org -> FreeBSD.org 2000-03-24 01:49:46 +00:00
Bruce Evans
25435b71b6 Fixed bitrot in synopsis (the third arg of vsunlock went away). 2000-03-23 14:33:14 +00:00
Jeroen Ruigrok van der Werven
8abb3721a5 Remove trailing comma. 2000-03-21 17:34:56 +00:00
Jeroen Ruigrok van der Werven
5cba0139b0 As bde was kind to point out:
"Man pages shouldn't refer to higher level interfaces
built using the interfaces in the man pages."

Submitted by:	bde
2000-03-21 16:38:19 +00:00
Jeroen Ruigrok van der Werven
dc027c46a6 Fix lameness I introduced by typing the Xr as a filename, sigh. 2000-03-21 13:46:57 +00:00
Jeroen Ruigrok van der Werven
25216c5cfb Fix EXAMPLE -> EXAMPLES.
Add Xr's for SPLASSERT and CONDSPLASSERT.
2000-03-21 13:21:36 +00:00
Jeroen Ruigrok van der Werven
eb2630afaf Assorted bag o' fixes:
fix Jonathan's name, fix copyright date, man -> manual,
	add const before char *msg, add email address.
2000-03-21 13:18:40 +00:00
Bruce Evans
084f33c228 Actually install KASSERT.9. 2000-03-20 20:23:43 +00:00
Brian Feldman
7e1a7176c3 Both:
Get rid of the "char *" before level which made no sense.  Change
  "char *msg" to the properly const-unpoisoned one.

Just SPLASSERT.9:
  Add an Xref to CONDSPLASSERT(9).  Change the function name "rtredirect"
  to the correct "rtalloc".
2000-03-20 14:44:42 +00:00
Jeroen Ruigrok van der Werven
30280e3601 Fix some mdoc nits.
.Fd - > .Cd
EXAMPLE - > EXAMPLES
man page -> manual page

Submitted by:	large part by sheldonh
2000-03-20 12:29:59 +00:00
Jeroen Ruigrok van der Werven
338c4376cf Fix typo. 2000-03-19 16:52:59 +00:00
Jeroen Ruigrok van der Werven
cd8b737d3c Trim trailing whitespace. 2000-03-19 15:55:38 +00:00
Jeroen Ruigrok van der Werven
6a6a8532b0 Document the sysctl knob for setting the severity of the SPLASSERT
macros.

Reviewed by:	ps
2000-03-19 15:47:33 +00:00
Jeroen Ruigrok van der Werven
0a8c1cdc73 Spell Jonathan's name correctly in the copyright. Which is funny,
considering the fact he wrote it himself. =)

Also add his email address in the AUTHORS section.
2000-03-19 14:46:56 +00:00
Jeroen Ruigrok van der Werven
2e6b4dc303 Add the manpage for CONDSPLASSERT().
This was based upon the manpage written by jmb for SPLASSERT().
2000-03-19 14:43:03 +00:00
Jeroen Ruigrok van der Werven
5eca43faa9 After about two months I am the first to notice that SPLASERT.9 never
got installed.

Also, correct the copyright to a more realistic date (1996->2000).
Fix some wordings and omissions.
2000-03-18 21:51:16 +00:00
Chris Costello
bd79f8422f Be consistent with struct vattr' naming. Half of this manual used vpp'
while the other half used `vap', and in one case resulted in code that
made no sense.  Replaced all of them with `vap'.

(Typically, `vpp' is a pointer to a pointer to a struct vnode anyway).
2000-03-16 22:40:38 +00:00
Sheldon Hearn
1111b49c35 Remove single-space hard sentence breaks. These degrade the quality
of the typeset output, tend to make diffs harder to read and provide
bad examples for new-comers to mdoc.
2000-03-03 14:05:08 +00:00
Sheldon Hearn
4e86fcacf6 Remove more single-space hard sentence breaks. 2000-03-02 14:54:02 +00:00
Jason Evans
9102cbc957 Fix a typo (simple --> simply). 2000-02-16 22:45:51 +00:00
Robert Watson
ca7d2b82e1 Fix man page structures/constants to match recent changes in acl.h
Fix a few more namespace messes and whitespace curiosities in acl.h
Fix comments in acl.h
Clean up some function prototypes from acl.h that won't be committed
    before the code freeze.

Some of this kindly pointed out by: the ever patient bde
2000-01-28 15:22:51 +00:00
Jonathan M. Bresler
c5395b92eb Add SPLASSERT.9 man page. SPLASSERT() commit to follow immediately.
Approved by: jkh
2000-01-16 02:08:37 +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
Jonathan M. Bresler
6fc639dcd1 Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00
Alexey Zelkin
ae5ccfad91 Add new manpages for:
microtime(9)
	nanotime(9)
	getmicrotime(9)
	getnanotime(9)
	microuptime(9)
	nanouptime(9)
	getmicrouptime(9)
	getnanouptime(9)
	tvtohz(9)

Based on PR:	docs/15889
Submitted by:	Kelly Yancey <kbyanc@posi.net>
2000-01-07 12:42:59 +00:00
Alexey Zelkin
db7b63631a Place #include's and $NetBSD$ tag to appropriate places. 2000-01-07 12:14:55 +00:00
Robert Watson
32900e82f3 Man pages for the VFS extended attribute and access control list vnops.
Reviewed by:	eivind
2000-01-05 04:59:02 +00:00
Bruce Evans
20c4d417bc Fixed some bugs (one serious one: timeouts were claimed to be executed at
spl0) and some bitrot (the not-so-new callout_init/stop/reset functions
were not mentioned; the callout_activate/deactivate/pending macros are
still not mentioned).

Submitted by:	mostly by jlemon
1999-12-27 16:22:20 +00:00
Bruce Evans
c1ab0cfd47 Fixed bitrot in synopsis. The prototype for panic() was moved to
<sys/param.h>, but the #includes weren't adjusted here.
1999-12-23 17:42:10 +00:00
Bruce Evans
31f698b8ca Fixed wrong function types (the device_add_child() family returns a
device_t, not an int).
1999-12-23 17:39:45 +00:00
Bruce Evans
9961a6adff Removed unused include of <sys/buf.h> from synopsis. This include is
needed to access the internals of buffers but not necessarily to use
the VOP.  <sys/buf.h> recently grew a bogus dependency on <sys/systm.h>
for the declaration of spl*, and I prefer to fix the synopsis breakage
by removing a wart instead of adding one.
1999-12-23 17:35:48 +00:00
Bruce Evans
6ee16659ac Fixed bitrot in synopsis. The prototype for VOP_ISLOCKED() changed
recently, except of course in the documentation.  Other parts of this
man page are several years out of date.
1999-12-23 17:28:46 +00:00
Bruce Evans
f644d0654b Fixed missing #includes in synopsis. 1999-12-23 17:24:40 +00:00
Bruce Evans
5770fb1361 Fixed bitrot in synopsis. Important interface changes hadn't reached here. 1999-12-23 17:22:58 +00:00
Bruce Evans
bd00dbfafc "Fixed" assorted bitrot. remove_dev() was renamed to destroy_dev().
VOP_ABORTOP() went away.  at_shutdown() was replaced by undocumented
event handling.  Rename remove_dev() here too, and remove the dead
and dead wrong man pages.
1999-12-23 17:16:32 +00:00
Eivind Eklund
4dc39f110c Correct the documentation of LOCKPARENT - it does not reliably result in the
parent being locked, but rather plays some hide and seek (does not lock if
dvp == vp).

Also add a BUGS section noting that this is undesired behaviour.
1999-12-18 20:50:48 +00:00
Eivind Eklund
9a8fa3c19f Document NDFREE w/flags, and fix up the description of NOFOLLOW. 1999-12-16 23:20:11 +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
Alfred Perlstein
1e12157c61 explain that ioflags can be used to give read-ahead hints to the underlying
filesystem.
1999-12-13 02:28:53 +00:00
Kenneth D. Merry
86b2c8466d Revamp the devstat priority system. All disks now have the same priority.
The same goes for CD drivers and tape drivers.  In systems with mixed IDE
and SCSI, devices in the same priority class will be sorted in attach
order.

Also, the 'CCD' priority is now the 'ARRAY' priority, and a number of
drivers have been modified to use that priority.

This includes the necessary changes to all drivers, except the ATA drivers.
Soren will modify those separately.

This does not include and does not require any change in the devstat
version number, since no known userland applications use the priority
enumerations.

Reviewed by:	msmith, sos, phk, jlemon, mjacob, bde
1999-12-08 04:45:23 +00:00
Matthew N. Dodd
238ebf9958 Remove mention of 'ivars'. 1999-12-03 11:22:28 +00:00
Nick Hibma
fa930a7361 Add the device_get_children(9) man page. 1999-12-02 16:34:09 +00:00
Nick Hibma
2d876113a8 It's device_add_child*, not bus_add_child*. 1999-12-02 16:31:12 +00:00
John Polstra
907b750c0c The rt_refcnt member is a long now. 1999-11-22 04:26:00 +00:00
Poul-Henning Kamp
93efcae809 The at_exit and at_fork functions currently use a 'roll your own'
linked list to store the callbak routines.  The patch converts the
lists to queue(3) TAILQs, making the code slightly clearer and ensuring
that callbacks are executed in FIFO order.

Man page also updated as necesary.

(discontinued use of M_TEMP malloc type while here anyway /phk)

Submitted by:   Jake Burkholder jake@checker.org
PR:             14912
1999-11-19 21:29:03 +00:00
Eivind Eklund
b04b572b08 Document changed calling conventions (lost WILLRELE) for VOP_MKNOD and
VOP_SYMLINK.
1999-11-13 21:00:26 +00:00
Joerg Wunsch
93c6e868e8 Move the description of the traditional sleep() form out into the history
section, we no longer have it.

Fix mdoc style violations caused by a previous committer.
1999-11-03 10:39:54 +00:00
Alexey Zelkin
e1e5fdf6d4 mdoc(7)'fy 1999-10-30 15:12:25 +00:00
Alexey Zelkin
a169de1e31 mdoc(7)'fy, fix broken FreeBSD release number (3.0.1 -> 3.1) 1999-10-30 14:15:49 +00:00