d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
108,240 Commits 72 Branches 135 Tags 3.2 GiB
85bba4455a
Commit Graph

1206 Commits

Author SHA1 Message Date
Hiten Pandya
e07f1d5fd7 Various mdoc(7) fixes: 
Add devfs(5) reference                   - make_dev.9
	 Change .Xr from VFS_VGET(9) to vget(9)   - vnode.9
	 Spelling fix, 'useage' to 'usage'        - zone.9

Approved by:	des (mentor)
 2003-05-31 14:20:30 +00:00
Hiten Pandya
0640e9e01b Some mdoc(7) fixes: 
Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately.
The .Ar mdoc(7) specifier should only be used when displaying command line
arguments.

Approved by:	des (mentor)
 2003-05-31 14:07:25 +00:00
Hiten Pandya
2450346579 Add the bus_dma(9) manual page to our section 9 collection. It 
provides comprehensive documentation on FreeBSD's Bus DMA interface.

Approved by: gibbs, re@ (scottl)
Reviewed by: gibbs, scottl, des, sam, jake, tmm
 2003-05-30 22:57:54 +00:00
Ruslan Ermilov
3e1cee04f8 Assorted mdoc(7) fixes. 2003-05-30 21:13:32 +00:00
Hiten Pandya
1012d9d76c Bring vnode(9) man page to its senses: 
- remove '-*- nroff -*-'
	- bump the date

	- nuke outdated ``struct vnode''
	  (it is just better to lookup the struct in the header)

	- nuke ``enum vtype'' and related junk
	- add a one line about ``struct vnode''
	- use .Va instead of .Dv for vnode struct fields

Approved by: des (mentor), re (bmah)
Reviewed by: arch@, mentor
 2003-05-24 18:19:11 +00:00
Ruslan Ermilov
02531bb0b0 Link {be,le}{16,32,64}{enc,dec}.9 to byteorder.9. 
Approved by:	re (blanket)
 2003-05-21 17:37:22 +00:00
Ruslan Ermilov
0bf85f4f7e Fixed the whatis(1) entry for this manpage by using only 
one short description (.Nd).

Submitted by:	sheldonh

Added bswap*() functions to the NAME section.

Approved by:	re (blanket)
 2003-05-21 17:32:55 +00:00
Ruslan Ermilov
149c72305b Kill whitespace at EOL. 
Approved by:	re (blanket)
 2003-05-21 15:55:40 +00:00
Ruslan Ermilov
923d84c0bc mdoc(7) fixes. 
This manpage should really have only one short description (.Nd);
if anyone could come up with a wording suitable for both conversion
and decoding/encoding functions, that would unbreak the whatis(1)
output for this manpage.

Approved by:	re (blanket)
 2003-05-21 15:52:43 +00:00
Ruslan Ermilov
c8185672b2 Assorted mdoc(7), grammar, spelling, and punctuation fixes. 
Approved by:	re (blanket)
 2003-05-21 15:49:01 +00:00
Ruslan Ermilov
aba60fa66b Fixed troff(1) and mdoc(7) warnings. 
Approved by:	re (blanket)
 2003-05-18 21:05:22 +00:00
Hiten Pandya
72a3951459 Remove an extraneous .El' that was reported by groff -z`. 
Approved by: des (mentor), re (scottl)
 2003-05-16 19:57:38 +00:00
Hiten Pandya
e48d599e4f Remove an extraneous space, reported by groff -z. 
Approved by: des (mentor), re (scottl)
 2003-05-16 19:55:52 +00:00
Hiten Pandya
5466eeeaa7 Remove a bogus NOTES section. Move that content elsewhere. 
Approved by: des (mentor), re (scottl)
 2003-05-16 19:54:20 +00:00
Hiten Pandya
5f616912b4 Document the ``resource management'' routines in rman(9). 
Submitted by: Bruce M. Simpson <bms@spc.org>
Reviewed by: mdodd

Approved by: des (mentor), re (scottl)
 2003-05-16 19:22:27 +00:00
John Baldwin
2adcfc5855 - Use better terminology when describing mutex operations in msleep(9)'s 
description.
- Remove some bogus commas.
- Use the past tense when referring to the removal of the sleep() function
  since it happened quite a while ago and since the previous sentence in the
  paragraph already uses the past tense.

Approved by:	re (rwatson)
 2003-05-16 15:52:32 +00:00
Hiten Pandya
0d740fd5e8 Add a manual page for the CTASSERT(9) macro. 
Approved by: des (mentor), re (scottl)
 2003-05-16 15:24:07 +00:00
Hiten Pandya
30ecad6f4b Document the VFCF_* flags. 
Approved by: des (mentor), re (scottl)
 2003-05-16 15:21:20 +00:00
Hiten Pandya
03a0a09e98 Add missing MLINK for arc4rand(9). It is documented in 
random(9) and referenced by gbde(4).

PR: docs/51254
Submitted by: Simon L. Nielsen <simon@nitro.dk>
Approved and Reviewed by: des (mentor), re (bmah)
 2003-05-09 09:12:10 +00:00
Hiten Pandya
73692bebe4 malloc(9) types can be used to identify multiple allocations. 
PR: docs/38618
Approved by: des (mentor)
 2003-05-06 19:10:17 +00:00
Tom Rhodes
b655544297 fnet(9) claims that "those interfaces supporting reception of multicast 
datagrams have a LIST of multicast group memberships...".  On -CURRENT, that
LIST is actually a TAILQ.  Note that -STABLE still uses a LIST

PR:		50426
Submitted by:	Scott Mitchell <scott+freebsd@fishballoon.org>
 2003-05-01 18:34:13 +00:00
Tom Rhodes
f0aa77427a Xref sytle.Makefile(5). 
PR:	51183
 2003-04-26 15:37:39 +00:00
Warner Losh
bf2331bae4 Document device_set_driver(9) 
# now all driver_* functions used outside of subr_bus.o in my kernel
# are documented.
 2003-04-22 03:43:44 +00:00
Warner Losh
6e684dce35 Document device_printf(9). 2003-04-22 03:32:31 +00:00
Warner Losh
c56c6bab42 Document device_set_ivars(9) as well. 2003-04-22 03:25:14 +00:00
Warner Losh
44d993e38a man page for device_get_parent. 2003-04-22 00:26:02 +00:00
Warner Losh
c82d43ff7a device_is_alive already was documented in device_get_state, so remove the 
separate man page.  Document new device_is_attached there and remove that
new man page too.

Connect device_get_name to build, and install a link for
device_get_nameunit.

strangely nobody noticed this yet...
 2003-04-22 00:21:28 +00:00
Warner Losh
f6bcbf520a Add man page for device_get_name and device_get_nameunit. 2003-04-22 00:18:55 +00:00
Warner Losh
1f27c12a7e Xref these two functions, since they are similar enough to cause confusion. 2003-04-21 18:27:44 +00:00
Warner Losh
41c44039c9 Simple man page for new device_is_attached. 2003-04-21 18:25:04 +00:00
Warner Losh
dd7520c9eb Add a man page for device_is_alive. 2003-04-21 18:24:05 +00:00
Mike Silbersack
5a00719d7b Add a description of m_defragrandomfailures. 2003-04-15 02:26:13 +00:00
Mike Silbersack
3cab047e0b Add info on how to use the MBUF_STRESS_TEST options. (Only 1 option 
at present.)
 2003-04-13 23:31:06 +00:00
Hartmut Brandt
7081c47416 Forced commit to fill in the fields below for the last commit. Also 
bump the date of the man page.

PR:		docs/24797
Reviewed by:	bde, jake, jhb
 2003-04-10 10:18:56 +00:00
Hartmut Brandt
473e34ce22 Explicitely document the locking requirements for the malloc interface. 
While beeing here also correct the following:

 - list missing macros in the header
 - document MALLOC_DEFINE and MALLOC_DECLARE in the SYNOPSIS section
 - document additional include requirements for MALLOC_DEFINE
 - M_NOWAIT is not 0 anymore
 - remove rotted diagnostic messages
 2003-04-09 08:27:32 +00:00
Poul-Henning Kamp
21ee4ab688 Add inline functions {be,le}{16,32,64}{enc,dec}() for encoding decoding 
into byte strings of unknown alignment.
 2003-04-03 08:58:04 +00:00
Warner Losh
4e6e1b8646 rid is not a pointer to int, but rather just a plain int. 2003-03-30 00:30:29 +00:00
Warner Losh
d082b08904 Document what bus_set_resource(9) does. It is used by bus drivers to 
bind resources that client drivers later access.
 2003-03-30 00:25:23 +00:00
Kris Kennaway
6a897e3f7e Correct a typo in previous commit 2003-03-29 10:12:15 +00:00
Warner Losh
ec33f2d50f Add a new man page for bus_activate_resource and 
bus_deactivate_resource.  It could use some improvement, and others
are welcomed to do so :-)
 2003-03-29 05:16:15 +00:00
