Commit Graph

1551 Commits

Author SHA1 Message Date
Hiten Pandya
5e5cdff0f6 Remove the VFS_START(9) manual page because it's no longer relevant. The
entry point was removed as its only consumer was MFS.

Approved by:	re (hrs)
2005-07-26 23:57:37 +00:00
Craig Rodrigues
0167ce0d1d Fix two small grammar mistakes.
Approved by:	das (mentor)
2005-07-22 00:28:22 +00:00
Poul-Henning Kamp
636d90fc5c Make the facility for recognizing BIOS-signatures more general
and return a printable representation.

This fixes recognition of the PC Engines WRAP and improves the
recognition of the Soekris boards (Bios version can now be
seen in the dmesg output for instance).

Also, add watchdog support for PCM-582x platforms.

Submitted by:	Adrian Steinmann <ast@marabu.ch>
Slightly changed by:	phk
PR:	81360
2005-07-21 09:48:37 +00:00
Hiten Pandya
571dba6ec9 Use 'manual page' instead of 'man page' for consistency.
Approved by:	re (hrs)
2005-06-28 20:15:19 +00:00
Ruslan Ermilov
05c89c23e9 Overhaul the markup.
OK'ed by:	imp
Approved by:	re (blanket)
2005-06-25 08:59:05 +00:00
Ruslan Ermilov
a4be0b3cc1 (Mostly) markup fixes.
Approved by:	re (blanket)
2005-06-16 18:46:17 +00:00
Ruslan Ermilov
4f06896130 Assorted markup fixes and minor wordsmithing.
Approved by:	re
2005-06-15 13:31:23 +00:00
Hiten Pandya
d3f9f75425 Add a cross-reference to the pmap_page_init(9) manual page.
Approved by:	re
2005-06-15 00:21:02 +00:00
Warner Losh
751c35718a Don a flack jacket and start to document the FreeBSD bus_space
implementation.  I took the NetBSD man page, and hacked it to, I hope,
to reflect the preliminary version of the bus space that Justin Gibbs
committed as part of the CAM integration in FreeBSD 3.0.

This isn't perfect, but it is better than we have now (which is, ahem,
nothing).  Please coordinate changes to the file through me through
the 6.0 release.

Approved by: re (blanket for this one file)
2005-06-14 03:40:01 +00:00
Hiten Pandya
30de9c50b0 Update prototype for function pmap_init(), it no longer has the arguments
phys_start and phys_end.

Remove a stale documentation not about dis/uncontiguous memory.

Update manual page date while I am around these ends.

Reviewed by:	alc
2005-06-10 17:19:27 +00:00
Hiten Pandya
27c3fa33d9 Add manual page for newly added pmap_page_init(9) function, part of the
PMAP KPI.

Reviewed-by:	alc
2005-06-10 17:16:16 +00:00
Brooks Davis
fc74a9f93a Stop embedding struct ifnet at the top of driver softcs. Instead the
struct ifnet or the layer 2 common structure it was embedded in have
been replaced with a struct ifnet pointer to be filled by a call to the
new function, if_alloc(). The layer 2 common structure is also allocated
via if_alloc() based on the interface type. It is hung off the new
struct ifnet member, if_l2com.

This change removes the size of these structures from the kernel ABI and
will allow us to better manage them as interfaces come and go.

Other changes of note:
 - Struct arpcom is no longer referenced in normal interface code.
   Instead the Ethernet address is accessed via the IFP2ENADDR() macro.
   To enforce this ac_enaddr has been renamed to _ac_enaddr.
 - The second argument to ether_ifattach is now always the mac address
   from driver private storage rather than sometimes being ac_enaddr.

Reviewed by:	sobomax, sam
2005-06-10 16:49:24 +00:00
Brooks Davis
55d81cdbc0 Add missing Va in ifi_epoch entry. 2005-06-06 00:21:28 +00:00
Hiten Pandya
e36734401f Accomodate for parameter name change, 'cnp' to 'data'.
Submitted-by: 	Andrew R. Reiter <arr@watson.org>
2005-05-24 12:33:29 +00:00
Nate Lawson
96ab794b26 Document that the returned pointer should be freed even if the number
of items returned is 0.
2005-05-20 05:04:22 +00:00
Gleb Smirnoff
fff7ff711b Document taskqueue_drain(). 2005-05-19 18:31:42 +00:00
David E. O'Brien
6ffd2f532c Clarify the header. 2005-05-17 15:03:50 +00:00
Ruslan Ermilov
580325d4cf Recover the original Berkeley RCS id, and fix the description of
format for source files when it comes to $FreeBSD$.
2005-05-17 14:20:42 +00:00
Giorgos Keramidas
b31dd0b724 Remove a duplicate 'comment' to fix the syntax of a sentence. 2005-05-17 01:25:57 +00:00
Sam Leffler
cf82599dcc update for recent api changes 2005-05-01 02:12:44 +00:00
Gleb Smirnoff
f9e6931c3d Manpage for unit allocator functions.
Reviewed by:	phk
2005-04-20 19:11:05 +00:00
Joseph Koshy
265cd33757 Bring API documentation for sleepqueue(9) in sync with the code
in -current.

Reviewed by:	ru
2005-04-19 16:30:25 +00:00
Joseph Koshy
4c49b002e0 Document taskqueue_run_fast(). Markup 'Giant' with ".Va".
Reviewed by:	ru
2005-04-19 16:23:00 +00:00
Robert Watson
e551d45211 Modify the alq(9) alq_open() API to accept a file creation mode, rather
than defaulting the cmode argument to vn_open() to 0.  Supply a default
argument of ALQ_DEFAULT_CMODE (0600) in current callers.

