Commit Graph

513 Commits

Author SHA1 Message Date
Ruslan Ermilov
b92a189eb9 mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:11:48 +00:00
Ruslan Ermilov
ea3d1f093f mdoc(7) police: add the missing and required .Dd macro call. 2000-11-22 13:31:01 +00:00
Ruslan Ermilov
f4d874a1db mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00
Ruslan Ermilov
ae9fd6288c mdoc(7) police: minor cleanup. 2000-11-22 08:19:15 +00:00
Alfred Perlstein
a0ae47cd48 Install DELAY(9). 2000-11-22 03:44:55 +00:00
Alfred Perlstein
0b0d531efb Document the DELAY() function. 2000-11-22 03:38:32 +00:00
Bosko Milekic
5d4050cc5d Add description of M_WRITABLE macro and new M_RDONLY flag. Try my best to
conform to line break mdoc FreeBSD standards, although I am new to this.

Reviewed by: sheldonh
2000-11-21 22:29:31 +00:00
Mark Murray
a28724c2c2 Add new man page to the mix. 2000-11-21 20:31:51 +00:00
Mark Murray
6323c703f7 Whitespace-only change. Tidy up, alphabetise and wrap. 2000-11-21 20:28:48 +00:00
Mark Murray
5855006767 Add a consistent API to a feature that most modern CPUs have; a fast
counter register in-CPU.

This is to be used as a fast "timer", where linearity is more important
than time, and multiple lines in the linearity caused by multiple CPUs
in an SMP machine is not a problem.