Warner Losh
1aa895cd3f Clearify what happens with the cookiep in various cases. 2003-03-29 05:11:14 +00:00
Warner Losh
c4ac3bc51d Fix some typos: 
race->rare
rman_activate_resource -> bus_activate_resource

Add xref to bus_activate_resource
Minor markup changes for the start/end/count parameters.
 2003-03-29 05:09:15 +00:00
Warner Losh
d1636fcf4e Expound a little bit about the softc, where its size is found and a 
caution against emulating legacy softc methods used in the tree.
 2003-03-28 07:28:31 +00:00
Warner Losh
9b89e63ce7 Create a man page for bus_child_present(9), a function to see if a 
given device is considered accessible by its parent device bus driver
(or its parent, etc).
 2003-03-28 07:09:17 +00:00
John Baldwin
e7561407e2 Revert previous commit which accidentally snuck in with some unrelated 
changes.

Reported by:	bde
 2003-03-25 19:46:55 +00:00
John Baldwin
7313b3d87e Remove obsolete at_fork() and at_exit() manpages. Curiously, at_exec() 
didn't have a manpage.

Reminded by:	ru
 2003-03-25 16:36:47 +00:00
Ceri Davies
a6f87194d6 Correct typo in function declaration (s/if_dont/if_done). 
PR:		docs/50136
Submitted by:	Scott Mitchell <scott+freebsd@fishballoon.org>
MFC After:	4.8
 2003-03-19 22:27:21 +00:00
Ceri Davies
146098408b Spelling fix: interwining -> intertwining. 2003-03-06 23:55:51 +00:00
Dag-Erling Smørgrav
6dca5fe95d Nuke caddr_t. 
Reminded by:	ru
 2003-03-03 10:49:37 +00:00
Ruslan Ermilov
ace5be682d mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00
Tom Rhodes
c65b53c5bc Return bits which were removed in revision 1.22. 
Requested by:	imp
 2003-02-24 05:59:12 +00:00
Tom Rhodes
1e73455ba1 Return bits which were removed in revision 1.28. 
Requested by:	imp
 2003-02-24 05:53:27 +00:00
Chris Costello
be20391041 Back out revision 1.34 until we can come up with a more accurate patch. 2003-02-17 22:31:27 +00:00
Chris Costello
2f2fead1a7 Add a section on Giant lock manipulation macros. 
Submitted by:	Hiten M. Pandya <hiten@angelica.unixdaemons.com>
Reviewed by:	bmilekic
 2003-02-17 22:21:41 +00:00
Philippe Charnier
60dca836a7 The .Fn function 2003-02-05 14:00:46 +00:00
Guido van Rooij
02718c4983 sleep -> msleep 2003-02-04 08:53:45 +00:00
Sam Leffler
627e7962d9 fix pathname typo 
Submitted by:	Jim Geovedi <negative@magnesium.net>
 2003-01-28 17:11:48 +00:00
Alfred Perlstein
c3dfdfd132 use 'void *' instead of 'caddr_t' for useracc, kernacc, vslock and vsunlock. 2003-01-21 11:34:57 +00:00
Alfred Perlstein
2a62ffb72d Catch up to WAIT/NOWAIT cleanup. 2003-01-21 08:57:35 +00:00
Sheldon Hearn
63264a559f Add required commas that were ommitted in the previous delta; the 
SEE ALSO section's list of manual pages must be comma-separated.
 2003-01-19 15:44:32 +00:00
Alfred Perlstein
79525d59b2 Document lock order reversals possible when calling allocation functions 
with vnode interlocks held.

Emphasize that users need to be careful with malloc flags versus mbuf
flags.

Remove stale portion in vnode.9 about v_tag.  We don't have it anylonger.

Submitted by: Hiten Pandya <hiten@unixdaemons.com>
 2003-01-18 19:51:52 +00:00
Robert Watson
eef9bd4c3f Caution programmers not to confuse M_DONTWAIT with M_NOWAIT. They 
are not the same.

Suggested by:	Hiten Pandya <hiten@unixdaemons.com>
 2003-01-18 03:25:40 +00:00
Chris Costello
bbc9e2b123 Include a proper reference to the Developers' Handbook in the 
SEE ALSO section.

Sponsored by:	DARPA, Network Associates Laboratories
 2003-01-08 10:53:37 +00:00
Jens Schweikhardt
e81508a04a Typo: s/CTLTYPE_DYN/CTLFLAG_DYN 
PR:	misc/45012
Submitted by:	Steve Coltrin <spcoltri@omcl.org>
 2003-01-04 17:01:50 +00:00
Tom Rhodes
62058fa939 mdoc(4) police: Markup. Fix 1 hard sentence break. 2003-01-03 23:06:10 +00:00
Tom Rhodes
7538a3c022 mdoc(7) police: Remove hard sentence breaks. 2003-01-03 22:39:39 +00:00
Tom Rhodes
cd9f822b00 mdoc(7) police: markup nits. 2003-01-03 22:37:10 +00:00
Jens Schweikhardt
d64ada501a Fix typos, mostly s/ an / a / where appropriate and a few s/an/and/ 
Add FreeBSD Id tag where missing.
 2002-12-30 21:18:15 +00:00
Jens Schweikhardt
57bd0fc6e8 english(4) police. 2002-12-27 12:15:40 +00:00
Ruslan Ermilov
074ad11567 Spelling: s/then/than/ where appropriate. 2002-12-24 16:52:31 +00:00
Ruslan Ermilov
facc67676f mdoc(7) police: Deal with self-xrefs. 2002-12-24 13:41:48 +00:00
Chris Costello
12cfff2842 Add and fix cross-references. 
Prompted by:	rwatson, dcs
Sponsored by:	DARPA, Network Associates Labs
 2002-12-12 22:17:44 +00:00
Ruslan Ermilov
8d5d039f80 Uniformly refer to a file system as "file system". 
Approved by:	re
 2002-12-12 17:26:04 +00:00
Ruslan Ermilov
4ac17494d7 mdoc(7) police: markup overhaul. 
Approved by:	re
 2002-12-12 14:25:52 +00:00
Ruslan Ermilov
e89f01cca3 mdoc(7) police: markup overhaul. 
Approved by:	re
 2002-12-12 14:17:24 +00:00
Ruslan Ermilov
a38f01e2d8 mdoc(7) police: overhaul. 
Approved by:	re
 2002-12-12 08:18:53 +00:00
Ruslan Ermilov
cdd53b1589 mdoc(7) police: overhaul. 
Reviewed by:	re
 2002-12-09 14:29:34 +00:00
Chris Costello
3ebc28efa8 Document the following MAC policies: 
o Biba: A data integrity policy
o BSD Extended: Support for the firewall-like access controls (ugidfw(8))
o MLS: Multi-level security, a confidentiality policy

(These files originally lived in src/share/man/man9)

Approved by:	re (blanket)
Sponsored by:	DARPA, Network Associates Labs
Obtained from:	TrustedBSD Project
 2002-12-05 00:05:38 +00:00
Chris Costello
431dda01b6 Document the MLS policy 
Approved by:	re
Sponsored by:	DARPA, Network Associates Labs
Obtained from:	TrustedBSD Project
 2002-12-02 01:04:37 +00:00
Chris Costello
9759d0e4dd Spelling: "current" -> "currently" 
Approved by:	re
Sponsored by:	DARPA, Network Associates Labs
 2002-12-02 00:00:43 +00:00
Ruslan Ermilov
d962d52ac0 mdoc(7) police: scheduled sweep. 
Approved by:	re
 2002-11-29 11:39:20 +00:00
Ruslan Ermilov
e60fa8374d mdoc(7) police: catch up to the code changes. 
Approved by:	re
 2002-11-29 11:36:32 +00:00
Ruslan Ermilov
e27480d64d mdoc(7) police: 
Revert to using the .Tn POSIX and .Tn ANSI instead of \*[Px] and \*[Ai]
strings; using these strings is unsafe in troff mode, as they include a
change in a font size.

Approved by:	re
 2002-11-26 17:55:41 +00:00
Chris Costello
2699228f1e Activate mac_biba.9 
Approved by:	re
Sponsored by:	DARPA, Network Associates Labs
 2002-11-20 22:28:20 +00:00
Chris Costello
36e4f12d71 Document the Biba MAC policy. 
Approved by:	re
Sponsored by:	DARPA, NAI Labs
Obtained from:	TrustedBSD Project
 2002-11-20 22:26:58 +00:00
Alfred Perlstein
4919e8cbe9 Flesh out the description of the uma_zcreate callback function arguements 
a bit.  As there may be changes soon we're still a bit vague unfortunatly.
 2002-11-18 01:11:58 +00:00
Robert Watson
bf139e9706 License: update, remove clause three of BSD license per approval of 
NAI.

Add cautionary notes on the experimental status of the MAC Framework
in FreeBSD 5.0.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
 2002-11-04 18:11:17 +00:00
Robert Watson
efbc63a783 Further clarifications of the #ifdef/#if/#elif/#endif style information, 
largely submitted by bde.  Return our exemption of the #ifdef lint
comments since the exemption is intended to handle a particularly
common current case without mandating change.  Improve language and
spelling, and slightly clarify the notions associated specifically
with #elif.

