Commit Graph

1227 Commits

Author SHA1 Message Date
Scott Long
2da554d8f2 Small grammar fix. 2004-07-02 15:52:44 +00:00
Bruce Evans
00ff1f7c0a Fixed a style bug in the previous commit. 2004-06-26 09:02:44 +00:00
David E. O'Brien
7549cb8489 Embellish the getopt(3) example with mixed case.
Reviewed by:	bde
2004-06-26 05:15:00 +00:00
Lukas Ertl
05344e57f6 Catch up with the dev_t -> struct cdev change. 2004-06-22 20:18:15 +00:00
Mike Pritchard
2988974b58 Spelling fixes. 2004-06-21 14:11:45 +00:00
Ruslan Ermilov
d07b8cff88 Markup fixes. 2004-06-16 15:57:59 +00:00
Ruslan Ermilov
fa08fb73a5 Tiny markup fixes. 2004-06-16 15:47:45 +00:00
Ruslan Ermilov
bf7f20c2b6 Assorted markup, spelling, and grammar fixes. 2004-06-16 08:33:57 +00:00
Ruslan Ermilov
1c83e80830 Overhaul the markup. 2004-06-15 19:26:11 +00:00
John Polstra
adc0f4a221 Update the .Dd date for previous commit.
Gently nudged by:	krion
2004-06-14 18:33:21 +00:00
John Polstra
4717d22a7c Change the return value of sema_timedwait() so it returns 0 on
success and a proper errno value on failure.  This makes it
consistent with cv_timedwait(), and paves the way for the
introduction of functions such as sema_timedwait_sig() which can
fail in multiple ways.

Bump __FreeBSD_version and add a note to UPDATING.

Approved by:	scottl (ips driver), arch
2004-06-14 18:19:05 +00:00
Lukas Ertl
63b3701deb What world have we come to when even style(9) isn't unfailable:
correct style nit in an example.
2004-06-13 21:24:56 +00:00
Yaroslav Tykhiy
fe96d560de Touch .Dd (date) since new functionality has been documented.
Reminded by:	ru
2004-06-08 09:54:53 +00:00
Yaroslav Tykhiy
429fa51d7c Make the legend to the table of interface flags compact
for the reader's convenience.

Suggested by:	ru
2004-06-08 09:01:37 +00:00
Yaroslav Tykhiy
4c829e7560 Describe how polling(4) applies to network interfaces.
Reviewed by:	ru
2004-06-08 08:48:49 +00:00
Yaroslav Tykhiy
e06e6ff9bc 1. There are interface capabilities to be used by "lower" kernel
components as well, i.e., polling.

2. Stress that if_capenable should be modified only from within
   the interface driver because it solely knows about how to control
   the capabilities.
2004-06-07 16:46:28 +00:00
Pawel Jakub Dawidek
f0f26fe5ac Add missing link. 2004-06-06 13:35:37 +00:00
Christian Brueffer
92e7a6c6aa Fix spelling 2004-05-25 17:02:20 +00:00
Ruslan Ermilov
2c88a61c15 Forgot to bump the document date, *blush*. 2004-05-20 09:52:48 +00:00
Ruslan Ermilov
e85cc3f560 Document mbuf tags based on the OpenBSD manpage.
Submitted by:	Gleb Smirnoff
2004-05-20 09:34:19 +00:00
David Malone
83676de9d5 Add a man page for the kernel part of bpf. I made some edits to the
man page after Orla, so the mistakes are probably mine. Leave a
note on the door welcoming the mdoc police.

Submitted by: Orla McGann <orly@cnri.dit.ie>
2004-05-19 20:39:22 +00:00
Lukas Ertl
d8a224e86b An access count change is a prerequisite for doing I/O, so
change 'or' to 'and'.

