Commit Graph

1041 Commits

Author SHA1 Message Date
Pawel Jakub Dawidek
9a7e557610 Update manual pages: the name of function g_access_rel() has
changed to g_access().

Approved by:	scottl (mentor)
2004-02-13 08:42:10 +00:00
Pawel Jakub Dawidek
16710e88da Create symbolic link for g_print_bio(9) manual page.
Approved by:	scottl (mentor)
2004-02-11 18:43:20 +00:00
Pawel Jakub Dawidek
462b8db96b Document g_print_bio() function.
Approved by:	scottl (mentor)
2004-02-11 18:36:31 +00:00
Pawel Jakub Dawidek
eb4f5d9df6 Added GEOM kernel API manuals to the build.
Reviewed by:	scottl
Approved by:	phk, scottl (mentor)
2004-02-11 10:09:17 +00:00
Pawel Jakub Dawidek
f827ccb9a3 Added first part of GEOM kernel API manuals pages.
Documented function and macros are:
	- DECLARE_GEOM_CLASS(),
	- g_attach(),
	- g_detach(),
	- g_new_bio(),
	- g_clone_bio(),
	- g_destroy_bio(),
	- g_new_consumer(),
	- g_destroy_consumer(),
	- g_read_data(),
	- g_write_data(),
	- g_post_event(),
	- g_waitfor_event(),
	- g_cancel_event(),
	- g_new_geomf(),
	- g_destroy_geom(),
	- g_new_providerf(),
	- g_destroy_provider(),
	- g_error_provider(),
	- g_provider_by_name(),
	- g_wither_geom().
and more to come.

I want to thanks following people for help with those documents:
	Slawek Zak <zaks@prioris.mini.pw.edu.pl>
	Simon L. Nielsen <simon@FreeBSD.org>
	Pieter de Boer <g.p.de.boer@st.hanze.nl>
and of course
	Poul-Henning Kamp <phk@FreeBSD.org>

Reviewed by:	phk, scottl
Approved by:	phk, scottl (mentor)
2004-02-11 10:06:18 +00:00
Bruce M Simpson
02312219eb Document the functions m_apply() and m_getptr().
Requested by: Maxim Konovalov
2004-02-11 02:39:24 +00:00
John-Mark Gurney
115eec0e6f add verbage about how once BUS_TEARDOWN_INTR returns, the interrupt will
no longer be active or called..

Also document requirement that no mutexes be held across calls to these
functions..

Reviewed by:	jhb, rwatson
2004-02-10 20:34:44 +00:00
Bruce M Simpson
9817b89454 Spelling. 2004-02-10 16:11:08 +00:00
Pawel Jakub Dawidek
8d719eb22e Document new 'what' value for sx_assert(9).
PS. There is a inconsistency in this manual page, because in
    non-WITNESS case sx_assert(9) does not panics, it only prints
    the warning. I haven't fixed this, because jhb@ is planing to
    replace those printf()s with panic()s.

Reviewed by:	jhb
Approved by:	jhb, scottl (mentor)
2004-02-04 08:24:05 +00:00
Brooks Davis
36c19a572a Add the kernel side of network interface renaming support.
The basic process is to send a routing socket announcement that the
interface has departed, change if_xname, update the sockaddr_dl
associated with the interface, and announce the arrival of the interface
on the routing socket.

As part of this change, ifunit() is greatly simplified by testing
if_xname directly.  if_clone_destroy() now uses if_dname to look up the
cloner for the interface and if_dunit to identify the unit number.

Reviewed by:	ru, sam (concept)
		Vincent Jardin <vjardin AT free.fr>
		Max Laier <max AT love2party.net>
2004-02-04 02:54:25 +00:00
Alex Dupre
feccf50ce0 Fix MSIZE definition location.
PR:		docs/62129
Submitted by:	Lee Brotherston <lee@nerds.org.uk> (PR),
		Marc Silver <marcs@draenor.org> (patch)
