Commit Graph

1122 Commits

Author SHA1 Message Date
ru
6b590797c3 Markup fixes. 2004-06-16 15:57:59 +00:00
ru
4a2b1c0775 Tiny markup fixes. 2004-06-16 15:47:45 +00:00
ru
aa52a5a900 Assorted markup, spelling, and grammar fixes. 2004-06-16 08:33:57 +00:00
ru
0cb4d158d6 Overhaul the markup. 2004-06-15 19:26:11 +00:00
jdp
ee17fcf8f3 Update the .Dd date for previous commit.
Gently nudged by:	krion
2004-06-14 18:33:21 +00:00
jdp
32b926e0fb 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
le
0e1c766f8f 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
yar
511a311f03 Touch .Dd (date) since new functionality has been documented.
Reminded by:	ru
2004-06-08 09:54:53 +00:00
yar
3bf7b1e476 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
yar
92f3a5285d Describe how polling(4) applies to network interfaces.
Reviewed by:	ru
2004-06-08 08:48:49 +00:00
yar
193fe3a27a 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
pjd
e90b05fea6 Add missing link. 2004-06-06 13:35:37 +00:00
brueffer
8ca718633a Fix spelling 2004-05-25 17:02:20 +00:00
ru
e2a0b37a4a Forgot to bump the document date, *blush*. 2004-05-20 09:52:48 +00:00
ru
0c1ed2c94f Document mbuf tags based on the OpenBSD manpage.
Submitted by:	Gleb Smirnoff
2004-05-20 09:34:19 +00:00
dwmalone
6707e287ca 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
le
5735a806d5 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
le
bf8efef5e5 These hyphens don't need to be escaped.
Pointed out by:  pjd@
2004-05-18 12:36:12 +00:00
le
c38ad17648 Fix spelling errors (I forgot that one in my last commit of GEOM man pages). 2004-05-18 12:12:07 +00:00
le
37da7b173f 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
hmp
6b26513d96 Add rman_get_device(9) to SYNOPSIS, .Nm and MLINK it to
rman(9).
2004-05-17 21:25:02 +00:00
hmp
c882857ce9 mdoc(7) police:
* remove an extra comma at the end of the .Nm list
2004-05-14 16:57:27 +00:00
imp
73b8b7698f 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
imp
8bae5ad135 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
imp
e63bc99425 Add caveats about adding devices in the IDENTIFY context. 2004-05-13 20:29:40 +00:00
imp
6f99a641aa 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
hmp
f6d9b853cb 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
hmp
dd055540b9 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
hmp
6a1c3dfe63 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
hmp
fb743e17de mdoc(7) police:
* correctly place parenthisized sentences
	* remove hard sentence breaks
	* use .Vt instead of .Fn
2004-05-05 10:47:19 +00:00
hmp
b13085958e Make the manual page consistent and add a cross-reference to wakeup(9). 2004-05-05 10:01:06 +00:00
maxim
1502ecbc2e o Document m_getcl(9).
Submitted by:	Gleb Smirnoff
MFC after:	2 weeks
2004-05-04 14:53:34 +00:00
maxim
59b5c3d082 o Add a missed description for m_free(9).
Optained from:	NetBSD
MFC after:	1 week
2004-04-28 14:53:49 +00:00
ru
960f0bd755 Make whatis(1) happy. 2004-04-16 06:26:09 +00:00
markm
26c9f4b636 Do a style fixup on the example function. 2004-04-15 07:24:10 +00:00
imp
3b454c223a Move advise from DEVICE_PROBE.9 about where to probe children. 2004-04-11 06:37:50 +00:00
imp
c52b25a0e5 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
cperciva
e0793884f3 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
markm
3a7da58e61 Fix some syntax errors in examples. These were discovered when trying
to follow the examples concerned.
2004-04-06 20:16:10 +00:00
ru
65e663b7dd - Overdue bump of the document date.
- Fixed markup.
- Minor wordsmithing.
2004-04-06 19:49:21 +00:00
ru
88ceef53a8 Assorted mdoc(7) fixes. 2004-04-01 07:54:27 +00:00
silby
0ccb317ee8 Fix last commit to conform to mdoc style.
Submitted by:	hmp
2004-04-01 07:36:56 +00:00
silby
5a95a9a0f2 Document the m_defrag function. (Mostly copied from the description
in uipc_mbuf.c)
2004-04-01 06:50:21 +00:00
bms
ab918a532f Add David Young's descriptive text for the radiotap interface.
Add David Young to copyright comments.
2004-03-31 02:57:30 +00:00
hmp
21981a0b0e 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
pjd
58c539faf0 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
pjd
ee4b13d10e The topology lock is not needed for g_error_provider() function.
Discussed with:	phk
2004-03-24 15:12:17 +00:00
pjd
6b2632b825 Added a note, that g_access() function cannot failed when dc[rwe] <= 0. 2004-03-24 14:42:26 +00:00
pjd
d1d0abbffa 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
njl
c7c23f8cb0 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