Pointed out by:  pjd@
2004-05-18 12:37:47 +00:00
Lukas Ertl
a2d7d4d7c6 These hyphens don't need to be escaped.
Pointed out by:  pjd@
2004-05-18 12:36:12 +00:00
Lukas Ertl
797bac4b53 Fix spelling errors (I forgot that one in my last commit of GEOM man pages). 2004-05-18 12:12:07 +00:00
Lukas Ertl
eaad868d16 Update several GEOM related manual pages:
*) Fix spelling errors.
  *) Better english.
  *) Re-phrasing.

Not Reviewed by:  pjd (one week timeout)
Approved by:      grog (mentor)
2004-05-18 11:33:37 +00:00
Hiten Pandya
11053af551 Add rman_get_device(9) to SYNOPSIS, .Nm and MLINK it to
rman(9).
2004-05-17 21:25:02 +00:00
Hiten Pandya
a1bd700ab1 mdoc(7) police:
* remove an extra comma at the end of the .Nm list
2004-05-14 16:57:27 +00:00
Warner Losh
1c1bc2f7f7 Add some verbage over the difference between BUS_ADD_CHILD and
device_add_child.  The former calls the latter.

Pointed out by: jhb
2004-05-13 20:54:49 +00:00
Warner Losh
a1013c5773 o Add cautions about multiple adds of the device
o Remove setting the description of the device (that is more properly done in
  probe).
o Remove setting the driver, as it is unnecessary
o Add pseudo code to ensure that the device isn't added to the tree already.
o remove some now unreferenced routines
2004-05-13 20:31:05 +00:00
Warner Losh
cf39dca90c Add caveats about adding devices in the IDENTIFY context. 2004-05-13 20:29:40 +00:00
Warner Losh
aebc6093f9 The DEVICE_IDENTIFY man page refers to this, create a dummy one
directing people to device_add_child.
2004-05-13 20:28:18 +00:00
Hiten Pandya
2db6331792 Add a comma after `e.g.', so that mdoc does not add two whitespaces
automatically.

Noticed by: 	Ruslan Ermilov <ru at FreeBSD.org>
2004-05-11 14:13:52 +00:00
Hiten Pandya
2b55fc2e9c Document the 'fdidx' argument of VOP_OPEN(9).
PR:          	56911
Noticed by: 	Jun Su <junsu@m-net.arbornet.org>
2004-05-10 23:17:09 +00:00
Hiten Pandya
b188a3eb74 Correct misinformation, vm_map_remove(9) is the `exported' version of
vm_map_delete(9), not vm_map_remove(9).
2004-05-05 10:59:50 +00:00
Hiten Pandya
d5a8819cb7 mdoc(7) police:
* correctly place parenthisized sentences
	* remove hard sentence breaks
	* use .Vt instead of .Fn
2004-05-05 10:47:19 +00:00
Hiten Pandya
34e82feb02 Make the manual page consistent and add a cross-reference to wakeup(9). 2004-05-05 10:01:06 +00:00
Maxim Konovalov
6c0137067b o Document m_getcl(9).
Submitted by:	Gleb Smirnoff
MFC after:	2 weeks
2004-05-04 14:53:34 +00:00
Maxim Konovalov
01e7fdafa7 o Add a missed description for m_free(9).
Optained from:	NetBSD
MFC after:	1 week
2004-04-28 14:53:49 +00:00
Ruslan Ermilov
ab92d65550 Make whatis(1) happy. 2004-04-16 06:26:09 +00:00
Mark Murray
a8bd95a571 Do a style fixup on the example function. 2004-04-15 07:24:10 +00:00
Warner Losh
565e9d9bc4 Move advise from DEVICE_PROBE.9 about where to probe children. 2004-04-11 06:37:50 +00:00
Warner Losh
a545630488 Document more clearly that a probe routine:
Should have no side effects
	Must not hold resources when it returns
	May be called multiple times if it returns < 0.

Remove the bad advise that the probe routine should look for children
for devices that implement busses.  This is more properly reserved for
the attach routine.
2004-04-11 06:37:21 +00:00
Colin Percival
2c1bb20746 Introduce a callout_drain() function. This acts in the same manner as
callout_stop(), except that if the callout being stopped is currently
in progress, it blocks attempts to reset the callout and waits until the
callout is completed before it returns.