Approved by:	blackend (mentor)
2004-02-01 22:33:59 +00:00
Robert Watson
2c21af5654 Add debug.mutex.prof.reset. 2004-01-28 22:21:04 +00:00
Maxime Henrion
5251cfab8d Fix another typo. 2004-01-28 13:29:40 +00:00
Maxime Henrion
b4a993e9aa Fix typo. 2004-01-28 13:28:45 +00:00
Warner Losh
ab27179eb9 Fix the example back the way it was. Fix the commentary to say it
allocates a 32 byte range of ioports.
2004-01-27 16:16:31 +00:00
Nate Lawson
ba4594dccd Document my adventures in newbus land. Clarify some examples, especially
that count is in bytes, not bits.  There are some drivers that I think make
this mistake.  (I've seen counts of 16 in the tree).
2004-01-27 06:04:15 +00:00
Yaroslav Tykhiy
5eb4925c66 Document the interface method if_input(). 2004-01-26 12:51:00 +00:00
Dag-Erling Smørgrav
b14fa90f01 mdoc cleanup.
Submitted by:	ru
2004-01-26 12:50:30 +00:00
Yaroslav Tykhiy
dede2093e5 Clearly state that upon SIOCSIFFLAGS, ifp->if_flags is updated
at the common ifioctl() level.
2004-01-26 12:08:23 +00:00
Yaroslav Tykhiy
ac1ac9d76b Extend the description of SIOCSIFCAP. 2004-01-26 11:48:26 +00:00
Dag-Erling Smørgrav
72ea4f788b Add more implentation notes based on the comments in sys/conf/NOTES. 2004-01-25 12:30:35 +00:00
Dag-Erling Smørgrav
f11986fab2 Add a cross-reference to MUTEX_PROFILING(9). 2004-01-25 12:24:23 +00:00
Dag-Erling Smørgrav
77c36c1710 Add a manual page for the mutex profiling code. 2004-01-25 12:23:53 +00:00
Dag-Erling Smørgrav
09e0653941 I don't normally use my middle name, so remove it from attributions in
man pages (though not from copyright notices).  While I'm here, add email
addresses where appropriate.
2004-01-25 11:39:42 +00:00
Yaroslav Tykhiy
d4030ed6c5 Extend the description of the framework of interface capabilities. 2004-01-22 00:10:21 +00:00
Yaroslav Tykhiy
76f80df62e As I've been pointed out by Andrew Gallatin, there are some
network interface cards smart (or twisted?) enough to be able
to calculate a TCP/UDP checksum for a packet fragmented by the
host CPU.  Therefore the paragraph on the case has been revised.
2004-01-21 23:32:50 +00:00
Yaroslav Tykhiy
fbde705ac4 A couple of minor clarifications. 2004-01-21 13:17:24 +00:00
Yaroslav Tykhiy
0193eb5ee9 Add a description for the hardware-assisted checksumming
facilities based on http://people.freebsd.org/~jlemon/csum.txt
and my own observations.
2004-01-21 12:45:37 +00:00
Ruslan Ermilov
b760de9691 Use a single style for share/man/ makefiles:
- Sort MAN and MLINKS in "dictionary" order ignoring case.

- For multi-value MAN and multi-pair MLINKS, put each value/pair
  on its own line, for easier sorting and so that further diffs
  are easier to see.
2004-01-20 10:27:23 +00:00
Yaroslav Tykhiy
238d9c5975 Reformat the list of essential mbuf fields according
to the nice style used in ifnet(9).
This includes specifying field types, starting descriptions
with a capital letter, and ending them with a full stop.
Improve the language a bit, as well.
2004-01-18 23:42:28 +00:00
Yaroslav Tykhiy
d2b7305939 Update the list of mbuf types from <sys/mbuf.h>. 2004-01-18 21:29:46 +00:00
Yaroslav Tykhiy
f434362a8a Update the list of possible mbuf flags from <sys/mbuf.h>. 2004-01-18 21:23:30 +00:00
Robert Watson
480a1cc8ef Minor typo: no line break after .Fn. 2004-01-11 19:57:42 +00:00
Robert Watson
9b1faf0afb Add a basic manpage for vn_fullpath().
Sponsored by:	DARPA, McAfee Research
2004-01-11 19:54:48 +00:00
Dag-Erling Smørgrav
91c9d24e52 Move the description of sbuf_delete() closer to the description of
sbuf_new(), and try to make them both a little clearer.
2004-01-09 21:16:31 +00:00
Simon L. B. Nielsen
d42944a1b8 Add missing manual page links for rman(9) and sysctl_add_oid(9).
Submitted by:	Lukas Ertl <l.ertl@univie.ac.at>
PR:		docs/60088
2004-01-09 20:15:51 +00:00
Scott Long
24b4e9d17f Document taskqueue_enqueue_fast() 2004-01-02 07:23:40 +00:00
Joseph Koshy
de77c1ba47 Add "options INVARIANTS" and "options INVARIANT_SUPPORT" to the
synopsis, with supporting text in the body of the manual page.

Add a cross-reference to panic(9) for completeness.

Reviewed by:	ru (synopsis changes)
2004-01-01 05:16:35 +00:00
Joseph Koshy
735adf63e4 Use of the MTX_SYSINIT macro requires the inclusion of <sys/kernel.h>. 2003-12-28 01:39:18 +00:00
Joseph Koshy
6c0f2b530e Make this manual page reflect the sources better.
- A #include of <sys/mutex.h> is no longer needed to use sx(9) (since
  2001/05/01).
- Use of the SX_SYSINIT() macro requires inclusion of '<sys/kernel.h>'
2003-12-28 01:37:48 +00:00
Joseph Koshy
2d8d6274dc Improve continuity of text. 2003-12-27 14:01:08 +00:00
Peter Pentchev
a61f15043c Fix a couple of typos: hexidecimal -> hexadecimal.
Reviewied by:	scottl
2003-12-12 11:08:51 +00:00
Joseph Koshy
385032f901 Typo fix. 2003-12-11 13:30:26 +00:00
Joseph Koshy
f096643b2d Document a few kernel functions and the sysctl tunables that
affect their behaviour.
2003-12-11 13:29:05 +00:00
Mike Makonnen
8c307294e6 Grammar 2003-12-09 09:04:45 +00:00
Scott Long
4fb638c329 Add a manual page for the consolidated debugging commit. 2003-12-07 20:48:00 +00:00
Tom Rhodes
53b2520d01 Remove an extra 'for' in the HISTORY section. 2003-11-15 14:23:48 +00:00
Tony Finch
f004a9739c Better English usage.
Submitted by: wollman
2003-11-12 10:53:52 +00:00
Hiten Pandya
dab12c8eba Manual page for Asynchronous Logging Queues (ALQ) facility.
The manual page contains enough information to get someone started
with ALQ.

MLINKS have been added appropriately.

Approved by:	jeff, des
Reviewed by:	des, jeff, sam, brooks, rwatson, mtm
2003-11-10 22:45:09 +00:00
Tony Finch
e19cd0127b Clarify the rule about structure typedefs being discouraged, following
a discussion on src-committers.
2003-11-10 14:32:13 +00:00