Commit Graph

475 Commits

Author SHA1 Message Date
Warner Losh
6e5801f1af Add link for resource_query_unit, now documented in the
resource_query_string man page.
2001-03-02 04:32:50 +00:00
Warner Losh
2a2c539448 Flesh out this man page a bit more. Add information about
resource_query_unit and improve the descriptions of the parameters
passed to these functions.

Plus a couple minor formatting/markup changes:
o Quote -1 as \-1.
o .Dq hints to match resource_int_value().
2001-03-02 04:30:16 +00:00
Jeroen Ruigrok van der Werven
a9d6a1e2e5 Correct English used. 2001-03-01 09:37:38 +00:00
Ruslan Ermilov
d99c63df5a Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00
Jeroen Ruigrok van der Werven
392651edbe Hook Warner's resource_* manpages to the build.
This includes appropriate MLINKS for the other functions contained
within them.
2001-03-01 09:06:57 +00:00
Jeroen Ruigrok van der Werven
d8c9da66bd Remove leading . from .Nd description. 2001-03-01 09:02:01 +00:00
Jeroen Ruigrok van der Werven
1b766e78e8 Fix typo: the the -> to the. 2001-03-01 09:01:43 +00:00
Warner Losh
39b793da82 Document the resource_*_value and resource_query_string families of
functions.  These man pages likely need some markup work, so I've
specifically not added them to the Makefile yet.
2001-03-01 04:28:40 +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
Ruslan Ermilov
0b39b3ff10 mdoc(7) police: sanitize previous revision changes. 2001-02-16 09:05:48 +00:00
Bosko Milekic
328c0bbcf7 Document recently-implemented m_getm(). 2001-02-16 03:23:04 +00:00
Bruce Evans
2c9ba841c6 Fixed bitrot in synopsis. The Lite2 change from int to u_long for ioctl
command numbers had not reached here.
2001-02-15 12:54:34 +00:00
Bruce Evans
802cdd5fb2 Fixed rotted-as-committed pseudo-prototype for VFS_CHECKXP(). It had not
caught up with the changes to avoid storing socket addresses in mbufs,
although the VFS_CHECKEXP() code had to since it was committed 2 years
after those changes.

Fixed formatting in this prototype.
2001-02-15 12:41:44 +00:00
Bruce Evans
206402b24d Fixed bitrot in synopsis (some const poisoning had not reached here). 2001-02-15 12:27:11 +00:00
Bruce Evans
a10f4352b9 Fixed missing and wrong includes in synopsis. The prerequisites for
using bus_alloc_resource(), etc., are especially unobvious, but were
especially wrong (<sys/resource.h> has nothing to do with the resources
documented here...).  Order and format the includes as correctly as
possible (a layering violation makes <machine/bus.h> a prerequisite for
<sys/rman.h>).
2001-02-15 12:21:44 +00:00
Bruce Evans
6c613605bc Fixed missing include in synopsis.
Added evil #define of ACCEPT_FILTER_MODULE to synopsis.  Some of
the functions defined in this man page aren't declared unless
ACCEPT_FILTER_MOD is defined before including <sys/socketvar.h>.
2001-02-15 11:58:38 +00:00
Bruce Evans
2ba5bb1ff5 Fixed missing and/or wrong and/or extra includes in synopsis. 2001-02-15 11:47:31 +00:00
Ruslan Ermilov
51b37a2355 mdoc(7) cleanup. 2001-02-12 10:56:50 +00:00
Bosko Milekic
6f08f8297c Catch up to mutex API changes. 2001-02-12 03:14:57 +00:00
Ruslan Ermilov
46eea498da mdoc(7) police: Change -filled displays (which just happen
to be the same as -ragged in the current implementation) to
-ragged.  With mdocNG, -filled displays produce the correct
output, formatted and justified to both margins.
2001-02-07 13:45:30 +00:00
Ruslan Ermilov
b74e63f284 mdoc(7) police: Removed extraneous .No call. The .Nm macro in
mdocNG has been fixed to properly handle its arguments so this
was causing the extraneous (undesirable) space.
2001-02-07 10:11:57 +00:00
Ruslan Ermilov
308aca6c86 mdoc(7) police: minor style/formatting fixes. 2001-02-06 15:07:35 +00:00
Ruslan Ermilov
eb8afd58fe mdoc(7) police: minor style/formatting fixes. 2001-02-06 14:58:39 +00:00
Boris Popov
c7adfa9cf9 Add man page for VOP_GETVOBJECT, VOP_CREATEVOBJECT and VOP_DESTROYVOBJECT
operations.

Reviewed by:	sheldonh
2001-02-06 10:33:37 +00:00
Jeroen Ruigrok van der Werven
bcf588d94e Add vcount.9 / count_dev.9.
Touched up a bit and added some consistency to the text by your's truly.

