Commit Graph

938 Commits

Author SHA1 Message Date
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