This makes it possible to clean up callout-using code safely, e.g.,
without potentially freeing memory which is still being used by a callout.

Reviewed by:	mux, gallatin, rwatson, jhb
2004-04-06 23:08:49 +00:00
Mark Murray
dccd431fa6 Fix some syntax errors in examples. These were discovered when trying
to follow the examples concerned.
2004-04-06 20:16:10 +00:00
Ruslan Ermilov
df4956d2a4 - Overdue bump of the document date.
- Fixed markup.
- Minor wordsmithing.
2004-04-06 19:49:21 +00:00
Ruslan Ermilov
f48cbcdecc Assorted mdoc(7) fixes. 2004-04-01 07:54:27 +00:00
Mike Silbersack
bdf861859a Fix last commit to conform to mdoc style.
Submitted by:	hmp
2004-04-01 07:36:56 +00:00
Mike Silbersack
a61bc764ce Document the m_defrag function. (Mostly copied from the description
in uipc_mbuf.c)
2004-04-01 06:50:21 +00:00
Bruce M Simpson
0c22b2b981 Add David Young's descriptive text for the radiotap interface.
Add David Young to copyright comments.
2004-03-31 02:57:30 +00:00
Hiten Pandya
bc216e3cd2 Mdoc Police:
* Use .Fa instead of .Pa for function arguments.

	* Utilize the .Po/.Pc commands for parenthesis
	  so the format is not ruined.

Inspired by: pjd's last commit to this file
2004-03-29 19:42:21 +00:00
Pawel Jakub Dawidek
449dfbbc83 Note that we can pass NULL as 4th argument for copystr() and copyinstr()
functions.

With little mdoc(7) help from:	hmp
2004-03-29 19:23:45 +00:00
Pawel Jakub Dawidek
030f6f3558 The topology lock is not needed for g_error_provider() function.
Discussed with:	phk
2004-03-24 15:12:17 +00:00
Pawel Jakub Dawidek
67e4206588 Added a note, that g_access() function cannot failed when dc[rwe] <= 0. 2004-03-24 14:42:26 +00:00
Pawel Jakub Dawidek
06bb88dcb2 Functions:
- g_new_geomf(),
	- g_new_providerf(),
	- g_new_consumer()

cannot failed (by returning NULL), so don't scare programmers.
2004-03-24 14:25:46 +00:00
Nate Lawson
bdffb39f34 Add bus_alloc_resource_any(9), which does bus_alloc_resource() with the
appropriate default values.  Document it in the manpage.