Discussed with/pointed out by:	hmp
Reveiwed by:	jeff, hmp
MFC after:	3 days
2005-04-16 12:12:27 +00:00
Joseph Koshy
3bbf58f9be Add a 'SEE ALSO' section. 2005-04-15 14:46:59 +00:00
Pawel Jakub Dawidek
ba9bc36af1 Add missing links.
MFC after:	2 weeks
2005-04-15 10:57:34 +00:00
Pawel Jakub Dawidek
c5e1d51bcd Create links to crypto.9 for every crypto(9) function.
OK'ed by:	sam
MFC after:	2 weeks
2005-04-09 18:38:54 +00:00
Nate Lawson
f86f6ce6e4 Hook up new man page for devclass_get_drivers() to build
Reminded by:	ru
2005-04-07 17:27:14 +00:00
Nate Lawson
4abfd70c87 Document that devclass_get_maxunit(9) returns one greater than the current
highest unit.

Reviewed by:	dfr
MFC after:	2 weeks
2005-04-04 15:37:59 +00:00
Nate Lawson
fada20b989 Add devclass_get_drivers(9) which provides an array of pointers to driver
instances in a given devclass.  This is useful for systems that want to
call code in driver static methods, similar to device_identify().

Reviewed by:	dfr
MFC after:	2 weeks
2005-04-04 15:26:51 +00:00
Christian Brueffer
63575b5712 Bump .Dd for the previous commit. 2005-03-28 10:28:57 +00:00
Christian Brueffer
c97dc39f02 The make_dev(9) functions no longer handle dev_ts, but struct cdevs.
PR:		78172
Submitted by:	"Wojciech A. Koszek" <dunstan@freebsd.czest.pl>
MFC after:	3 days
2005-03-28 08:57:07 +00:00
John-Mark Gurney
7ac139a904 add m_copyup function.. This can be used to help make our ip stack less
alignment restrictive, and help performance on some ethernet cards which
currently copy the entire packet a couple bytes to get the packet aligned
properly...

Wordsmithing by:	dwhite
Obtained from:	NetBSD (code only)
I'll clean it up later:	rwatson
2005-03-17 19:34:57 +00:00
Warner Losh
f3011a7c10 Clarify that the end argument meaning for rman_reserve_resource_bound
is the highest acceptable value for the ending of the resource being
allocated.  One could also believe that it is the highest starting
value of the resource.  The code definitely expects the former, but I
could find no documentation of this apart from TFSC.
2005-03-15 23:58:55 +00:00
Poul-Henning Kamp
b1b785b27d Mangle a manpage. 2005-03-14 15:38:34 +00:00
John-Mark Gurney
ada6ba6ef3 spell resource correctly...
MFC after:	3 days
2005-03-09 07:56:09 +00:00
Hiten Pandya
97ad30b96a Remove stale information in IMPLEMENTATION NOTES section about alq_open()
using the calling thread's ucred.

While I am there, fix references to my name.
2005-03-09 01:56:48 +00:00
Hiten Pandya
830d03bc97 Make note of the ktrdump(8) utility in the opening paragraph of this
manual page.

Fix indentation of code block in EXAMPLE section so the manual page
can be viewed in a 80 column window.
2005-03-08 01:37:36 +00:00
Christian Brueffer
eafe5f8307 Correct a macro name.
PR:		78171
Submitted by:	"Wojciech A. Koszek" <dunstan@freebsd.czest.pl>
MFC after:	3 days
2005-02-28 02:02:27 +00:00
Brooks Davis
bc9d299133 Change the definition of struct if_data's member ifi_epoch from wall
clock time to uptime because wall clock time may go backwards.

This is a change in the API which will impact SNMP agents who are using
ifi_epoch to set RFC2233's ifCounterDiscontinuityTime.  None are know to
exist today.  This will not impact applications that are using the
<index, epoch> tuple to verify interface uniqueness except that it
eliminates a race which could lead to a false assumption of uniqueness.

Because this is a behavior change, bump __FreeBSD_version.

Discussed with:	re (jhb, scottl)
MFC after:	3 days
Pointed out by:	pkh (way back at EuroBSDCon)
Pointy hat:	brooks
2005-02-25 19:46:41 +00:00
Gleb Smirnoff
4291a5982a Fix prototype for bpf_mtap2().
MFC after:	3 days
2005-02-25 15:58:05 +00:00
Christian Brueffer
64716bfbf4 Connect memguard(9) to the build. 2005-02-22 17:42:12 +00:00
Christian Brueffer
a3256b8880 Xref memguard(9) 2005-02-22 17:20:20 +00:00
Christian Brueffer
f8cd5f23d4 First cut at a manpage for the MemGuard debugging allocator.
most content from:	bmilekic
mdoc lessons by:	ru
2005-02-22 17:18:27 +00:00
Pawel Jakub Dawidek
6201b4ec28 Copyright year update. 2005-02-16 22:24:15 +00:00
Ruslan Ermilov
6009275136 Don't say that mtx_lock() will "sleep" if another kernel thread is
holding the mutex, say it will "block".  Later in this manual page
we say that sleeping while holding a mutex isn't allowed, and this
can be confusing.

Submitted by:	jhb
2005-02-15 23:52:35 +00:00
Ruslan Ermilov
423ac68026 Expand contractions. 2005-02-15 09:27:00 +00:00
Ruslan Ermilov
36a142c455 Expand contractions. 2005-02-13 23:45:54 +00:00
Ruslan Ermilov
59892d33e5 who's -> whose 2005-02-13 23:23:30 +00:00
Ruslan Ermilov
0227791b40 Expand *n't contractions. 2005-02-13 22:25:33 +00:00
Robert Watson
9e95400e5b Add a bit more caveat text about MUTEX_PROFILING -- try to avoid using it
with other profiling and debugging options, such as INVARIANTS, WITNESS,
kernel profiling, etc.  They all interfere with each other nastily and
will generate fairly useless results.
2005-02-11 15:17:57 +00:00
Ruslan Ermilov
6b806d21d1 Fixed the misplaced $FreeBSD$. 2005-02-09 18:07:17 +00:00
Nate Lawson
5b68bf38ab Update device_find_child(9) to return the first matching child if unit
is set to -1.