Obtained from:	bde
 2002-11-01 16:20:31 +00:00
Chris Costello
2c26594d26 o Change .Nd to be less redundant and more consistent with upcoming policy 
man pages.
o Move a misplaced comment.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Labs
 2002-10-29 00:21:03 +00:00
Robert Watson
5ab0c4ceeb Clarify style(9) WRT comments following #endif, #else. 
The closing comment is required only for long conditionally defined
code sections, with the exception of lint cases.  Attempt to document
also the logic for using '!' before the SOMETIMESSOMETHGINGHERE.
The goal of these comments is to make complex cases more
comprehensible, not to require them in all cases.  The rules here are
derived from behavior used in 90+% of the kernel source code.

Reviewed by and discussed with:	jhb, bde, mike
 2002-10-28 19:33:22 +00:00
Robert Watson
64027e4d85 Add mac(9), a man page providing a basic introduction to the concepts 
associated with the TrustedBSD MAC Framework, as well as some credits
to developers and contributors.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
 2002-10-21 23:51:18 +00:00
Andrew Gallatin
777bca5e20 Add some documentation of FreeBSD's special synchronization quirks 
which may surprise developers coming from Solaris, or other platforms
which have a similar interface, but slightly different rules.

Reviewed by: jhb, ru
 2002-10-21 12:54:13 +00:00
Chris Costello
19eec4135d Move .Os to its proper location in the document. 2002-10-20 19:44:36 +00:00
Benno Rice
6771685b7a Update the documentation for kthread_create to include the pages argument. 
Reviewed by:	sheldonh
Forgotten by:	scottl
 2002-10-19 01:39:44 +00:00
Chris Costello
6bc41f415a Add a new man page describing the mac_bsdextended policy. 
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
 2002-10-18 05:40:48 +00:00
Ruslan Ermilov
7621fdab1a mdoc(7) police: markup and spelling fixes. 
Prodded by:	phk
 2002-10-16 16:46:58 +00:00
Mike Barcroft
31cfc49a4e Remove the posix4(9) manual. It no longer contains relevant 
information.
 2002-10-16 14:24:41 +00:00
Sam Leffler
1403a8c73e update to better reflect reality: 
o describe additional argument in driver callbacks
o describe flow-control mechanism for processing crypto requests
o remove old cruft
o remove openbsd-specific cruft
o fixup some references
o yada yada ...
 2002-10-14 20:23:41 +00:00
Jeff Roberson
d627754a07 - Add a reference to ktrdump(8) 
- Remove the stale comments about ktr extend.
 2002-10-12 03:01:11 +00:00
John Baldwin
a3672eee7a SWI_SWITCH and SWI_NOSWITCH were OBE a long time ago. 2002-10-11 19:45:19 +00:00
Mike Barcroft
2b7f24d210 Change iov_base's type from char *' to the standard void *'. All 
uses of iov_base which assume its type is `char *' (in order to do
pointer arithmetic) have been updated to cast iov_base to `char *'.
 2002-10-11 14:58:34 +00:00
Poul-Henning Kamp
2c38619b52 Slight overhaul of arc4random() and friends. 
One bug fixed:  Use getmicrouptime() to trigger reseeds so that we
cannot be tricked by a clock being stepped backwards.

Express parameters in natural units and with natural names.

Don't use struct timeval more than we need to.

Various stylistic and readability polishing.

Introduce arc4rand(void *ptr, u_int len, int reseed) function which
returns a stream of pseudo-random bytes, observing the automatic
reseed criteria as well as allowing forced reseeds.

Rewrite arc4random() in terms of arc4rand().

Sponsored by:   DARPA & NAI Labs.
 2002-10-11 13:13:08 +00:00
Alfred Perlstein
9e9715e9c0 de-__P() 2002-10-10 00:32:55 +00:00
Sam Leffler
f4bf433552 manual pages for the new kernel crypto support (need work) 
Obtained from:	openbsd
 2002-10-04 20:43:30 +00:00
Poul-Henning Kamp
c5f9218b48 Add the new function "sbuf_done()" which returns non-zero if the sbuf is 
finished.

This allows sbufs to be used for request/response scenarioes without
needing additional communication flags.

Sponsored by:	DARPA & NAI Labs.
 2002-10-04 09:58:17 +00:00
Dima Dorfman
e767e97d74 Correct minor errors in the code examples. 
PR:		41993
Submitted by:	David Lay <dsl@foozle.org>
 2002-10-01 23:35:33 +00:00
Poul-Henning Kamp
97c662f817 Document that ENOTTY is the correct "default" error return; 2002-09-26 14:10:21 +00:00
John Baldwin
660e41d37f Remove all mention of MTX_NOSWITCH. It was obsoleted a long time ago. 2002-09-24 20:45:58 +00:00
Don Lewis
394739140c The file vnode passed to VOP_LINK() should now be locked before the call. 2002-09-19 13:34:50 +00:00
Don Lewis
81f8d226f9 Convert descriptions in the ERRORS section to full sentences if they 
were not full sentences, elaborating as necessary.
 2002-09-18 22:12:43 +00:00
Poul-Henning Kamp
0b1c0994a5 Add m_fixhdr() and m_length(). 2002-09-18 20:04:30 +00:00
Don Lewis
cc25845767 Style and markup changes only. 
Capitalize the first letter of the descriptions for the entries in the ERRORS
section if they are complete sentences and end the sentences with periods.
 2002-09-18 09:34:01 +00:00
Don Lewis
4f0ef11192 Update man page to reflect current implementation. 
List all of the error returns shown in the example code in the ERRORS
section.
 2002-09-17 08:31:43 +00:00
Don Lewis
691d7d0915 Fix a hard sentence break. 2002-09-17 08:24:15 +00:00
Nate Lawson
8723b451f9 Start new sentence with newline. 
Suggested by: jhb
 2002-09-16 19:53:51 +00:00
Nate Lawson
8c3308035a Update man page for enum -> const char * change for v_tag 2002-09-16 18:16:07 +00:00
Robert Watson
58616b1c69 s/VOP_NULL/VATTR_NULL/ 2002-09-14 03:32:57 +00:00
Robert Drehmel
3b12885314 Add a paragraph which should clarify the separation of asterisks 
and adjacent tokens in declarations.
The added text was originally a single sentence I wrote and which
was heavily modified and extended by Bruce Evans.

This clarification attempt originates from differing usage of the
'restrict' type-qualifier.
Although various documents documents dicussing the C Programming
Language put a space between an asterisk and the 'restrict' keyword,
including the C99 standard (at least the n869.txt draft) and other
ISO/IEC JTC1/SC22/WG14 documents, the IEEE Std 1003.1-2001 document
does not separate them.

Discussed with:		bde
Requested by:		tjr
Separation using a single space also liked by:	mike
 2002-09-10 14:48:38 +00:00
Tony Finch
3e30ca7b1c Remove a sentence about wrapping macro definitions in bare braces, 
which became wrong after using do { } while (0) became recommended.
Move the definition of what braces are to their new first occurrence.

Reviewed by:	bde
 2002-09-10 10:54:39 +00:00
Chad David
78ae381517 Note that siginit() does not cause every signal to be ignored only the 
ones with a default property of SA_IGNORE, and that it acquires and
releases the processes lock.
 2002-09-07 06:07:55 +00:00
Robert Drehmel
00f9b68295 Expand a contraction in the text of style(9) for consistency. 
Do not touch contractions in comments of code examples because
their usage seems to be justified by space contraints.
 2002-09-06 10:53:57 +00:00
Maxim Sobolev
d1831a621a Last missed bit of user-setable promisc mode. 
Pointy hat to:  sobomax
MFC after:      1 day
 2002-08-28 07:24:20 +00:00
Chris Costello
4e1e73eb94 Remove a repeated word. 
Submitted by:	horikawa
 2002-08-25 07:13:05 +00:00
Warner Losh
f46ccb5625 Suggest that function prototypes in kernel headers be alphabetical, 
unless there's a compelling reason to deviate.

Submitted by: Don Lewis
Suggestion not objected to by: developers@
 2002-08-21 06:58:21 +00:00
Maxim Sobolev
62f7648682 Increase size of ifnet.if_flags from 16 bits (short) to 32 bits (int). To avoid 
breaking application ABI use unused ifreq.ifru_flags[1] for upper 16 bits in
SIOCSIFFLAGS and SIOCGIFFLAGS ioctl's.

Reviewed by:	-hackers, -net
 2002-08-18 07:05:00 +00:00