Submitted by:	Mark Santcroos <marks@ripe.net>
Reviewed by:	imp, dfr, bde
Abstains:	bde
2004-03-17 17:40:34 +00:00
Don Lewis
ec0791be40 Change len pararmeter from u_int to size_t.
Document vslock() return values.
2004-03-15 10:05:27 +00:00
John Baldwin
bf0e60bbbb Rewrite sleepqueue manpage to catch up to the new sleep queue interface. 2004-03-12 19:07:18 +00:00
Pawel Jakub Dawidek
378f3f5a17 mdoc(7): New sentence should start on new line.
Pointed out by:	hmp
2004-03-11 22:22:03 +00:00
Pawel Jakub Dawidek
8217df6de8 Add reference to the g_access(9) manual page. 2004-03-11 19:53:22 +00:00
Pawel Jakub Dawidek
9e5681745a Connect g_access(9) to the build. 2004-03-11 19:51:14 +00:00
Pawel Jakub Dawidek
dde2befebc Add manual page for g_access(9) GEOM function. 2004-03-11 19:23:48 +00:00
John Baldwin
f5531a094d - Document cv_broadcastpri().
- Remove references to cv_waitq_*() as they no longer exist.
2004-03-10 15:57:25 +00:00
Bruce M Simpson
017b3034bd Update pmap_pinit(9) to reflect pmap_pinit2() removal by alc. 2004-03-08 15:07:14 +00:00
Josef El-Rayes
2cd7fe4dc1 Document kernel functions securelevel_gt and securelevel_ge.
Approved by:            simon(mentor)
Submitted by:           Christian S.J. Peron <maneo@bsdpro.com>
PR:                     docs/62331
mdoc(7) cleanup by:     ru
2004-03-07 15:22:08 +00:00
Joseph Koshy
9cfa00a649 Link in contigmalloc(9) to the build. 2004-03-06 08:01:16 +00:00
Joseph Koshy
d7f29ce72b Cross-reference contigmalloc(9). 2004-03-06 02:13:03 +00:00
Joseph Koshy
c4e99bb025 A manual page for contigmalloc(9).
Reviewed by:	ru
2004-03-06 02:09:17 +00:00
Warner Losh
4eebf56527 Add warning about loading/unloading drivers and identify 2004-03-05 22:21:18 +00:00
Ruslan Ermilov
3cea578f5a This interface doesn't return any values.
Submitted by:	Mark Santcroos
2004-03-05 16:38:01 +00:00
Bruce M Simpson
904fd6bae5 Fix a typo. 2004-03-05 02:50:28 +00:00
Bruce M Simpson
54947b972f Hook ieee80211 manpages up to the build; fix 1 snafu which crept in.
Noticed by:	Matthias Schuendehuette
Pointy hat to:	bms
2004-03-04 21:13:06 +00:00
Bruce M Simpson
48fbb40803 Add an MLINKS entry for radiotap(9). 2004-03-04 12:54:22 +00:00
Bruce M Simpson
3f3f4cdba2 Initial import of documentation for net80211 interface code.
Of particular interest here is the ieee80211_radiotap(9) man page.

TODO: Flesh out ieee80211_node.9, ieee80211_proto.9.

Submitted by:	bms (with help from Darron Broad)
2004-03-04 12:52:10 +00:00
Simon L. B. Nielsen
0e87afb66f - Fix typo.
- Use .Fx when I'm here anyway.

PR:		docs/63622
Submitted by:	Andrew Boothman <andrew@mux.org.uk>
2004-03-01 22:58:07 +00:00
Lukas Ertl
06aed75cac Add MLINKs for MALLOC_DEFINE and MALLOC_DECLARE.
Approved by:     grog (mentor)
2004-02-28 23:01:20 +00:00
Poul-Henning Kamp
2bedf807f4 Add contents to manualpage for generic watchdog facility.
Formatting likely to break several UN resolutions.
2004-02-28 20:08:41 +00:00
Ruslan Ermilov
6e485c0a7a mtod() returns pointer to the specified type, not necessarily "void *". 2004-02-27 17:14:00 +00:00
Dag-Erling Smørgrav
c7ea226dc2 Document sysctl_move_oid(). 2004-02-27 17:13:42 +00:00
Robert Watson
57792ded36 Update copyright on mac.9 for 2004. Use "-" for copyright year
ranges.

Add additional credits for contributions to the MAC Framework.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, McAfee Research
2004-02-26 01:18:46 +00:00
John Baldwin
ab9fe4e1fe - Clarify ambiguous statement about not being able to both slock and xlock
a single lock at the same time.
- Avoid using "own" to refer to holding either a shared or exclusive lock
  as it is only really correct for exclusive locks.
- Reword the sentence about sleep-ability to read easier.

