Commit Graph

1372 Commits

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