Reviewed by:	dfr, imp
2005-02-08 18:00:29 +00:00
Ian Dowse
98c926b20f Add a mechanism for associating a mutex with a callout when the
callout is first initialised, using a new function callout_init_mtx().
The callout system will acquire this mutex before calling the callout
function and release it on return.

In addition, the callout system uses the mutex to avoid most of the
complications and race conditions inherent in asynchronous timer
facilities, so mutex-protected callouts have much simpler semantics.
As long as the mutex is held when invoking callout_stop() or
callout_reset(), then these functions will guarantee that the callout
will be stopped, even if softclock() had already begun to process
the callout.

Existing Giant-locked callouts will automatically pick up the new
race-free semantics. This should close a number of race conditions
in the USB code and probably other areas of the kernel too.

There should be no change in behaviour for "MP-safe" callouts; these
still need to use the techniques mentioned in timeout(9) to avoid
race conditions.
2005-02-07 02:47:33 +00:00
Christian Brueffer
f9d04d3672 Remove Xref to nonexistant cap.3
Ok'ed by:	rwatson
MFC after:	3 days
2005-02-05 14:16:35 +00:00
Christian Brueffer
82e9524e14 Xref mac_lomac.4 instead of lomac.4
MFC after:	3 days
2005-02-05 13:36:33 +00:00
Joseph Koshy
a4230398d3 Note that functions alq_flush() and alq_post() should not be called in
contexts where sleeping is disallowed.

Pointed out by:	ru
2005-02-05 02:39:07 +00:00
Pawel Jakub Dawidek
2c7f46173e Improve EIO error description and mention that it can also occur while
writting.

MFC after:	3 days
2005-02-04 11:18:46 +00:00
Joseph Koshy
2f6e95a1d2 Bring the prototype for alq_open() in line with the code.
Add a section on locking.
2005-01-30 10:21:04 +00:00
Ruslan Ermilov
1de7d3e1db Start sentences from a capital letter.
Submitted by:	Joel Dahl
2005-01-29 20:05:07 +00:00
Ruslan Ermilov
cae0500fd4 Fixed whitespace at EOL and double word.
Uncompact enumaration to make it look better.
2005-01-28 21:18:14 +00:00
Ruslan Ermilov
b0536a9ba4 Mark lists as in the rest of section 9 manpages. 2005-01-28 10:48:52 +00:00
Ruslan Ermilov
0a57ea7df2 Mark lists as in the rest of section 9 manpages.
Submitted by:	Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
Ruslan Ermilov
7d64886df5 Add a few colons.
Submitted by:	Joel Dahl
2005-01-26 20:50:52 +00:00
Ian Dowse
641a1aa10d Attempt to describe the race conditions that must be considered
when using the callout subsystem. Show how the callout_pending(),
callout_active() and callout_deactivate() macros can be used to
achieve simpler race-free callout semantics in many situations.
2005-01-23 17:42:48 +00:00
Bruce M Simpson
4d80f75020 Fix markup.
Submitted by:	ru
2005-01-22 21:54:29 +00:00
Bruce M Simpson
bf1639ee7d Add a note about the slot number not necessarily indicating the physical
location of a PCI device in the system chassis.
Remove the note about PAE.
Update document date.
Update my email address.
Update copyright.

MFC after:	1 week
2005-01-22 21:14:46 +00:00
Ruslan Ermilov
ead5223f54 Fixed punctuation in xrefs. 2005-01-21 20:48:00 +00:00
Ruslan Ermilov
feaaabdc8f Fixed xref. 2005-01-21 10:17:17 +00:00
Ruslan Ermilov
9cbda59000 Sort sections. 2005-01-21 08:36:40 +00:00
Gleb Smirnoff
c46f7b9c6f log(9) requires sys/syslog.h.
MFC after:	3 days
2005-01-20 10:26:42 +00:00
Ruslan Ermilov
324cfdb7e8 Use the standard section name. 2005-01-18 20:54:50 +00:00
Ruslan Ermilov
30849b5324 The rest of manpages spell this "PSEUDOCODE". 2005-01-18 20:37:11 +00:00
Christian Brueffer
2d4071ac8f Typo fixes.
MFC after:	3 days
2005-01-18 18:13:03 +00:00
Ruslan Ermilov
87968949e2 Folded two SEE ALSO sections into one. 2005-01-18 09:13:42 +00:00
Scott Long
824f4edf4f Document bus_dmamap_load_mbuf_sg() 2005-01-15 20:50:52 +00:00
Ruslan Ermilov
6a5796e734 Eliminate macro calls inside literal displays. 2005-01-15 12:28:01 +00:00
Ruslan Ermilov
457432e82b Markup fixes. 2005-01-14 20:23:58 +00:00
Ruslan Ermilov
c7d01a0a6f Markup fixes. 2005-01-14 17:22:51 +00:00
Ruslan Ermilov
d7b6d54b15 Markup and grammar fixes. 2005-01-14 10:53:55 +00:00
Ruslan Ermilov
e47b4a138a Markup nit. 2005-01-14 10:49:09 +00:00
Ruslan Ermilov
6b13dcc062 Nits. 2005-01-13 09:33:06 +00:00
Ruslan Ermilov
c0854fb7b2 Scheduled mdoc(7) sweep. 2005-01-12 21:48:25 +00:00
Simon L. B. Nielsen
6821b22557 Document that MODULE_DEPEND does not change runtime initialization
order.