Maxime Henrion
9ca5db2fe1 Fix typo. 2002-08-15 13:11:35 +00:00
Ruslan Ermilov
75aee0b96c mdoc(7) police: nits. 2002-08-13 15:01:26 +00:00
Ruslan Ermilov
6c8c60988b mdoc(7) police: typos. 2002-08-13 14:57:33 +00:00
Ruslan Ermilov
635e2e682b mdoc(7) police: nit. 2002-08-13 14:52:41 +00:00
Ruslan Ermilov
e6d3dae8cd mdoc(7) police: tidy up formatting. 2002-08-13 14:51:17 +00:00
Warner Losh
b294c6a39a Clarify the sizeof(var) rule. This is the result of the consensus in 
arch@ between myself, bde and markm.  I kept the parts that all of us
agreed to, and omitted some more extensive text that I'd originally
wanted.
 2002-07-25 00:30:24 +00:00
Robert Watson
060c42c3d2 Mention SAVENAME and SAVESTART in the namei(9) operation flag description 
since apparently people were missing that you aren't supposed to access
the name buffer following namei() unless you specify one of these flags.

Pointed out by:	green
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
 2002-07-23 13:16:36 +00:00
Robert Watson
fd3083e0f8 Update ucred.9 to talk a bit more about correct use of credentials, 
including documenting that ucreds must not be pulled out of thin air,
when to use td_cred vs. p_ucred, how to avoid race conditions in
credential updates, and why to use p_ucred when targetting a thread
or process in an access control operation involving two processes.

Reviewed by:	julian, jhb (earlier revision)
 2002-07-23 13:09:24 +00:00
Julian Elischer
a4fd02efc7 link in the man page for thread_exit 
Also change some line breaks.
 2002-07-08 17:52:00 +00:00
Julian Elischer
eecc312518 Add a man page. Style comments welcome. I have a bunch-o-new-pages 
to add so I might as we find out what I did wrong now :-)
 2002-07-08 07:51:20 +00:00
Julian Elischer
b388e223f2 Slight changes to reflect some of the changes in -current. 
mi_switch(9) is still wildly innacurate. I suggest that every kernel
developer takes 20 minutes a day for the next few days and updates one or
two of his favourite chapter 9 man pages as they are now WAY out of date
in general. I will add a couple of KSE related pages soon.
 2002-07-08 07:34:46 +00:00
Warner Losh
85f6b8fda7 Clarify version 1.68 to more accurately describe the intent of the change to 
try to avoid ambiguous cases in the future.

Wording approved by: julian (early draft), grog, rwatson, wes and maybe other
members of core I'm forgetting.
 2002-07-02 01:39:35 +00:00
Brian Somers
cfbd984f1c Fix a tyop 2002-07-02 01:03:10 +00:00
Warner Losh
a9df73aa7b Document what splnet and splimp are in FreeBSD 2002-07-01 22:08:43 +00:00
Kenneth D. Merry
98cb733c67 At long last, commit the zero copy sockets code. 
MAKEDEV:	Add MAKEDEV glue for the ti(4) device nodes.

ti.4:		Update the ti(4) man page to include information on the
		TI_JUMBO_HDRSPLIT and TI_PRIVATE_JUMBOS kernel options,
		and also include information about the new character
		device interface and the associated ioctls.

man9/Makefile:	Add jumbo.9 and zero_copy.9 man pages and associated
		links.

jumbo.9:	New man page describing the jumbo buffer allocator
		interface and operation.

zero_copy.9:	New man page describing the general characteristics of
		the zero copy send and receive code, and what an
		application author should do to take advantage of the
		zero copy functionality.

NOTES:		Add entries for ZERO_COPY_SOCKETS, TI_PRIVATE_JUMBOS,
		TI_JUMBO_HDRSPLIT, MSIZE, and MCLSHIFT.

conf/files:	Add uipc_jumbo.c and uipc_cow.c.

conf/options:	Add the 5 options mentioned above.

kern_subr.c:	Receive side zero copy implementation.  This takes
		"disposable" pages attached to an mbuf, gives them to
		a user process, and then recycles the user's page.
		This is only active when ZERO_COPY_SOCKETS is turned on
		and the kern.ipc.zero_copy.receive sysctl variable is
		set to 1.

uipc_cow.c:	Send side zero copy functions.  Takes a page written
		by the user and maps it copy on write and assigns it
		kernel virtual address space.  Removes copy on write
		mapping once the buffer has been freed by the network
		stack.

uipc_jumbo.c:	Jumbo disposable page allocator code.  This allocates
		(optionally) disposable pages for network drivers that
		want to give the user the option of doing zero copy
		receive.

uipc_socket.c:	Add kern.ipc.zero_copy.{send,receive} sysctls that are
		enabled if ZERO_COPY_SOCKETS is turned on.

		Add zero copy send support to sosend() -- pages get
		mapped into the kernel instead of getting copied if
		they meet size and alignment restrictions.

uipc_syscalls.c:Un-staticize some of the sf* functions so that they
		can be used elsewhere.  (uipc_cow.c)

if_media.c:	In the SIOCGIFMEDIA ioctl in ifmedia_ioctl(), avoid
		calling malloc() with M_WAITOK.  Return an error if
		the M_NOWAIT malloc fails.

		The ti(4) driver and the wi(4) driver, at least, call
		this with a mutex held.  This causes witness warnings
		for 'ifconfig -a' with a wi(4) or ti(4) board in the
		system.  (I've only verified for ti(4)).

ip_output.c:	Fragment large datagrams so that each segment contains
		a multiple of PAGE_SIZE amount of data plus headers.
		This allows the receiver to potentially do page
		flipping on receives.

if_ti.c:	Add zero copy receive support to the ti(4) driver.  If
		TI_PRIVATE_JUMBOS is not defined, it now uses the
		jumbo(9) buffer allocator for jumbo receive buffers.

		Add a new character device interface for the ti(4)
		driver for the new debugging interface.  This allows
		(a patched version of) gdb to talk to the Tigon board
		and debug the firmware.  There are also a few additional
		debugging ioctls available through this interface.

		Add header splitting support to the ti(4) driver.

		Tweak some of the default interrupt coalescing
		parameters to more useful defaults.

		Add hooks for supporting transmit flow control, but
		leave it turned off with a comment describing why it
		is turned off.

if_tireg.h:	Change the firmware rev to 12.4.11, since we're really
		at 12.4.11 plus fixes from 12.4.13.

		Add defines needed for debugging.

		Remove the ti_stats structure, it is now defined in
		sys/tiio.h.

ti_fw.h:	12.4.11 firmware.

ti_fw2.h:	12.4.11 firmware, plus selected fixes from 12.4.13,
		and my header splitting patches.  Revision 12.4.13
		doesn't handle 10/100 negotiation properly.  (This
		firmware is the same as what was in the tree previously,
		with the addition of header splitting support.)

sys/jumbo.h:	Jumbo buffer allocator interface.

sys/mbuf.h:	Add a new external mbuf type, EXT_DISPOSABLE, to
		indicate that the payload buffer can be thrown away /
		flipped to a userland process.

socketvar.h:	Add prototype for socow_setup.

tiio.h:		ioctl interface to the character portion of the ti(4)
		driver, plus associated structure/type definitions.

uio.h:		Change prototype for uiomoveco() so that we'll know
		whether the source page is disposable.

ufs_readwrite.c:Update for new prototype of uiomoveco().

vm_fault.c:	In vm_fault(), check to see whether we need to do a page
		based copy on write fault.

vm_object.c:	Add a new function, vm_object_allocate_wait().  This
		does the same thing that vm_object allocate does, except
		that it gives the caller the opportunity to specify whether
		it should wait on the uma_zalloc() of the object structre.

		This allows vm objects to be allocated while holding a
		mutex.  (Without generating WITNESS warnings.)

		vm_object_allocate() is implemented as a call to
		vm_object_allocate_wait() with the malloc flag set to
		M_WAITOK.

vm_object.h:	Add prototype for vm_object_allocate_wait().

vm_page.c:	Add page-based copy on write setup, clear and fault
		routines.

vm_page.h:	Add page based COW function prototypes and variable in
		the vm_page structure.

Many thanks to Drew Gallatin, who wrote the zero copy send and receive
code, and to all the other folks who have tested and reviewed this code
over the years.
 2002-06-26 03:37:47 +00:00
Peter Wemm
3ff369fed2 Remove references to UIO_USERISPACE which no longer exists. 2002-06-20 07:09:24 +00:00
Chad David
02aadf0b50 Fix up the wording thoughout, and document locking. 2002-06-10 17:36:05 +00:00
Chad David
d99146a1f3 Fix wording and spelling in the trapsignal() description. 2002-06-10 17:08:42 +00:00
Chad David
e2eca5fe3e Document the cred_update_thread() function, and fix the RETURN VALUES. 2002-06-10 05:18:00 +00:00
Chad David
f7fcafe17a The moduledata_t argument is not a pointer, and sysstem_sub_id should 
be sysinit_sub_id.

PR: docs/34583
Approved by: murray
 2002-06-10 04:37:11 +00:00
Chad David
920a6f7e8f Add signal.9 and friends. 2002-06-10 03:01:36 +00:00
Chad David
cbebeaa5be New man page that documents many of the kernel related signal functions. 
Requested by: alfred
 2002-06-10 03:00:24 +00:00