This adds no code whatsoever to the FreeBSD kernel until it is actually
used, and then as a single-instruction inline routine (except for the
80386 and 80486 where it is some more inline code around nanotime(9).

Reviewed by:	bde, kris, jhb
2000-11-21 19:55:21 +00:00
Ruslan Ermilov
4b66483fd8 mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00
Ben Smithurst
d641426e5a Fix typo.
PR:		22923
Submitted by:	Jimmy Olgeni <olgeni@uli.it>
2000-11-18 20:19:26 +00:00
Ben Smithurst
7a41bbd47b Fix another typo.
PR:		22924
Submitted by:	Jimmy Olgeni <olgeni@uli.it>
2000-11-18 20:16:47 +00:00
Ruslan Ermilov
218d216271 mdoc(7) police: eliminate warnings. 2000-11-17 15:40:57 +00:00
Ben Smithurst
0381c6e5ba Fix typos.
PR:		22901, 22902
Submitted by:	Jimmy Olgeni <olgeni@uli.it>
2000-11-17 09:16:29 +00:00
Alfred Perlstein
a984db451a install/build accf_* manpages 2000-11-16 00:57:52 +00:00
Alfred Perlstein
16fb0774c2 Xref accf_http and accf_data 2000-11-15 22:54:06 +00:00
Alfred Perlstein
9d6bbf9b1e Document the accf_data accept filter: "dataready" 2000-11-15 22:53:02 +00:00
Alfred Perlstein
9d3a32814d Document the accf_http accept filter "httpready". 2000-11-15 22:46:21 +00:00
Ben Smithurst
6fe89339b9 remove fullstops from the end of .Xr lines in SEE ALSO sections. 2000-11-15 16:00:07 +00:00
Ben Smithurst
b02eeb5c33 Add a newline character at the end of this file, it was missing which
resulted in ugly errors from 'diff'.
2000-11-15 13:34:41 +00:00
Ruslan Ermilov
b5c508fba3 Use Fx macro wherever possible. 2000-11-14 11:20:58 +00:00
John Baldwin
ab7e1991c0 Beef up the description of the kernel thread API.
Reviewed by:	sheldonh, jasone
2000-11-13 20:34:20 +00:00
John Baldwin
dc4e9f1a03 Describe the new software interrupt thread functionality.
Reviewed by:	sheldonh, jasone
2000-11-13 20:18:42 +00:00
John Baldwin
eaca618337 Add a manpage to document the atomic operations including a quick treatment
of memory barriers and the newish atomic variants that include them.

Reviewed by:	sheldonh
2000-11-13 20:08:17 +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
Sheldon Hearn
6cfaa4a7de Sort NAMES section and separate Nm arguments from trailing punctuation. 2000-11-13 13:12:44 +00:00
Ruslan Ermilov
726b61ab5f Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00
Sheldon Hearn
25f1a2e9f9 Miscellaneous content fixes:
* xref sysctl
* do not mark kern.ipc.mbuf_wait up as a function argument.
* do not mix case of function argument names
* a mbuf -> an mbuf
* if -> whether
* typos
2000-11-10 10:22:49 +00:00
Sheldon Hearn
e73145f651 Whitespace only: fix hard sentence breaks now, before people really
get stuck into this page.
2000-11-10 10:08:34 +00:00
John Baldwin
c5f3b30e68 Replace non-existent 'mtx_t' typedef'd type with 'struct mtx'. 2000-11-10 01:51:55 +00:00
Bosko Milekic
bfd597212a Fixup some wrong statements in the new mbuf(9) man page.
Also introduce a bunch of (missed?) macros and functions.
This man page still needs a lot of work, most likely a re-ordering
of the macros/functions, and a more complete, more accurate, listing of
available routines.
A good and worthy start nonetheless.
2000-11-01 23:02:19 +00:00
John Baldwin
7e56ee52c8 Catch up to mutexes becoming MI: machine/mutex.h -> sys/mutex.h 2000-11-01 00:39:27 +00:00
Jeroen Ruigrok van der Werven
29c9277956 Fix a fundamental error. The device is not owned by the parent
bus before allocation.  The resource is.

Asked about by:	julian on -current
Verified by:	msmith
2000-10-31 13:16:47 +00:00
Sheldon Hearn
6296795713 Whitespace only:
* Remove hard sentence breaks.
 * Remove trailing whitespace.
 * Separate macro arguments from trailing punctuation with whitespace.
2000-10-30 19:49:26 +00:00
Ruslan Ermilov
dc5a40409d Add pfil.9 manpage to build after a repository copy. 2000-10-30 09:16:18 +00:00
Poul-Henning Kamp
cf9fa8e725 Move suser() and suser_xxx() prototypes and a related #define from
<sys/proc.h> to <sys/systm.h>.

Correctly document the #includes needed in the manpage.

Add one now needed #include of <sys/systm.h>.
Remove the consequent 48 unused #includes of <sys/proc.h>.
2000-10-29 16:06:56 +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
Mike Pritchard
096ed6644a Typo fix. 2000-10-27 20:55:15 +00:00
Jeroen Ruigrok van der Werven
e87b9f2824 Use FreeBSD.org, not freebsd.org, as has been the precedent. 2000-10-27 16:05:39 +00:00
John Baldwin
7dbdc1bff4 Add in MLINKS for all of the various mutex functions to mutex.9 2000-10-26 23:54:10 +00:00
John Baldwin
2c3d0ee6f4 - Document MUTEX_DECLARE and MTX_COLD
- Clean up some minor nits
2000-10-26 23:53:12 +00:00
John Baldwin
26fdc7e05b Add a note that the spl() API is deprecated in favor of mutexes. 2000-10-26 23:30:01 +00:00
Nik Clayton
de06f907d1 Add a prototype mbuf.9 man page. Probably needs work, but it's a good
start.

PR:             docs/22053
Submitted by:   Yar Tikhiy <yar@comp.chem.msu.su>
2000-10-26 23:15:47 +00:00
Mark Murray
e5e600c900 Add some very crude man pages to try to induce folk to work on them.
Agreed to work on them:	jasone
2000-10-24 03:33:24 +00:00
Poul-Henning Kamp
1921a06d6a Introduce the M_ZERO flag to malloc(9)
Instead of:

        foo = malloc(sizeof(foo), M_WAIT);
        bzero(foo, sizeof(foo));

You can now (and please do) use:

        foo = malloc(sizeof(foo), M_WAIT | M_ZERO);

In the future this will enable us to do idle-time pre-zeroing of
malloc-space.
2000-10-20 17:54:55 +00:00
Mark Murray
67297998c8 Add a man page for part of the PRNG API. 2000-10-14 16:16:42 +00:00
Brian Somers
e6e7337683 Index: Makefile
===================================================================
RCS file: /home/ncvs/src/share/man/man9/Makefile,v
retrieving revision 1.75
diff -u -r1.75 Makefile
--- Makefile	2000/09/17 12:15:12	1.75
+++ Makefile	2000/10/06 23:24:26
@@ -69,6 +69,8 @@
 MLINKS+=make_dev.9 destroy_dev.9
 MLINKS+=malloc.9 FREE.9 malloc.9 MALLOC.9 malloc.9 free.9
 MLINKS+=mi_switch.9 cpu_switch.9
+MLINKS+=namei.9 NDINIT.9
+MLINKS+=namei.9 NDFREE.9
 MLINKS+=posix4.9 p1003_1b.9
 MLINKS+=psignal.9 gsignal.9 psignal.9 pgsignal.9
 MLINKS+=rtalloc.9 rtalloc1.9 rtalloc.9 rtalloc_ign.9
2000-10-06 23:29:11 +00:00
Paul Saab
e8af5965e2 Correct who pioneered the accept filters and Yahoo!'s company name. 2000-10-06 10:51:24 +00:00
Mark Murray
4f1249a812 Huge improvement to the mutex man page.
o Document all the mutex calls, not just the entry and exit.

o Fix the mtx_t typedef (now is struct mtx).
2000-09-25 11:21:49 +00:00
Mark Murray
16aa79c236 Remove references to the defunct kern.timecounter.method sysctl variable. 2000-09-25 11:18:51 +00:00
Robert Watson
28994ea06f o Bring VOP_GETACL(9) and VOP_GETEXTATTR(9) man page "LOCKS" sections in
sync with the implementation.  Vnode locks *are* required for these
  operations, as some underlying implementations will require them.

Obtained from:	TrustedBSD Project
2000-09-21 18:51:48 +00:00
Alexander Langer
77f3abec92 Reference DRIVER_MODULE.9 2000-09-17 12:20:08 +00:00
Alexander Langer
72f8c78baf Add DRIVER_MODULE.9, the manual page describing the kernel driver
declaration macro.
Thanks to Sheldon for a big patch with language/mdoc fixes.

Reviewed by:	asmodai, sheldonh
2000-09-17 12:15:12 +00:00
Poul-Henning Kamp
0aa16c1a77 Fix a cut&paste mistake. 2000-09-16 14:37:41 +00:00
Jake Burkholder
e66ccea4a1 Add scant documentation for msleep. 2000-09-11 00:52:31 +00:00
Jason Evans
0384fff8c5 Major update to the way synchronization is done in the kernel. Highlights
include:

* Mutual exclusion is used instead of spl*().  See mutex(9).  (Note: The
  alpha port is still in transition and currently uses both.)

* Per-CPU idle processes.

* Interrupts are run in their own separate kernel threads and can be
  preempted (i386 only).

Partially contributed by:	BSDi (BSD/OS)
Submissions by (at least):	cp, dfr, dillon, grog, jake, jhb, sheldonh
2000-09-07 01:33:02 +00:00
Doug Rabson
21c58b8d40 Document kobj_class_compile_static(). 2000-08-28 21:17:46 +00:00
Sheldon Hearn
a948e10a1c Clear extraneous arguments to the name (Nm) macro.
Mark PRISON_ROOT and EPERM as defined values (Dv).
2000-08-17 08:17:16 +00:00
Mark Murray
58ea82758e Mention more functions in the headers so whatis(1) can find them, and
create links to functions so added found.
2000-08-16 19:53:38 +00:00
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
Poul-Henning Kamp
02c58685a4 Change useracc() and kernacc() to use VM_PROT_{READ|WRITE|EXECUTE} for the
"rw" argument, rather than hijacking B_{READ|WRITE}.

Fix two bugs (physio & cam) resulting by the confusion caused by this.

Submitted by:   Tor.Egge@fast.no
Reviewed by:    alc, ken (partly)
1999-10-30 06:32:05 +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
Matthew Dillon
cc4a02e299 Bring kernel malloc documentation up to date, including the example.
PR:	docs/10059
1999-09-29 16:49:18 +00:00
Chris Costello
94b1839d20 Document the make_dev(9) and remove_dev(9) facilities.
remove_dev(9) is created as a link to the existing make_dev(9) page.

Reviewed by:	phk
1999-09-25 20:12:01 +00:00
Matthew Dillon
87b0140cdf mdoc style cleanup
Submitted by:	  Mike Pritchard <mpp@FreeBSD.ORG>
1999-09-25 17:21:21 +00:00
Chris Costello
2baad6b54c Remove a useless new line. 1999-09-25 16:11:09 +00:00
Chris Costello
2da64d5dd7 Document the devtoname(9) kernel interface. 1999-09-25 15:58:33 +00:00
Matthew Dillon
37af288330 More locking clarifications. Add skeleton manual page for VOP_LEASE 1999-09-24 17:11:02 +00:00
Matthew Dillon
fb3fd47611 More synchronization of the VOP documentation to the real world. 1999-09-24 13:58:55 +00:00
Matthew Dillon
bebac989cc More clarification of locking requirements. 1999-09-24 10:42:45 +00:00
Matthew Dillon
065aee8253 Bring more VOP manual pages up to date in regards to locking
requirements.
1999-09-24 10:19:43 +00:00
Matthew Dillon
fe11eb74af Update errors in documentation for various VOP_ calls. Specifically,
describe the correct locking state expected on entry and return.
1999-09-24 07:07:02 +00:00
Alexey Zelkin
0dc03e0114 Add to .Nm devstat_end_transaction_buf().
Do some ordering.

Noticed by: ken
1999-09-23 13:31:15 +00:00
Poul-Henning Kamp
04a2253821 Document the new free/erase transaction type.
Reminded about by:	ken
1999-09-22 20:27:21 +00:00
Alexey Zelkin
fe27e01fac Synchronization NAME section with SYNOPSIS. 1999-09-21 19:18:09 +00:00
Poul-Henning Kamp
bd9e52dcc4 document devstat_end_transaction_buf() 1999-09-18 21:31:19 +00:00
Ruslan Ermilov
c931dae17f Adjust descriptions for if_up() and if_down().
Reviewed by:	wollman
1999-09-14 01:05:40 +00:00
Doug Rabson
57129f42d5 Add new manpage device_set_flags.9 and add links for
device_set_desc_copy.9 and device_get_flags.9.
1999-09-12 16:01:11 +00:00
Alfred Perlstein
2f42dfd0a2 vnode -> mountpoint
reference vfs_check_export
change license to my own, (ok'd by dfr) and remove advert clause.
remove extra Id tags and emacs cruft, this should be a fresh file.
1999-09-11 21:00:03 +00:00
Chris Costello
7ad5ee3757 Add a link for uiomove.9 to uio.9 1999-09-11 15:39:31 +00:00
Alfred Perlstein
fb6d83aa60 Document VFS changes:
VFS_CHECKEXP.9, now used to check export credentials
VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done.
VFS.9, inform people of the vfs_std* functions available to avoid
       ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
Doug Rabson
b99b8460af Add device_set_desc_copy(9). 1999-09-06 15:13:09 +00:00
Alexey Zelkin
0d28dd1dc5 Replace stale references to device_add_child_after(9) with
device_child_add_ordered(9)

PR:		13210
Submitted by:	Alexey Zelkin <phantom@cris.net>
Reviewed by:	mpp
Forgotten by:	dfr
1999-09-04 12:37:21 +00:00
Peter Wemm
7f3dea244c $Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00
Chris Costello
340b8cda25 Bad ref time(2) changed to time(3) 1999-08-16 22:11:19 +00:00
Mike Pritchard
ac23fd2044 Remove a self-referencing xref in the SEE ALSO section. 1999-08-15 13:47:08 +00:00
Mike Pritchard
def37e7c68 Various man page cleanup:
- Sort xrefs
- FreeBSD.ORG -> FreeBSD.org
- Be consistent with section names as outlined in mdoc(7).
- Other misc mdoc cleanup.

PR:		doc/13144
Submitted by:	Alexey M. Zelkin <phantom@cris.net>
1999-08-15 10:48:36 +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
Matthew N. Dodd
15317dd875 Alter the behavior of sys/kern/subr_bus.c:device_print_child()
- device_print_child() either lets the BUS_PRINT_CHILD
	  method produce the entire device announcement message or
	  it prints "foo0: not found\n"

Alter sys/kern/subr_bus.c:bus_generic_print_child() to take on
the previous behavior of device_print_child() (printing the
"foo0: <FooDevice 1.1>" bit of the announce message.)

Provide bus_print_child_header() and bus_print_child_footer()
to actually print the output for bus_generic_print_child().
These functions should be used whenever possible (unless you can
just use bus_generic_print_child())

The BUS_PRINT_CHILD method now returns int instead of void.

Modify everything else that defines or uses a BUS_PRINT_CHILD
method to comply with the above changes.

	- Devices are 'on' a bus, not 'at' it.
	- If a custom BUS_PRINT_CHILD method does the same thing
	  as bus_generic_print_child(), use bus_generic_print_child()
	- Use device_get_nameunit() instead of both
	  device_get_name() and device_get_unit()
	- All BUS_PRINT_CHILD methods return the number of
	  characters output.

Reviewed by: dfr, peter
1999-07-29 01:03:04 +00:00
Nik Clayton
5bf6ab8369 Add $Id$, to make it simpler for members of the translation teams to
track.

The $Id$ line is normally at the bottom of the main comment block in the
man page, separated from the rest of the manpage by an empty comment,
like so;

     .\"    $Id$
     .\"

If the immediately preceding comment is a @(#) format ID marker than the
the $Id$ will line up underneath it with no intervening blank lines.
Otherwise, an additional blank line is inserted.

Approved by:            bde
1999-07-12 21:02:10 +00:00
Kris Kennaway
d30b1794da Flesh out VOP_ADVLOCK.9 with a description of the available flags
Sync vnode.9 with the definitions in <sys/vnode.h>

Reviewed by:	Doug Rabson
1999-06-30 12:02:52 +00:00
Mike Pritchard
5d70612b3f Fix some typos and do some minor mdoc cleanup. 1999-06-27 02:38:46 +00:00
Nick Hibma
6dcd4819f1 Add man page for device_quiet and friends 1999-06-22 18:09:54 +00:00
Tim Vanderhoek
3c218dea5c typo: Adviseroty -> Advisory 1999-06-22 02:34:47 +00:00
Nick Hibma
6979450036 Update the comments on values than can be returned by DEVICE_PROBE.
DEVICE_PROBE can return priorities.

Reviewed by:	Doug Rabson <dfr@nlsystems.com>
1999-06-17 19:22:12 +00:00
Bruce Evans
20891aba11 Fixed bitrot in synopsis (a missing include). 1999-06-02 16:33:22 +00:00
Nik Clayton
0bf3e334e5 Description of LOCKLEAF said "inode" when it should have said "vnode".
PR:             docs/11596
Submitted by:   Robert Watson <robert@fledge.watson.org>
1999-05-29 13:00:40 +00:00