Requested by:	truckman (1)
2004-02-24 21:36:39 +00:00
Nate Lawson
3c8c064683 bus_set_resource takes a rid, not a pointer to a rid. 2004-02-22 00:29:04 +00:00
Ruslan Ermilov
1b2f42a9c7 Improve formatting. 2004-02-19 12:02:54 +00:00
Poul-Henning Kamp
0aef5c8497 Improve contents, ruin formatting. 2004-02-18 22:10:08 +00:00
Maxim Konovalov
ad1218e35e o Be consistent with the declaration: pri -> priority.
Spotted by:	Dmitry Rzhavin
MFC after:	1 week
2004-02-17 13:31:36 +00:00
Dag-Erling Smørgrav
497ddd5807 Back out previous commit due to objections. 2004-02-16 21:36:59 +00:00
Dag-Erling Smørgrav
6f29aba23f Document the change in M_WAITOK semantics. 2004-02-16 18:46:16 +00:00
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
Joseph Koshy
b684398248 Cross-reference pgfind(9) and pfind(9) from each others manual pages. 2003-11-08 13:41:22 +00:00
Dag-Erling Smørgrav
96ea7698a2 device_get_name(9) and device_get_nameunit(9) return const char *, not int. 2003-11-06 15:54:32 +00:00
Warner Losh
562fb1a6dd Remove the file 2003-11-05 04:36:44 +00:00
Warner Losh
302662db50 resource_query_string is dead. Kill it. 2003-11-05 04:36:13 +00:00
Brooks Davis
9bf40ede4a Replace the if_name and if_unit members of struct ifnet with new members
if_xname, if_dname, and if_dunit. if_xname is the name of the interface
and if_dname/unit are the driver name and instance.

This change paves the way for interface renaming and enhanced pseudo
device creation and configuration symantics.

Approved By:	re (in principle)
Reviewed By:	njl, imp
Tested On:	i386, amd64, sparc64
Obtained From:	NetBSD (if_xname)
2003-10-31 18:32:15 +00:00
Hiten Pandya
ed7d11555d Mdoc Janitor:
* Use uppercase for .Dt macro arguments.

  * Use 'manual' instead of 'man' for consistency.
2003-10-24 15:42:38 +00:00
Hiten Pandya
1bc8ec4783 Mdoc Janitor:
* Add a forgotten .An macro for 'Jeroen Ruigrok van der Werven'.

Noticed by:	simon@
2003-10-23 14:32:23 +00:00
Hiten Pandya
09356c8484 Mdoc Janitor:
* Use 'manual' instead of 'man' for consistency.
2003-10-23 06:24:55 +00:00
Hiten Pandya
b9af5c1881 Mdoc Janitor:
* Uppercase the .Dt command contents.

  * Remove incorrect usage of .Fa.

  * Use .Va for struct members, and .Vt for structs
    (correct replacement for .Fa)

  * Markup VM_* and MAP_* macros with .Dv command.

  * Replace 'man' with 'manual' for consistency.
2003-10-23 06:06:33 +00:00
Hiten Pandya
2f6e000a7e Correct #include file in SYNOPSIS:
It is not sys/geom_disk.h, but located under geom/ directory,
    so, mark it geom/geom_disk.h.
2003-10-23 05:47:38 +00:00
Hiten Pandya
aad6efcc96 Mdoc Janitor:
* Uppercase .Dt command contents.

  * Make use of .Fo and .Fc for marking up functions with
    a lot of arguments.

    NOTE: Please do not use the `\' line seperator for mdoc(7)
    manual pages, as it has problems of its own on some displays;
    instead, consult the mdoc(7) manual on using .Fo and .Fc.

  * Change 'man' to 'manual' for consistency.
2003-10-23 05:41:05 +00:00
Hiten Pandya
b02f4e9071 Mdoc Janitor:
* Use the .Sx command for referencing sections.
2003-10-23 05:34:13 +00:00
Hiten Pandya
8d8abf463c Mdoc Janitor:
* Add .Vt in the right places, transform some .Fa to .Vt, depending
    on discussion context.

  * When refering to the function malloc(), use .Fn, and not .Xr.

  * Add `The' to prefix a sentence when describing a function, so
    it results in ``The xxx() function..."

  * Use `system call' instead of `syscall'.

  * Improve the sentence which discusses accept_filt_generic_mod_event();
    Talk about moduledata_t, and refer to the DECLARE_MODULE(9) manual
    page.

  * Properly markup .An (Author Name) throughout the AUTHORS section.
2003-10-23 05:01:30 +00:00
Hiten Pandya
2cb869e075 Mdoc Janitor:
* Make use of .Xr for vput() and vrele() functions.

  * Reword (s/man/manual) in AUTHORS section.
2003-10-23 03:52:07 +00:00