d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
130,652 Commits 4 Branches 49 Tags 2 GiB
32d2c58bd6
Commit Graph

1551 Commits

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