Mostly submitted by:	scottl
Discussed on:		cvs-src/src-committers
2005-01-11 20:56:03 +00:00
Giorgos Keramidas
4b928b1d1f Fix typos and add .Pp after the end of a display to separate the
displayed text from the paragraph right after it.
2005-01-09 22:49:24 +00:00
Giorgos Keramidas
48ef243364 Reorganize the DESCRIPTION section, using .Bl lists to separate the
descriptions of items from each other and have related things appear
in the same nesting 'level'.

The .Fn function/macro, and bump document date.

Reviewed by:	jkoshy
2005-01-07 19:41:00 +00:00
Maxim Konovalov
15575dc0aa Finish src part VFS_INIT.9 removal. Need to check www/. 2005-01-07 15:38:21 +00:00
Giorgos Keramidas
98816b6069 The .Fn macro. 2005-01-07 14:10:59 +00:00
Giorgos Keramidas
5c5c45cfbf The .Fn macro and addition of .Fa in the tag width of the
argument description list.
2005-01-07 14:01:08 +00:00
Giorgos Keramidas
3d5ea0fba4 - The .Fn macro and description of the struct statfs' type of sbp'.
- List of struct statfs fields that are related to file systems, much
  like the list in stat.2 for the userlevel `struct stat'.
- Bump document date.
2005-01-07 12:56:04 +00:00
Giorgos Keramidas
07e11b32af The .Fn macro, document `flags' argument & bump document date. 2005-01-07 12:14:43 +00:00
Giorgos Keramidas
5cd9afad91 Trim excessively verbose sentence. 2005-01-07 12:01:11 +00:00
Giorgos Keramidas
98e515c959 The .Fn macro 2005-01-07 11:45:59 +00:00
Giorgos Keramidas
ce4ad10554 Move the description of MNT_FORCE closer to mntflags and use a .Bl
list for the valid flag values.  This way, if VFS_UNMOUNT(9) supports
more flags in the future, adding a single list item is going to be
easy and all the flags are going to be in one place.
2005-01-07 11:45:11 +00:00
Giorgos Keramidas
59292cdbeb The .Fn macro. 2005-01-07 11:39:36 +00:00
Giorgos Keramidas
e40e9de2a8 There is no VFS_INIT(9).
Approved by:	phk
2005-01-07 11:34:05 +00:00
Giorgos Keramidas
c972b6d8df The VFS_MOUNT() macro expects only 2 arguments in the nmount world
(since revision 1.173 of src/sys/sys/mount.h).

Update its prototype, the argument list description and bump the date.
2005-01-07 10:57:33 +00:00
Giorgos Keramidas
66700df04f Use a .Bl -tag list instead of plain .Pp paragraphs for describing the
macro arguments expected by SYSCALL_MODULE().

MFC after:	3 days
2005-01-07 09:02:40 +00:00
Giorgos Keramidas
18746c5893 Fix time-travel bug.
Noticed by:	krion
2005-01-07 09:00:19 +00:00
Giorgos Keramidas
85ab3df25a Avoid overusing "these" by breaking a long sentence in 2 smaller ones.
MFC after:	3 days
2005-01-07 08:51:10 +00:00
Giorgos Keramidas
2eaf5c1135 Convert the descriptions of module versions to an explicit list and
note that these versions numbers refer to moddepend, not the current
module.

MFC after:	3 days
2005-01-07 08:44:31 +00:00
Giorgos Keramidas
be0ffb7642 Syntax nit.
MFC after:	3 days
2005-01-07 08:31:09 +00:00
Colin Percival
bfadd9be1e Point out that tsleep(... , 0) is not permitted if the Giant lock is not
held.  (It causes a "sleeping without a mutex" assertion failure in
msleep.)

MFC after:	3 days
2005-01-07 02:41:45 +00:00
Giorgos Keramidas
374d072d12 Use .Fn function_name
MFC after:	3 days
2005-01-06 17:33:38 +00:00
Giorgos Keramidas
2757b1cbd1 Use .Fn function_name
MFC after:	3 days
2005-01-06 17:25:11 +00:00
Giorgos Keramidas
dea25585a1 Properly cross-reference pccard(4).
MFC after:	3 days
2005-01-06 17:19:56 +00:00
Giorgos Keramidas
cd7aa0fa5d - Use .Fn for marking up function-like macro names.
- Improve the wording in a few places.
- Add the email address of Doug Rabson in the AUTHORS section.
- Link to devfs(5) with an .Xr

MFC after:	3 days
2005-01-06 17:17:29 +00:00
Giorgos Keramidas
c91b6b9ef2 . Use a .Bl list for describing macro arguments.
. Various wordign fixes.
. Bump document date.

MFC after:	3 days
2005-01-06 17:16:01 +00:00
Giorgos Keramidas
1aaeeac1e8 . Use a -tag instead of an -inset list, which makes the arguments of the
macro stand out more clearly.
. Various other wording fixes.
. Bump document date.
2005-01-06 17:14:21 +00:00
Giorgos Keramidas
bb53ac437b Use .Fn function_name.
MFC after:	3 days
2005-01-06 17:11:56 +00:00
Giorgos Keramidas
85e2993ac6 Add missing .It in list tag.
MFC after:	3 days
2005-01-06 17:08:51 +00:00
Giorgos Keramidas
03305517a9 Fix .Nd description and bump document date.
MFC after:	3 days
2005-01-06 17:07:57 +00:00
Giorgos Keramidas
c977d004b2 "non-spin" is better with a dash, than without. 2005-01-06 16:16:17 +00:00
Giorgos Keramidas
b762042dce Make an attempt at explaining why sx(9) locks cannot be safely obtained
after acquiring a mutex(9).