PR:		23745
Submitted by:	Andrew Stevenson <andrew@ugh.net.au>
2001-02-06 09:04:52 +00:00
Bruce Evans
4d5a3a7a50 Removed vestiges of vop_mmap. 2001-02-02 12:51:22 +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
John Baldwin
efd39a2f76 mtx_try_enter() returns an int, not void. 2001-02-02 00:49:17 +00:00
Ruslan Ermilov
d0353b836e mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00
Ben Smithurst
d13241e146 Document the mpsafe argument to callout_init().
PR:		24529
Submitted by:	harti brandt <brandt@fokus.gmd.de>
Reviewed by:	jlemon
2001-01-31 12:17:45 +00:00
Dag-Erling Smørgrav
f5fccbbcb4 Style police.
Submitted by:	ru
2001-01-29 08:59:30 +00:00
Dag-Erling Smørgrav
ea48868bf6 Add MLINKS for sbuf_clear() and sbuf_overflowed(). 2001-01-28 00:19:10 +00:00
Dag-Erling Smørgrav
e499b74df0 Document the changes in subr_sbuf.c rev. 1.2. 2001-01-28 00:18:54 +00:00
Dag-Erling Smørgrav
0aa028ffe9 Add a man page for the zone allocator. 2001-01-27 19:13:08 +00:00
Ruslan Ermilov
9aa16122c1 mdoc(7) police: fixed some minor formatting/spelling errors. 2001-01-24 09:41:17 +00:00
John Baldwin
ef7b803dcd - Activate runqueue.9, scheduler.9, and sleepqueue.9 along with appropriate
MLINKS.
- Update MLINKS for mi_switch.9.
2001-01-23 19:38:45 +00:00
John Baldwin
8861ba5bc8 Catch up to the new way that the scheduling code works since the original
SMPng commit.  Also document the new cpu_throw function (currently only
on i386).

Reviewed by:	sheldonh
2001-01-23 19:28:14 +00:00
John Baldwin
969843e476 Document the various functions and variables used by the current
scheduler code.  Includes a rough description of the various priority
values stored in struct proc as well as priority propagation.

Reviewed by:	chris
2001-01-23 19:26:21 +00:00
John Baldwin
533ef7852a Document the current organization and helper functions used to implement
the sleep queues used by msleep/wakeup and friends.

Submitted by:	sheldonh
2001-01-23 19:24:35 +00:00
John Baldwin
40abbce7a6 Document the current organization of the run queues and the various
functions used to manage them.

Reviewed by:	sheldonh
2001-01-23 19:23:42 +00:00
Jason Evans
d1c1b8413e Remove MUTEX_DECLARE() and MTX_COLD. Instead, postpone full mutex
initialization until after malloc() is safe to call, then iterate through
all mutexes and complete their initialization.

This change is necessary in order to avoid some circular bootstrapping
dependencies.
2001-01-21 07:52:20 +00:00
Ruslan Ermilov
404d68d48f mdoc(7) police: add missing .Ed call. 2001-01-18 17:23:15 +00:00
Ruslan Ermilov
e207e465df Prepare for mdoc(7)NG. 2001-01-16 09:32:40 +00:00
Ruslan Ermilov
55f4342b4e mdoc(7) police: use .Fa for function arguments, use .Vt for variable type. 2001-01-16 08:53:04 +00:00
Jason Evans
238510fc46 Implement condition variables. 2001-01-16 01:00:43 +00:00
Mark Murray
47608b56e1 Add a missing argument for SYSCTL_ADD_OPAQUE.
Fix the examples at the end which were horribly broken.
2001-01-14 16:43:41 +00:00
Chris Costello
3c5969ca27 The prototype for cpu_switch() was changed in revision 1.111 of
<sys/proc.h>

PR:		24311
Submitted by:	Robert Drehmel <robert@gizmo.quizbot.org>
2001-01-13 19:00:49 +00:00
Ruslan Ermilov
a05c0d110e Oops, the previous did not work with current mdoc(7). 2001-01-12 16:02:58 +00:00
Ruslan Ermilov
b77b3c00be mdoc(7) police: Ft/Vt now accept punctuation-type arguments. 2001-01-12 15:46:56 +00:00
Ruslan Ermilov
3136363f3e Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00
Bosko Milekic
f73f120bec Change M_WAIT to M_TRYWAIT, the new name of the flag. 2000-12-24 03:08:17 +00:00
John Baldwin
aea5b8ffe1 Catch up to the changes to the kthread API. 2000-12-15 20:39:35 +00:00
Ruslan Ermilov
d003b7796c mdoc(7) police: removed duplicate .Os calls. 2000-12-14 12:40:48 +00:00
Ruslan Ermilov
ed40311694 mdoc(7) police: removed history info from the .Os FreeBSD call. 2000-12-14 11:52:05 +00:00
Sheldon Hearn
67e35919d6 Grammar fix. 2000-12-14 09:36:49 +00:00
Ruslan Ermilov
1405da432e mdoc(7) police: add a missing .Os, change the list type to ``tagged''. 2000-12-14 08:55:32 +00:00
John Baldwin
ea84acd6ad Document the MA_RECURSED and MA_NOTRECURSED assertion flags as well as
the MTX_QUIET flag.
2000-12-13 23:30:43 +00:00
Dag-Erling Smørgrav
863edaec4d Add sbuf(9) man page with links to API function names.
Reviewed by:	ru
2000-12-13 19:53:37 +00:00
Ruslan Ermilov
d7b336c076 mdoc(7) police: use canonical form of .Dd macro. 2000-12-11 15:47:53 +00:00
John Baldwin
baeb94c70d Fix some nits in the globs used to describe the various sets of atomic
operations.

Submitted by:	jake, jasone
2000-12-08 22:10:28 +00:00
Daniel C. Sobral
232095104e Add a brief warning about devclass and multiple device driver attachments. 2000-11-23 17:19:54 +00:00
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