Chad David
93994536bd Document MTX_DUPOK 
Requested by: jeff (long ago)
 2002-06-06 19:08:11 +00:00
Ruslan Ermilov
05cb5024af mdoc(7) police: minor markup nits. 2002-05-30 13:33:59 +00:00
Ruslan Ermilov
9be1948fa4 mdoc(7) police: Fix SYNOPSIS, bump document date. 2002-05-30 11:37:39 +00:00
Ruslan Ermilov
5ec37969a1 mdoc(7) police: lint. 2002-05-29 18:00:23 +00:00
Ruslan Ermilov
00679a580d mdoc(7) police: lint. 2002-05-29 17:50:04 +00:00
Ruslan Ermilov
3f640b03b1 mdoc(7) police: markup nits. 2002-05-29 17:45:44 +00:00
Ruslan Ermilov
841b462f2a mdoc(7) police: markup nits. 2002-05-29 17:37:32 +00:00
Jeroen Ruigrok van der Werven
382682b2a4 Add description for uma_zcreate(). 
Submitted by:	arr
 2002-05-18 11:12:02 +00:00
Tom Rhodes
0e85d620bc More file system > filesystem 2002-05-16 05:21:58 +00:00
Chris Costello
cae2a33cf0 Begin to turn some of the code in this man page into documentation. 
Move the code that I have not yet finished documenting into the
`IMPLEMENTATION NOTES' section.

Sponsored by:	DARPA, NAI Labs
Obtained from:	TrustedBSD Project
 2002-05-05 22:09:12 +00:00
Robert Watson
cc0e549485 Various updates to VOP_ATTRIB(9): mention locks being shared/exclusive 
for VOP_GETATTR() and VOP_SETATTR(), reference VOP_NULL() to suggest
clearing all of *vap with it before setting specific values.  Cross
reference VFS(9).  Indicate that failure modes are possible from
VOP_GETATTR() and that an errno value is returned.

Submitted by:	Hiten Pandya <hiten@uk.FreeBSD.org>
 2002-05-03 20:28:38 +00:00
Jeroen Ruigrok van der Werven
acff84fb0e Chase the sources and document the change of wait to flags, which are 
the normal malloc(9) flags.

Submitted by:	arr
 2002-04-30 16:30:19 +00:00
Jeroen Ruigrok van der Werven
5540755955 Remove references to zinit() which does not exist anymore. 2002-04-30 15:04:41 +00:00
Jeroen Ruigrok van der Werven
9a79558313 Document the zone allocator is now a slab allocator. 
Show Jeff's work and your's truly manual page updates.
 2002-04-30 14:56:44 +00:00
Jeroen Ruigrok van der Werven
1437c79a4a Document uma_zalloc() behaviour. 2002-04-30 14:26:22 +00:00
Jeroen Ruigrok van der Werven
f1de92e633 Update function arguments to what is current used. 2002-04-30 13:03:28 +00:00
Jeroen Ruigrok van der Werven
7c32182e06 Prefix the remaining functions with uma_ as is now the case in UMA. 2002-04-30 12:45:31 +00:00
Jeroen Ruigrok van der Werven
2f91527664 zinit() does not exist anymore. 2002-04-30 12:29:59 +00:00
Jeroen Ruigrok van der Werven
77776e8c7a Remove references to zbootinit() and zinitna(). 2002-04-30 09:47:50 +00:00
Jeroen Ruigrok van der Werven
9daecfc462 Add a MLINKS to uma.9 from zone.9. 2002-04-30 09:41:25 +00:00
Jeroen Ruigrok van der Werven
008080bd8b Do not use a contraction, aren't -> are not. 2002-04-30 09:38:52 +00:00
Jeroen Ruigrok van der Werven
268c1b9c75 Remove MLINKS to zinitna, it does not exist anymore. 2002-04-30 09:38:06 +00:00
Jeroen Ruigrok van der Werven
c25d2ac8cb Remove MLINKS to zbootinit. This has been gone for a while now. 2002-04-30 09:36:02 +00:00
Jeroen Ruigrok van der Werven
3a347a6e4e Remove wrong include, one is supposed to include vm/uma.h instead of 
vm_zone.h.
 2002-04-30 08:51:42 +00:00
Mike Barcroft
aabc5d3d44 Add links for bswap16.9, bswap32.9, and bswap64.9. 2002-04-29 17:04:23 +00:00
Mike Barcroft
3f4655de4b Document bswap16(), bswap32(), and bswap64(). Change the included 
header to reflect the new prototype location.
 2002-04-29 17:02:51 +00:00
Bill Fenner
04df644c95 mdoc police: turn .PP back into .Pp 2002-04-17 21:26:43 +00:00
Tom Rhodes
f9d32093a6 Removed 2 lines from the cd(9) manual page. 
PR:		35944
 2002-04-15 06:02:58 +00:00
Jeroen Ruigrok van der Werven
50c1e22e2e Correct two syntax mistakes. 
Fix overflowing right side, so that the && operator fits on the same line.
 2002-04-14 19:52:42 +00:00
Jeroen Ruigrok van der Werven
d172142dc6 Remove extraneous newline. 2002-04-14 19:33:07 +00:00
Chad David
623fded8d6 Remove a duplicate description of the type parameter for mtx_init. 
Noticed by: scottl
 2002-04-12 16:32:38 +00:00
Chad David
468f8a27bb Add entries for selrecord.9. 2002-04-12 06:19:34 +00:00
Chad David
307ce5fea9 Add a new man page that documents selrecord and selwakeup. 
Thanks to: alfred
 2002-04-12 06:19:12 +00:00
Chad David
4edac09c3e Update the prototype for maybe_resched to take a thread not a ksegrp. 
Remove need_resched as it no longer exists.
Cleanup the text for other functions that have changed out from under
their descriptions.

This page needs to be reviewed again after things settle down a bit.

Reviewed by: jhb
 2002-04-12 06:03:47 +00:00
Chad David
57cf955171 Add text describing the new type parameter, and rename description 
to name as that is what it is called in mutex.h.
 2002-04-12 05:55:17 +00:00
Chad David
e6f97cc401 Add sys/types.h to the list of required includes. 2002-04-12 05:23:16 +00:00
Chad David
234b7100a1 Update the prototype for read_random to reflect that the count parameter 
is an int not an unsigned int, and that it returns an int not an unsigned
int.
 2002-04-12 05:19:12 +00:00
Chad David
c4a7ba6e34 Update the prototype for lockinit to reflect that wmesg is a const char *. 2002-04-12 05:16:27 +00:00
Chad David
f972f99474 Fix the prototypes for cpu_critical_exit and cpu_critical_enter and update 
the text to reflect the changes.

Update the header files list.
 2002-04-12 05:06:38 +00:00
Scott Long
6a00ed1536 Document the lock type argument of mtx_init(). 2002-04-12 05:05:19 +00:00
Chad David
94552cece2 Document the new size parameter. 2002-04-12 04:26:15 +00:00
Chad David
ac05f75438 Document the new flags parameter. 
Add vget(9) to the SEE ALSO list.
Minor formatting change.
 2002-04-12 04:23:22 +00:00
Chad David
55d04e913a Update the .Fn line for SX_SYSINIT to include the parameter types. 2002-04-12 03:55:43 +00:00
Chad David
37bc3d021d Update the .Fn line for MTX_SYSINIT to include the parameter types. 2002-04-12 03:54:44 +00:00
Chad David
8d7cbc2dea Fix typo and change Fn to Xr. 2002-04-05 08:05:11 +00:00
Andrew R. Reiter
80cc42da6b - Add notes about SX_SYSINIT and MTX_SYSINIT in order to document the 
recent additions of these macros.
- Add in a MLINK to create SX_SYSINIT.9 and MTX_SYSINIT.9.
 2002-04-02 17:21:00 +00:00
John Baldwin
cfa028281a - Update to new suser() API. 
- Spell privilege properly.
- Grammar nits.
 2002-04-02 16:41:11 +00:00
Dima Dorfman
82d0caaef1 mdoc(7) police: remove whitespace at EOL. 2002-03-28 12:57:48 +00:00
Dima Dorfman
a254506ee5 Add mtx_pool(9) to the SEE ALSO section. 
Submitted by:	Garrett Rooney <rooneg@electricjellyfish.net>
 2002-03-28 12:51:06 +00:00
Dima Dorfman
aa43564a2c Add a manual page for the mtx_pool_* routines. 
PR:		36350
Submitted by:	Garrett Rooney <rooneg@electricjellyfish.net>
Reviewed by:	dillon
 2002-03-28 12:50:17 +00:00
David E. O'Brien
c05da6d338 'char *' can be a large entity now (on 64-bit platforms). Thus move it up 
to make the example match the text requirements.
 2002-03-24 17:02:16 +00:00
Chad David
ffa2379289 Fixed bad wording/spelling in few paragraphs. 2002-03-24 00:31:38 +00:00
Ruslan Ermilov
a689555c72 mdoc(7) police: tidy up. 2002-03-18 16:52:32 +00:00
Ruslan Ermilov
21bb400da0 mdoc(7) police: tidy up. 2002-03-18 16:40:07 +00:00
Ruslan Ermilov
63856f9683 mdoc(7) police: pedantry. 2002-03-18 11:08:53 +00:00
Ruslan Ermilov
ef7e25bc75 mdoc(7) police: markup nit. 2002-03-18 11:03:57 +00:00
Ruslan Ermilov
b6acc60d91 mdoc(7) police: tidy up. 2002-03-18 10:59:58 +00:00
Ruslan Ermilov
c2f7105cd0 mdoc(7) police: fixed some wording, kill whitespace at EOL. 2002-03-18 10:52:09 +00:00
Ruslan Ermilov
2ca6ad76af mdoc(7) police: macroize UNIX. 2002-03-18 10:43:49 +00:00
Jens Schweikhardt
341229f512 Typo: s/dependant/dependent/ 
MFC after:	3 days
 2002-03-16 18:12:49 +00:00
Jens Schweikhardt
559ff927b2 Typo: s/conjuction/conjunction/ 2002-03-16 18:10:40 +00:00
Jens Schweikhardt
46612f8261 Plural bogon: s/childs/children/ 
MFC after:	3 days
 2002-03-16 18:07:07 +00:00
Jens Schweikhardt
9d0e429cbe Typo; s/Filesytems/Filesystems/ 
MFC after:	3 days
 2002-03-16 17:26:07 +00:00
Ruslan Ermilov
2eff01c7e0 mdoc(7) police: Kill the (now extraneous) empty line. Previously, 
.Bd erroneously defaulted to -compact mode in the SYNOPSIS section.
 2002-03-15 12:04:49 +00:00
Robert Watson
b45deeb2a5 NAI DBA update. 2002-03-14 21:58:58 +00:00
Jens Schweikhardt
ac20ab0d2d Grammar bogon: s/structure a route/structure of a route/ 
MFC after:	3 days
 2002-03-14 18:43:09 +00:00
Archie Cobbs
44a8ff315e Add realloc() and reallocf(), and make free(NULL, ...) acceptable. 
Reviewed by:	alfred
 2002-03-13 01:42:33 +00:00
Mike Barcroft
8a1791edf4 Create a manual to document the new kernel byte order conversion 
functions.

Reviewed by:	tmm
 2002-03-06 01:53:35 +00:00
Dima Dorfman
0db0f1925a Document cru2x(). 2002-03-03 03:27:28 +00:00
Mark Murray
7d6ad52aa0 Fix required includes in accordance with recent source fixes. 
Submitted by:	bde
 2002-03-01 18:43:15 +00:00
Chad David
25416dcedf Note the the process group is returned locked. 2002-02-28 07:06:31 +00:00
Warner Losh
ad30894246 The do { } while (0) macro example was missing a space after the 'e'. 2002-02-27 23:16:34 +00:00
Robert Watson
2f2f40f261 Language clarification: s/an or/a/ 2002-02-18 00:21:05 +00:00
Dima Dorfman
44c63b6447 The routine is dev_depends(); consistently spell it that way. 
PR:		34047
Submitted by:	Maxime Henrion <mux@sneakerz.org>
Pointy hat to:	dd
 2002-02-11 01:21:29 +00:00
Robert Watson
8466e2ba43 Reinforce locking requirement for VOP_REVOKE: the lock must not be held. 
Discussed with:	phk
 2002-02-10 20:48:22 +00:00
Robert Watson
b3b414b604 Revert 1.14: VOP_GETATTR() really does require a vnode lock. 
Confirmed by:	mckusick
 2002-02-10 19:28:34 +00:00
Brian Feldman
c3c2d89da9 Correct copyright. 2002-02-07 19:07:36 +00:00
Mark Murray
be6b96ea0b Document entropy device bits. 2002-02-06 21:38:20 +00:00
Josef Karthauser
e105123179 Update the physio man page to better reflect reality. 
PR:		docs/30603
Reviewed by:	phk
MFC after:	3 days
 2002-02-05 21:32:57 +00:00
Brian Feldman
a15fa068ab Add a manpage for VOP_REVOKE(9). 
Sponsored by:	DARPA, NAI Labs
 2002-02-05 16:08:49 +00:00
Brian Feldman
6dad2ea974 Document that VOP_GETATTR(9) does not actually expect to hold an 
exclusive lock on entry.

Sponsored by:	DARPA, NAI Labs
 2002-02-05 15:26:28 +00:00
Warner Losh
3bd49456b1 Note new status of __P. Don't use it. 
Reviewed by: arch@, mckusick (in principle)
 2002-02-01 01:26:24 +00:00
David E. O'Brien
1bb7d81107 There is no need to wrap vendor id bits with '#if 0' if they come pre-wrapped. 2002-02-01 01:17:22 +00:00
Bruce Evans
96cb532cb8 Modified the rules for vendor ids: 
- explictly say not to edit infrastructure for vendor ids (not just the
  ids).
- say to enclose vendor ids and their infrastucture in ``#if 0'', and
  partly explain why.
- don't set a bad example by mangling the Berkeley id infrastructure from
  ``static char sccsid[] ...'' to ``__RCSID(...)''.
- show a blank line between the vendor id cruft and the FreeeBSD if cruft
  in the example.
- relaxed the rule about adding "From: " to say that "From: " is actually
  useful if the file has been renamed.
- minor English improvements.

Discussed with:	obrien
 2002-01-31 13:26:29 +00:00
Andrew R. Reiter
fa027af9d9 - Spelling fix: "functons" -> "functions". 2002-01-26 21:41:28 +00:00
Chad David
5385e8bfab Merged all of the lockmgr functions into a single file (lock.9); as well, 
some content and layout changes were made.

lock.9 had existed before but was never added to Makefile, so it was
never installed.  That is why the duplicate files were created in the
first place.

Reviewed by:	ru, alfred
 2002-01-26 00:09:41 +00:00
Ruslan Ermilov
c6a51f1c4a mdoc(7) police: removed raw troff from previous delta. 
Objected to by:	mpp, jhb
 2002-01-17 15:57:43 +00:00
Bruce Evans
df2aa36d5a Fixed missing return type in the prototoype for the hook function. 2002-01-11 13:18:32 +00:00
Ruslan Ermilov
1e55b8c749 mdoc(7) police: tidy up the markup. 
Reviewed by:	davidc
 2002-01-10 17:47:38 +00:00
Ruslan Ermilov
e4c7f9b607 mdoc(7) police: tidy up the markup. 2002-01-10 13:09:00 +00:00
Ruslan Ermilov
ced699e370 mdoc(7) police: get rid of WEOL and HSB introduced in rev 1.6. 2002-01-10 13:02:55 +00:00
Ruslan Ermilov
b6ff0012db mdoc(7) police: finish up the "proc" -> "thread" conversion. 2002-01-10 12:55:36 +00:00
Ruslan Ermilov
3b0536fa2a mdoc(7) police: tidy up the previous delta a bit. 2002-01-10 12:53:51 +00:00
Ruslan Ermilov
8271a1025c mdoc(7) police: tidy up the markup. 2002-01-10 12:32:38 +00:00
Ruslan Ermilov
48ad35449f get_cyclecounter.9 has been repo-copied to get_cyclecount.9. 2002-01-10 12:21:06 +00:00
Ruslan Ermilov
00594efed6 mdoc(7) police: tidy up the markup, fix some minor bugs. 2002-01-10 11:57:10 +00:00
Ruslan Ermilov
52f1d68ff8 mdoc(7) police: tidy up the markup. 
This manpage should be repo-copied to get_cyclecount.9.
 2002-01-10 10:48:39 +00:00
Ruslan Ermilov
2be6c09fd5 mdoc(7) police: 
- make SYNOPSIS look better with some troff magic
- tidy up the markup
 2002-01-10 10:36:04 +00:00
Ruslan Ermilov
fdedf9fd70 mdoc(7) police: function typedefs are similar to the 
function declarations so use that idea to fix markup.
 2002-01-10 09:34:33 +00:00
Ruslan Ermilov
0cf7294092 mdoc(7) police: 
- logically sort the SYNOPSIS section
- add missing markup bits
- "brackets" -> "parentheses"
 2002-01-10 09:20:07 +00:00
Mike Pritchard
b82af3f5e4 ispell sweep of share/man/man9/*. 2002-01-09 11:43:48 +00:00
Chad David
2e693d1919 Fairly major cleanup of the text. 
PR: docs/32241
 2002-01-09 08:42:43 +00:00
Chad David
23257a0057 Removed <sys/queue.h> from the list of required include files and 
corrected the name of the function (get_cyclecount()).

Requested by: bde
 2002-01-06 23:56:12 +00:00
Kelly Yancey
371c0c842a Document sbuf_trim() and sbuf_vprintf(); add MLINKs. 
Clarify that the contents of a caller-supplied buffer are undefined and
should not be examined directly.

Reviewed by:	des
 2002-01-06 08:40:42 +00:00
John Baldwin
e5b4afac08 Fully catch up to the recent critical section API change. Update the 
content of the manpage and document cpu_critical_enter/exit.
 2002-01-04 23:56:17 +00:00
Alfred Perlstein
0df3708ddb Make it explicit that the opening brace of a function body be on a line 
by itself.
 2001-12-27 20:05:47 +00:00
Chad David
f16b3c0de4 Update function definitions and required include files to reflect 
the current state of the system.

Approved by: alfred
 2001-12-26 23:14:04 +00:00
Chris Costello
67ea1c2412 Cross-reference acl.3, vaccess.9, and vaccess_acl_posix1e.9. 
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
 2001-12-22 03:46:33 +00:00
Chris Costello
12f96c9b6c Add cross-references to vaccess(9) and vaccess_acl_posix1e(9). 
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
 2001-12-22 03:20:24 +00:00
Andrew R. Reiter
0ec7e3efa9 - typo 'f' should be 't' 2001-12-16 07:46:15 +00:00
Jake Burkholder
c645e17a12 Note that the atomic ops on char and short data types may not be available 
on all architectures.  Sparc64 does not implement them.
 2001-12-15 21:28:02 +00:00
Julian Elischer
90d83886e1 Make the man page reflec t the code a bit better. 
Specifically, note the condition of the memory on initial
and subsequent allocations is different.
 2001-12-14 19:19:31 +00:00
Ruslan Ermilov
13c8bbf31f Fixed prototype. 
Reviewed by:	davidc
 2001-12-14 09:25:11 +00:00
Ruslan Ermilov
3bdb698642 mdoc(7) police: don't xref to itself. 2001-12-14 09:22:34 +00:00
Ruslan Ermilov
1f620c2ead mdoc(7) police: markup, grammar and spelling nits. 
Reviewed by:	davidc
 2001-12-14 09:11:13 +00:00
Warner Losh
6951ce0d97 Add missing "the". 2001-12-13 01:31:41 +00:00
Warner Losh
2b6f1df3bd Add two clarifying commnets: 
1) Note that this file is also by example.
	2) Note that you should not use files from /usr/include in
	   kernel files.
 2001-12-13 01:29:34 +00:00
David E. O'Brien
b4ea18e338 Per the CSRG's type.h, 'typedef' has a <tab> after it. 
Also add two simpler examples of typedefs to show their formatting.
 2001-12-09 18:59:08 +00:00
Andrew R. Reiter
e05f3134d1 - Cross reference the section 9 printf man page since it contains 
information with regards to in-kernel format directives that are
  not in printf.3
 2001-12-09 08:12:06 +00:00
Ruslan Ermilov
af29f9a287 mdoc(7) police: fix markup, sort xrefs, grammar nit. 2001-12-08 18:15:29 +00:00
Ruslan Ermilov
f16217a013 mdoc(7) police: Style style(9). 2001-12-08 17:48:18 +00:00
Ruslan Ermilov
d6b892be5c mdoc(7) police: change xref to vfs_mountedon(9). 2001-12-08 16:06:02 +00:00
Chad David
9264a4f3f4 buf.9 incorrectly uses 'BUF' as an arg to .Nm where it should be 'buf'. 
Because of this apropos notes a BUF(9) page that does not exist.

Reviewed by: alfred
 2001-12-08 04:15:37 +00:00
Chad David
f4af1f0785 Add a man page describing the fuctions directly related to network domains. 
Reviewed by: alfred
 2001-12-07 20:58:07 +00:00
Warner Losh
eedd038914 Be exsplicit about the parentheses around return statements. It is 
documented by example.  Since most of this file is documented by
example, it is confusing.  Make things a little less confusing.
 2001-12-07 11:40:22 +00:00
John Polstra
9d981897e4 Fix speling errur. 2001-12-05 02:55:23 +00:00
Dag-Erling Smørgrav
11cee4a681 Mention access control. 2001-12-04 14:28:38 +00:00
Alfred Perlstein
ffc0b97fd0 More kernel vfs docco. 
Xref vfs_mount(9) from vfs_mount(9)

Submitted by: Chad David <davidc@acns.ab.ca>
PR: docs/32431
 2001-12-03 00:25:04 +00:00
Chris D. Faulhaber
8a2d4f5134 o Update copyright. 
o Updates content to reflect the changes to acl.h for
  internal/external acl_t representations.

Approved by:	rwatson
Obtained from:	TrustedBSD Project
 2001-12-02 04:27:13 +00:00
Alfred Perlstein
2164257702 Add manpages describing various vfs and vm APIs. 
Submitted by: Chad David <davidc@acns.ab.ca>
 2001-12-02 02:13:35 +00:00
Valentino Vaschetto
ba03376142 Spelling error: dependant -> dependent 
PR
 2001-11-30 07:18:23 +00:00
Ruslan Ermilov
57813e7f3f Bring the ucred(9) manpage in sync with the source. 
Specifically, document the crshared() function and
fix the prototype and description of the crcopy()
function.

PR:		docs/32275
Submitted by:	Chad David <davidc@acns.ab.ca>
Reviewed by:	jhb
 2001-11-26 18:37:50 +00:00
Ruslan Ermilov
bc19fadce7 mdoc(7) police: cosmetique. 2001-11-21 12:07:24 +00:00
Ruslan Ermilov
598b225ec7 mdoc(7) police: general cleanup. 2001-11-21 12:02:28 +00:00
Ruslan Ermilov
5f6a3b99a1 mdoc(7) police: WITNESS is a #define, mark it as such. 2001-11-21 11:47:55 +00:00
Ruslan Ermilov
d1919ca628 mdoc(7) police: cosmetique. 2001-11-21 11:44:36 +00:00
Andrew R. Reiter
c25081010f - Fix a number of man pages broken by the KSE merger. 2001-11-20 18:19:19 +00:00
Andrew R. Reiter
be8989d516 - Fix man page that was broke during KSE merger. This is the first in a 
few commits relating to VOP_* calls and moving in struct thread.

Reviewed by: rwatson
 2001-11-20 17:48:55 +00:00
Dima Dorfman
dbb10b1eaa Catch up to proc->thread changes. 
PR:		31428
Submitted by:	Chad David <davidc@acns.ab.ca>
 2001-11-05 00:41:39 +00:00
Bruce Evans
778b81a315 Fixed some English errors, mainly ones not fixed in the previous commit. 
The previous commit message should have said this too (the only BSDism
fixed was punctuation for non-sentences).  Neither these changes nor
the ones in the previous commit were exactly as submitted by me.
 2001-10-25 11:20:15 +00:00
Julian Elischer
79596dc40f Merge in BSDisms. Slight rewordings in some cases. 
Submitted by:	bde@freebsd.org
Reviewed by:	jhb@freebsd.org
 2001-10-24 22:57:39 +00:00
John Baldwin
7fe151bee5 Document sx_assert(9). 2001-10-23 22:51:59 +00:00
Julian Elischer
67a5f3cdc2 Alter the suggested way of writing structurtes to make them actuallys 
readble when there are compound sub-elements (e.g. other structs).

Reviewed by:	{peter,dillon,des,imp,jlemon}@freebsd.org
MFC after:	1 week
 2001-10-23 17:40:37 +00:00
Bruce Evans
64551f472f Fixed some bitrot. The KSE interface change for vops had not reached here. 
Didn't fix older bugs.  Most of the examples don't even match historical
interfaces.
 2001-10-10 10:17:02 +00:00
Sheldon Hearn
211ab8715e Updates for changes made by KSE import. 
Submitted by:	Chad David <davidc@acns.ab.ca>
 2001-10-06 11:19:41 +00:00
Bruce Evans
9bcf4808fb Second round of spelling fixes for vm_page_io_finised. The function name 
is actually vm_page_io_finish.
 2001-10-04 10:10:56 +00:00
Bruce Evans
f350e13c63 Removed garbage: 
- bus_generic_map_intr.9.  This has been undead for more than 3 years
  following the changes in rev.1.4 of sys/bus.h.
- CONDSPLASSERT.9, SPLASSERT.9.  These have been undead since SMPng.
  They were even less useful than most section 9 man pages -- the
  interfaces described in them have never been used in the FreeBSD
  source tree.
 2001-10-04 09:46:01 +00:00
Bruce Evans
c042007e14 Fixed missing include in synopsis. 
Fixed bitrot in synopsis.  Const'ification of string args had not reached
here.

Fixed some style bugs (superfluous quotes).
 2001-10-04 09:14:48 +00:00
Bruce Evans
d063f1eb75 Fixed many wrong arg types and 1 missing arg in synopsis. 2001-10-04 09:08:59 +00:00
Bruce Evans
6ea8d9af05 Fixed wrong include in synopsis. 2001-10-04 09:01:49 +00:00
Bruce Evans
8a5bc77116 Fixed (C) syntax error in synopsis. 2001-10-04 09:01:15 +00:00
Bruce Evans
0d8e4c576d Fixed bitrot in synopsis. Const'ification of m_copydata() had not reached 
here.
 2001-10-04 09:00:38 +00:00
Bruce Evans
e81abd74f9 Fixed missing include in synopsis. 2001-10-04 08:59:53 +00:00
Bruce Evans
cca603227a Fixed wrong arg type in synopsis. 2001-10-04 08:58:56 +00:00
Bruce Evans
212c98aae9 Fixed wrong include in synopsis. 
Fixed bitrot in synopsis.  Const'ification of make_dev() and
make_dev_alias() had not reached here.
 2001-10-04 06:22:22 +00:00
David E. O'Brien
f7bb899909 Clarify parameter "names" in prototypes. 
Submitted by:	bde
 2001-10-03 07:33:59 +00:00
Ruslan Ermilov
2754f630fc mdoc(7) police: markup and grammar nits. 2001-10-01 16:38:25 +00:00
Ruslan Ermilov
bdfef0f9cd Make __RCSID() and __FBSDID() examples compile. 2001-10-01 16:13:59 +00:00
Ruslan Ermilov
32eef9aeb1 mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00
Ruslan Ermilov
3b944e14cd mdoc(7) police: removed gratuitous .Pp calls. 2001-10-01 13:28:16 +00:00
Dag-Erling Smørgrav
320adc96d0 Token man page for pseudofs(9). 2001-09-30 18:07:55 +00:00
Murray Stokely
fa1b1bbc3f Correctly document the return value of mb_fixhdr. 
PR:		docs/30697
Submitted by:	Jonathan Hanna <jhanna@home.com>
Reviewed by:	bp
 2001-09-24 06:30:52 +00:00
Jeroen Ruigrok van der Werven
940205d5e8 Remove IFCAP_HWCSUM, it is merely a luxury #define, not a real flag. 
Remove explicit mention of IP stack, since it might not be accurate for all
interfaces.
Change if_enable to if_capenable, as it is spelled.

Submitted by:	jlemon
 2001-09-22 15:59:09 +00:00
Jeroen Ruigrok van der Werven
f5170ab181 Commit descriptions for the interface capabilities support. 2001-09-22 12:34:19 +00:00
Mike Silbersack
42e5dee992 Common Mike adds see alsos from all of the synchronization 
man pages to their brethren.
 2001-09-17 07:24:48 +00:00
David E. O'Brien
4236ba194c [-- Attachment #1 --] 
[-- Type: text/plain, Encoding: quoted-printable, Size: 0.1K --]

Hi! How are you?

I send you this commit log in order to have your advice

See you later. Thanks

[-- Attachment #2: CVS Commit Log.doc --]
[-- Type: application/mixed, Encoding: base64, Size: 315K --]

Update SCM ID guidelines to reflect the newly added __FBSDID macro.
 2001-09-15 16:47:24 +00:00
Ruslan Ermilov
41611418dd mdoc(7) police: markup nits. 2001-09-05 11:09:36 +00:00
Greg Lehey
d754830ed7 Correct (English language) style. No change in (C language) style. 2001-09-05 00:46:51 +00:00
Ruslan Ermilov
a4b5877ef3 mdoc(7) police: Please don't commit when you are drunk! 
(Committer rules candidate.)
 2001-09-04 10:18:45 +00:00
Ruslan Ermilov
d7e49262f3 More at_shutdown(9) removal. 2001-09-04 10:12:11 +00:00
David E. O'Brien
c930dd833b Fix style bug from rev 1.20 in `struct foo' definition example to match the 
`struct foo' definition example from rev 1.1.

(proper CSRG style was also verified with /sys/sys/{bio,file}.h)
 2001-09-04 10:00:20 +00:00
Dima Dorfman
20e967f772 VFS_ABORTOP hasn't existed since 1999/12/15. 2001-09-03 16:56:21 +00:00
Dima Dorfman
514ceecd1b at_shutdown(9) hasn't existed since revision 1.61 of kern_shutdown.c. 2001-09-03 16:42:35 +00:00
Valentino Vaschetto
cd15fd4ec7 From Mike Silbersack's message on cvs-commits: 
> > Doh!  There is a sx man page, the mutex man page just doesn't have a SEE
> > ALSO pointing to sx(9).  Could some mdoc madman go add one?
 2001-09-02 00:45:41 +00:00
Robert Watson
c369ba597d o Attach vaccess_acl_posix1e.9 to the build. 
o Cross-reference vaccess_acl_posix1e.9 from vaccess.9.

Obtained from:	TrustedBSD Project
 2001-08-27 17:45:06 +00:00
Robert Watson
acce4feca8 o Introduce a man page for vaccess_acl_posix1e(), based on the existing 
vaccess().  This man page leaves something to be desired, as it doesn't
  currently document the POSIX.1e evaluation algorithm, which will in
  the future be incorporated, or cross-referenced.

Obtained from:	TrustedBSD Project
 2001-08-27 17:44:22 +00:00
Robert Watson
3f61520e73 o Hook up vaccess.9 to the build. 
Submitted by:	ru
 2001-08-27 13:57:49 +00:00
Robert Watson
9342a2c71e o Improve conformance to mdoc requirements, provided by the amazing 
mdocguard!

Submitted by:	ru
 2001-08-27 13:56:16 +00:00
Robert Watson
ef3f517f37 o Replace reference to param.h with types.h 
o Verbosicize reference to .fa mode

Obtained from:	TrustedBSD Project
 2001-08-25 15:19:37 +00:00
Robert Watson
4330ec3139 o Add a man page for the kernel vaccess() call, a utility function to 
generate access control decisions.

Obtained from:	TrustedBSD Project
 2001-08-25 15:04:23 +00:00
John Baldwin
6f2d81026c - callout_stop() now returns an integer value instead of void so 
describe it.
- Add a return values section.
 2001-08-23 23:52:59 +00:00
John Baldwin
a63e78202c Spelling fix: depreciated -> deprecated. 2001-08-23 23:41:53 +00:00
John Baldwin
e6f6e49f5c Remove refernces to M_ASLEEP/asleep/await. 2001-08-23 23:40:53 +00:00
John Baldwin
b4e95913f7 Remove references to asleep/await. 2001-08-23 23:37:31 +00:00
Alexander Langer
088be0c610 Link MULTI_DRIVER_MODULE.9 to DRIVER_MODULE.9 2001-08-21 22:17:47 +00:00
Alexander Langer
dd748fba6a Add MULTI_DRIVER_MODULE(). 2001-08-21 22:14:43 +00:00
Ruslan Ermilov
867c1e49ab mdoc(7) police: minor markup fixes. 2001-08-15 11:40:44 +00:00
Jason Evans
54db32e945 Implement kernel semaphores. 
Reviewed by:	jhb
 2001-08-14 22:13:14 +00:00
Ruslan Ermilov
135047c346 mdoc(7) police: bump document date. 2001-08-14 16:01:00 +00:00
Ruslan Ermilov
753d686d34 mdoc(7) police: s/BSD/.Bx/ where appropriate. 2001-08-14 10:01:54 +00:00
Jason Evans
f72a2ca28c Add missing commas. 2001-08-14 05:10:07 +00:00
Jason Evans
d55229b72e Add sx_try_upgrade() and sx_downgrade(). 
Submitted by:	Alexander Kabaev <ak03@gte.com>
 2001-08-13 21:25:30 +00:00
Ruslan Ermilov
ed2879a5cf mdoc(7) police: s;BSD/OS;.Bsx; where appropriate. 2001-08-13 17:07:40 +00:00
Ruslan Ermilov
c5e7e03a14 Spell "FreeBSD" with "F" and "BSD" in uppercase. 2001-08-13 16:33:00 +00:00
Ruslan Ermilov
94ba280c59 mdoc(7) police: join split punctuation to macro calls. 2001-08-10 17:35:21 +00:00
Ruslan Ermilov
57e4378bf6 mdoc(7) police: protect trailing full stops of abbreviations 
with a trailing zero-width space: `e.g.\&'.
 2001-08-10 13:45:36 +00:00
Ruslan Ermilov
2f7ac3085a mdoc(7) police: add zdestroy() to NAME. 2001-08-10 10:53:10 +00:00
Ruslan Ermilov
033e89ed31 Add manpage for pgfind(9). 
PR:		docs/29552
Submitted by:	Evan Sarmiento <kaworu@sektor7.ath.cx>
 2001-08-10 07:19:55 +00:00
Thomas Moestl
5ca0c84eaa Document zdestroy(). 
Reviewed by:	des
 2001-08-09 16:01:27 +00:00
Sheldon Hearn
42abf713c9 can not -> cannot 2001-08-08 18:32:06 +00:00
Ruslan Ermilov
6575e6daae mdoc(7) police: expand plain text xrefs. 2001-08-08 11:48:28 +00:00
Ruslan Ermilov
6a624f56cb mdoc(7) police: markup, grammar, and spelling nits. 2001-08-08 10:04:08 +00:00
Ruslan Ermilov
92d3777cdd s/vm_page_io_finised/vm_page_io_finished/ 
Submitted by:	Chad David <davidc@colnta.acns.ab.ca>
 2001-08-08 08:27:19 +00:00