PR:		docs/75571
Submitted by:	darrenr
Explanation by:	jhb
2005-01-05 22:04:12 +00:00
Warner Losh
da52f590b5 Clarify /*- convention. 2005-01-05 21:27:01 +00:00
Warner Losh
56c7363ae8 A large majority of the source files in the tree start their license
and copyright statements in a comment that begins with /*-.  Document
this tradition.  A strict adherence to this rule will help resellers
that wish to publish all copyright notices, generated automatically
from the tree.  There are too many variant licenses to do it purely
by more complicated pattern matching.
2005-01-05 19:16:01 +00:00
Kirill Ponomarev
51daf549e8 Remove trailing spaces.
Reviewed by:	brueffer
MFC after:	3 days
2005-01-02 18:20:29 +00:00
Gleb Smirnoff
e5f8af4e5c Document callout_pending() macro.
MFC after:	1 week
2004-12-29 08:01:24 +00:00
Joseph Koshy
68ca7644cf Make an argument name in the synopsis match that in the text. Correct
an mdoc error.
2004-12-29 04:29:06 +00:00
Tom Rhodes
2865672368 Some formatting, whitespace and mdoc(7) fixes.
Submitted by:	A manual page, ru of course.
2004-12-14 18:07:46 +00:00
Warner Losh
93c22173bd The format of the MLINKS entries is pairwise, not MLINKS += wise. So
list kernel_mount.9 the required number of times to allow make
installworld to complete.
2004-12-13 23:09:19 +00:00
Tom Rhodes
fe10ebf1f4 Add kernel_mount.9 and appropriate MLINKS to the build. 2004-12-13 19:29:40 +00:00
Tom Rhodes
610b07d6a3 Add a manual page to document phk's mount work.
Reviewed by:	phk (content), brueffer (grammar and markup)
2004-12-13 19:25:30 +00:00
Sam Leffler
b9def06b29 document m_append 2004-12-08 17:47:49 +00:00
Nate Lawson
8844d5efa6 Add the devclass_get_count(9) function and man page. It gets a count of
the number of devices in a devclass and is a subset of
devclass_get_devices(9).

Reviewed by:	imp, dfr
2004-12-08 02:39:56 +00:00
Joseph Koshy
9df1bed3ca Update prototypes for eventhandler_register() and eventhandler_find_list()
to match the code.
2004-12-06 11:30:55 +00:00
Alan Cox
898bd99ea5 This jumbo allocator has been removed from the kernel. 2004-12-06 04:24:17 +00:00
Joseph Koshy
235b396aa1 Add a manual page for the kernel's EVENTHANDLER facility.
Reviewed by:	ru
2004-12-03 14:05:55 +00:00
Diomidis Spinellis
7078127540 Clarify the structure element size ordering.
Obtained from:	OpenBSD style.9 1.38
2004-12-02 23:20:17 +00:00
Ruslan Ermilov
e354922c78 MNT_NODEV is deprecated. 2004-11-29 09:56:12 +00:00
Robert Watson
6f00fa1397 Link critical_enter.9 to critical.9 to make it easier to find. 2004-11-24 18:03:52 +00:00
Robert Watson
2d3cb56d97 Word choice fix; use .Fn for non-.Xr functions.
Submitted by:	ru
2004-11-21 00:24:21 +00:00
Joseph Koshy
0252ce1723 Bring signal(9) in sync with -current.
Reviewed by:	ru (mdoc changes)
2004-11-20 02:11:42 +00:00
Robert Watson
1317240bac Add a couple of summary paragraphs at the head of mbuf_tags(9) to
indicate how m_tags might be used, and what their high level properties
are.  This may help developers using tags get a more clear picture
before delving into the technical details of ABI cookies and API calls.

Suggested by:	Rene de Vries <rene at canyon dot xs4all dot nl>
2004-11-18 23:01:07 +00:00
Joseph Koshy
303c42c0c3 Cross-reference signal(9). 2004-11-18 02:06:17 +00:00
John Baldwin
1f25113f2e Remove some references to I386_CPU and 80386 CPUs. 2004-11-16 21:22:09 +00:00
John Baldwin
39fb485701 Catch up to rev 1.52 of sys/kern/kern_condvar.c. cv_signal() and
cv_broadcast() no longer require that the interlock mutex be held when
called.

Reminded by:	das
2004-11-08 18:15:11 +00:00
Bruce M Simpson
f674e945aa Correct a misspelling, 'task_fn' -> 'task_fn_t'.
Noticed by:	sah at softcardsystems dot com
MFC after:	3 days
2004-10-26 17:14:45 +00:00
Scott Long
0f3a007844 Correct and clarify some very incorrect text. 2004-10-22 05:21:20 +00:00
Joseph Koshy
9bd82b5c5d Add a manual page for hashinit(9), hashdestroy(9) and phashinit(9).
Reviewed by:	ru
2004-10-12 02:36:24 +00:00
Joseph Koshy
1bd2c518ef Use the "normal form" for copyright text. 2004-10-12 02:04:11 +00:00
Gleb Smirnoff
bb978628ec - Document RT_[UN]LOCK, RT_ADDREF, RT_REMREF.
- Describe how RT_FREE actually works.

Grammar check:	ru
Reviewed by:	sam
MFC after:	1 month
2004-10-11 20:48:36 +00:00
Brian Feldman
dd44434547 s/ENOBUF/ENOBUFS/ 2004-10-11 18:40:50 +00:00
Gleb Smirnoff
8c4a75be4a Revert last commit since it breaks API.
Requested by:	sam
2004-10-10 09:16:48 +00:00
Gleb Smirnoff
42c5607501 Remove inlined m_tag_free(). Rename _m_tag_free() to m_tag_free()
and make it visible (same way as in OpenBSD). Describe usage in manpage.

This change is useful for creating custom free methods, which
call default free method at their end.

While here, make malloc declaration for mbuf tags more informative.

Approved by:	julian (mentor), sam
MFC after:	1 month
2004-10-09 13:25:19 +00:00
Max Laier
85bba4455a Change pfil starvation prevention from fail-open to fail-close.
We return ENOBUF to indicate the problem, which is an errno that should be
handled well everywhere.

Requested & Submitted by:	green
Silently okay'ed by:		The rest of the firewall gang
MFC after:			3 days
2004-10-08 12:07:20 +00:00
Gleb Smirnoff
6534d075cc - sort struct rtentry fields in man page in some order as they are in struct
- remove RTF_PRCLONING
- add rt_mtx field
- rename rt_metrics -> rt_metrics_lite
- mention that only 3 metrics are really used in rt_metrics_lite

Reviewed by:	ru, andre
2004-10-08 09:57:12 +00:00
Gleb Smirnoff
d7e6966d45 Add more MLINKS for rtalloc.9
Approved by:	ru
2004-10-08 09:52:56 +00:00
Gleb Smirnoff
5428d18c74 More grammar cleanups from MDocGuard^WRuslan. 2004-10-08 09:52:00 +00:00
Max Laier
f6b2c4eca5 Add a minimal altq.4 manpage to tell about the kernel options and where to
find more information. Also move the "SUPPORTED DEVICES" section from altq.9
to altq.4, where is belongs.

Requested by:	green
MFC after:	2 days
2004-10-07 12:10:25 +00:00
Gleb Smirnoff
650c2669ee Mdoc and grammar fixes.
Submitted by:	ru
2004-10-07 10:59:09 +00:00
Gleb Smirnoff
729df1bb28 - note that RTF_PRCLONING is obsoleted
- explain locking differencies between rtalloc(), rtalloc_ign(), rtalloc1()
  and rtfree(), RTFREE().

Reviewed by:	andre (1.5 months ago)
OK'd by:	ru
2004-10-07 10:14:23 +00:00
Max Laier
2f510328e4 dc(4) is now supported as well. While here sort the list and remove awi,
which isn't yet supported.
2004-10-01 20:44:48 +00:00
Max Laier
d6a8d58875 Add an additional struct inpcb * argument to pfil(9) in order to enable
passing along socket information. This is required to work around a LOR with
the socket code which results in an easy reproducible hard lockup with
debug.mpsafenet=1. This commit does *not* fix the LOR, but enables us to do
so later. The missing piece is to turn the filter locking into a leaf lock
and will follow in a seperate (later) commit.

This will hopefully be MT5'ed in order to fix the problem for RELENG_5 in
forseeable future.

Suggested by:		rwatson
A lot of work by:	csjp (he'd be even more helpful w/o mentor-reviews ;)
Reviewed by:		rwatson, csjp
Tested by:		-pf, -ipfw, LINT, csjp and myself
MFC after:		3 days

LOR IDs:		14 - 17 (not fixed yet)
2004-09-29 04:54:33 +00:00
Alan Cox
c97680825c Add cross references to vm_map_entry_resize_free.9.
Submitted by: Mark W. Krentel
2004-09-27 05:44:28 +00:00
Alan Cox
af3db1449f Document the O(log n) algorithm for finding free space.
Submitted by: Mark W. Krentel
2004-09-27 04:22:41 +00:00
Alan Cox
0a7c173775 Document the flags field.
Submitted by: Mark W. Krentel
2004-09-27 03:59:36 +00:00
Joerg Wunsch
cf2acd69e3 Document that kthread_exit()ing will cause a wakeup(9) on the thread
handle.

MFC after:	1 week
2004-09-24 19:58:47 +00:00
Ruslan Ermilov
346763649a Sort MAN and MLINKS in dictionary order ignoring case. 2004-09-19 05:17:21 +00:00
John-Mark Gurney
0283f35b4b add MLINKs for the mbuf.9 man page..
MFC after:	3 days
2004-09-18 19:04:24 +00:00
Brooks Davis
35779bdbd1 Bring kernel time variable and access function docs up to date by
updating the list of variables and mentioning the bin(up)time functions.
2004-09-17 07:24:18 +00:00
Brooks Davis
31a5aa8a1c Document the struct if_data members ifi_datalen, ifi_epoch, and
ifi_link_state.

Reminded by:	ru
2004-09-17 06:49:43 +00:00
Alan Cox
acf359aa98 Update to reflect recent changes such as the fields for O(log n) address
space allocation.

Submitted by: Mark W. Krentel
2004-09-15 18:41:10 +00:00
John-Mark Gurney
b7131a2672 document that m_free returns m_next of the free'd mbuf 2004-08-28 03:46:18 +00:00
Andre Oppermann
c21fd23260 Always compile PFIL_HOOKS into the kernel and remove the associated kernel
compile option.  All FreeBSD packet filters now use the PFIL_HOOKS API and
thus it becomes a standard part of the network stack.

If no hooks are connected the entire packet filter hooks section and related
activities are jumped over.  This removes any performance impact if no hooks
are active.

Both OpenBSD and DragonFlyBSD have integrated PFIL_HOOKS permanently as well.
2004-08-27 15:16:24 +00:00
Warner Losh
490ec740c8 Add reference to vslock(9) for locking user address pages into core.
Suggested by: alc
2004-08-26 04:16:55 +00:00
Max Laier
8e7c23d74f Document supported devices here (for lack of a better place). Users
interested in ALTQ are likely to type in "man altq" at some point and maybe
they will scroll down to the bottom as well.

MFC after:	3 days
2004-08-25 18:49:32 +00:00
Warner Losh
4d855643d1 Clarify what the lockfunc is used for. When it will be called and
when it won't be called.  The old wording was correct, but not
sufficiently specific to understand when and how it would be called.
The new wording describes the current implementation's usage (which
should be updated if other appropriate times are decided upon),
specifically that it is called only when the load operation is
deferred to keep the locking state consistent.  When the operation
isn't deferred, the calling routine is assumed to have a coherent
locking world.

Reviewed by: scottl
2004-08-24 23:09:57 +00:00
Warner Losh
95929b661e Even in a 80 column, fixed point font, there's plenty of room for all
the arguments to bus_dmamap_load, so don't use '...' but list the
actual args.  '...' usually means a variable number of args (cf
printf(3)), but bus_dmamap_load takes a fixed number of arguments.
2004-08-23 23:28:02 +00:00
Warner Losh
cbfef69c64 In the SYNOPSIS section, move the bus_dmamem_alloc function prototype
to just before bus_dmamem_free, which is (a) more logical; (b) likely
what was originally intended and (c) matches the order in the NAME and
FUNCTIONS sections.
2004-08-23 23:17:31 +00:00
Simon L. B. Nielsen
4af04cb81c mdoc(7) janitor:
- Fix hard sentence breaks.

MFC after:	3 days
2004-08-21 12:58:09 +00:00
John Baldwin
68fdba2eb1 Catch up to recent API changes including the removal of the signal_caught
argument to sleepq_timedwait() and the enhancements to the flags argument
passed to sleepq_add().
2004-08-19 12:46:02 +00:00
John-Mark Gurney
000968010a add options MPROF_BUFFERS and MPROF_HASH_SIZE that adjust the sizes of
the mutex profiling buffers.  Document them in the man page and in NOTES.
Ensure _HASH_SIZE is larger than _BUFFERS with a cpp error.
2004-08-19 06:38:26 +00:00
Brian Feldman
fec07e9be0 Remove the BUGS entry for vslock(9) not actually holding user memory in place. 2004-08-16 03:12:10 +00:00
Warner Losh
13dbaef46a Be explicit that a driver may assume softc is preserved when returning 0 2004-08-11 21:52:31 +00:00
John-Mark Gurney
e8c9966d55 fix description of the macros for BUS_DMASYNC opertions. It's from the CPU's
point of view...  Add a reference to a better description of what the ops
do...

Reviewed by:	scottl
2004-08-11 14:52:33 +00:00
Brian Feldman
ea84c8dc30 Update "documentation date" fields. 2004-08-10 16:38:19 +00:00
Brian Feldman
2a1bb291d5 Document exactly how vslock(9) is broken. 2004-08-10 15:01:00 +00:00
Brian Feldman
5b2bbd83fc Update contigmalloc(9)'s manpage to reflect usage of the malloc_type
argument and that allocation occurs from the end of the address space
backward (still first-fit).
2004-08-10 14:47:12 +00:00
Joerg Wunsch
0da40ab229 Add documentation for log(9).
MFC after:	1 week
2004-08-10 09:19:08 +00:00
Max Laier
424e9d7165 mdoc(7) and english grammar makeover.
Submitted by:	ru
2004-08-09 15:58:39 +00:00
John-Mark Gurney
227559d11f rearange some code that handles the thread taskqueue so that it is more
generic.  Introduce a new define TASKQUEUE_DEFINE_THREAD that takes a
single arg, which is the name of the queue.

Document these changes.
2004-08-08 02:37:22 +00:00
Max Laier
251b8d4557 Add altq(9) explaining about the IFQ_* and IFQ_DRV_* macros in if_var.h and
how to convert drivers.

Obtained from:	NetBSD (with changes)
Reviewed by:	josef
2004-08-07 12:35:56 +00:00
Warner Losh
899eeaa62f It appears that cdevsw_add/remove were removed quite a while ago, so
remove them from here.
2004-08-07 04:59:16 +00:00
Pawel Jakub Dawidek
51385a3c00 - Add two fields to bio structure: 'bio_cflags' which can be used by
consumer and 'bio_pflags' which can be used by provider.
- Remove BIO_FLAG1 and BIO_FLAG2 flags. From now on new fields should be
  used for internal flags.
- Update g_bio(9) manual page.
- Update some comments.
- Update GEOM_MIRROR, which was the only one using BIO_FLAGs.

Idea from:	phk
Reviewed by:	phk
2004-08-04 21:35:05 +00:00
John-Mark Gurney
47df0a78eb after reading the commit mail, I better understand what cnt_hold is for..
improve the verbage in the manpage so others are more likely to understand
it...

Reviewed by:	rwatson
2004-07-27 04:23:00 +00:00
John-Mark Gurney
b5e60d3288 document that times are in microseconds, yes it's at the end in the NOTES
section, but this makes it easier to find.
2004-07-26 21:21:08 +00:00
Colin Percival
56f21b9d74 Rename suser_cred()'s PRISON_ROOT flag to SUSER_ALLOWJAIL. This is
somewhat clearer, but more importantly allows for a consistent naming
scheme for suser_cred flags.

The old name is still defined, but will be removed in a few days (unless I
hear any complaints...)

Discussed with:	rwatson, scottl
Requested by:	jhb
2004-07-26 07:24:04 +00:00
Colin Percival
75877b7564 Document the SUSER_RUID flag.
Reminded by:	pjd
2004-07-17 15:21:34 +00:00
Colin Percival
ebf89b8e17 Add a BUGS entry pointing out that the ASU flag isn't being set. This was
disabled by rwatson in revision 1.60 of sys/kern/kern_prot.c in August 2000.
2004-07-17 15:14:43 +00:00
Poul-Henning Kamp
65a311fcb2 Give kldunload a -f(orce) argument.
Add a MOD_QUIESCE event for modules.  This should return error (EBUSY)
of the module is in use.

MOD_UNLOAD should now only fail if it is impossible (as opposed to
inconvenient) to unload the module.  Valid reasons are memory references
into the module which cannot be tracked down and eliminated.

When kldunloading, we abandon if MOD_UNLOAD fails, and if -force is
not given, MOD_QUIESCE failing will also prevent the unload.

For backwards compatibility, we treat EOPNOTSUPP from MOD_QUIESCE as
success.

Document that modules should return EOPNOTSUPP for unknown events.
2004-07-13 19:36:59 +00:00
Alfred Perlstein
2e168c9b37 Document thread parameter passed to VFS_ROOT and vflush. 2004-07-12 09:06:51 +00:00
Darren Reed
52865ee591 Document that sx_unlock() exists as a macro.
Remove redundant include file, <sys/kernel.h>, and clean up the function
list at the top with the addition of a "Sx utility macro" section.
2004-07-11 16:08:25 +00:00
Warner Losh
cd4d01d8a0 Modernize description of physio. Make explicit that this creates a
request that's passed to the driver's strategy.
2004-07-10 01:10:17 +00:00
Alfred Perlstein
cf92b47413 document vfs_suser. 2004-07-09 22:33:43 +00:00
Dag-Erling Smørgrav
9f5965dded Bump document date.
Reminded by:	ru
2004-07-09 11:44:49 +00:00
Dag-Erling Smørgrav
4aa90de352 The type and name of sbuf_b{cat,cpy}()'s second argument have changed. 2004-07-09 11:38:59 +00:00
Ruslan Ermilov
092cc6b2ab Revise markup. 2004-07-08 10:47:13 +00:00
Alfred Perlstein
c438d25d9e There is no VOP_TRUNCATE anymore.
style(9) (parenthesis around return values) the example.
2004-07-08 00:43:50 +00:00
Alfred Perlstein
ad5d91b7b1 s/proc/thread 2004-07-08 00:38:28 +00:00
Alfred Perlstein
f6bd5d1e6d Update comments in example as well. 2004-07-08 00:36:58 +00:00
Alfred Perlstein
dc7bf98cd1 Update because struct componentname now has a thread pointer instead
of a proc pointer.
2004-07-08 00:11:43 +00:00
Alfred Perlstein
7f67dadf9f Update in the face of NDFREE.
Basically the advice on freeing the componentname buffers is no
longer correct.
Update the example code.
2004-07-08 00:08:18 +00:00
Ruslan Ermilov
2410103c1d mdoc(7) fixes. 2004-07-07 19:57:16 +00:00
Maxim Konovalov
9193b9a5a1 MT_TAG is dead. 2004-07-07 16:48:16 +00:00
Ruslan Ermilov
65bb31b863 Slight content fixes. 2004-07-07 13:21:46 +00:00
Ruslan Ermilov
2e77778053 Fixed document title (should be in all uppercase).
List all functions in the NAME section so they appear in whatis(1).
Assorted fixes (mostly markup).
2004-07-07 12:59:39 +00:00
Ruslan Ermilov
db79bbff16 Sweep formatting and assorted fixes. 2004-07-07 07:56:58 +00:00
Ruslan Ermilov
ceba39a73b Tabs here upset my automatic checker, so replaced them with spaces. 2004-07-07 07:56:36 +00:00
Ruslan Ermilov
6f39ea8888 Tiny markup fixes. 2004-07-06 08:21:12 +00:00
Ruslan Ermilov
6ac051ece6 Fixed markup. 2004-07-06 07:39:50 +00:00
Ruslan Ermilov
3f7440e2ee mdoc(7) fixes. 2004-07-06 07:33:49 +00:00
Ruslan Ermilov
c8cbcbce5c mdoc(7) fixes. 2004-07-06 07:26:23 +00:00
Ruslan Ermilov
2c5470d09e Correct typos in the function name.
mdoc(7) tweaks.
2004-07-06 07:12:34 +00:00
Ruslan Ermilov
b4ca3754a4 Fixed the .Os call (missing or wrong). 2004-07-06 07:02:31 +00:00
Ruslan Ermilov
a970c85ca9 mdoc(7) fixes. 2004-07-06 06:53:42 +00:00
Ruslan Ermilov
1772ac3f49 Slightly improve the markup. 2004-07-05 18:13:50 +00:00
Ruslan Ermilov
51f98e585b Fix the NAME section making whatis(1) happy in particular. 2004-07-05 17:12:53 +00:00
Ruslan Ermilov
1c85060a13 Sort SEE ALSO references (in dictionary order, ignoring case). 2004-07-04 20:55:50 +00:00
Bruce M Simpson
df550d3259 Add documentation for the ieee80211_node.c functions.
Submitted by:	Darron Broad
2004-07-04 18:07:58 +00:00
Scott Long
ab0b83b529 Document that boundaries cannot be smaller than the max segment size. 2004-07-04 04:50:00 +00:00
Ruslan Ermilov
651aa6348e Merge junk. 2004-07-03 22:53:50 +00:00
Ruslan Ermilov
5203edcdc5 Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00
Ruslan Ermilov
d37ea99837 Removed trailing whitespace. 2004-07-02 19:07:33 +00:00
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