Commit Graph

1332 Commits

Author SHA1 Message Date
imp
b28f179924 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
dbcc99d05d mdoc(7) janitor:
- Fix hard sentence breaks.

MFC after:	3 days
2004-08-21 12:58:09 +00:00
jhb
4d6734a68b 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
jmg
bead871bc0 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
green
897f119a6f Remove the BUGS entry for vslock(9) not actually holding user memory in place. 2004-08-16 03:12:10 +00:00
imp
db0bbfe1d3 Be explicit that a driver may assume softc is preserved when returning 0 2004-08-11 21:52:31 +00:00
jmg
f25be330cc 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
green
70cf64bec6 Update "documentation date" fields. 2004-08-10 16:38:19 +00:00
green
7419bfcbfb Document exactly how vslock(9) is broken. 2004-08-10 15:01:00 +00:00
green
7ba2118516 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
fea1ca1479 Add documentation for log(9).
MFC after:	1 week
2004-08-10 09:19:08 +00:00
mlaier
7f0c7f1817 mdoc(7) and english grammar makeover.
Submitted by:	ru
2004-08-09 15:58:39 +00:00
jmg
6967b9b093 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
mlaier
c794eed216 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
imp
0b96114d04 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
pjd
0b32901632 - 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
jmg
bd22509d23 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
jmg
00d7c9fc33 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
cperciva
d9fecc83c8 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
cperciva
ddcdcc894f Document the SUSER_RUID flag.
Reminded by:	pjd
2004-07-17 15:21:34 +00:00
cperciva
4c108fff2d 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
phk
b0e6874188 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
2690c990dd Document thread parameter passed to VFS_ROOT and vflush. 2004-07-12 09:06:51 +00:00
darrenr
6c66c4291a 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
imp
10c37ef567 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
68b0bdace1 document vfs_suser. 2004-07-09 22:33:43 +00:00
des
8369ef54b0 Bump document date.
Reminded by:	ru
2004-07-09 11:44:49 +00:00
des
af4e696e95 The type and name of sbuf_b{cat,cpy}()'s second argument have changed. 2004-07-09 11:38:59 +00:00
ru
4ac33425c4 Revise markup. 2004-07-08 10:47:13 +00:00
alfred
4dc964a3b8 There is no VOP_TRUNCATE anymore.
style(9) (parenthesis around return values) the example.
2004-07-08 00:43:50 +00:00
alfred
60a197bb10 s/proc/thread 2004-07-08 00:38:28 +00:00
alfred
c8d0f89ed2 Update comments in example as well. 2004-07-08 00:36:58 +00:00
alfred
18187ae75d Update because struct componentname now has a thread pointer instead
of a proc pointer.
2004-07-08 00:11:43 +00:00
alfred
11872a37e7 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
ru
9f45c1d92e mdoc(7) fixes. 2004-07-07 19:57:16 +00:00
maxim
4463bbe1ce MT_TAG is dead. 2004-07-07 16:48:16 +00:00
ru
acd47d1822 Slight content fixes. 2004-07-07 13:21:46 +00:00
ru
35954f3e0f 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
ru
5b5605b88b Sweep formatting and assorted fixes. 2004-07-07 07:56:58 +00:00
ru
2bff8e39d7 Tabs here upset my automatic checker, so replaced them with spaces. 2004-07-07 07:56:36 +00:00
ru
528b1b9efc Tiny markup fixes. 2004-07-06 08:21:12 +00:00
ru
e0bb90e42d Fixed markup. 2004-07-06 07:39:50 +00:00
ru
ebd7b5c84f mdoc(7) fixes. 2004-07-06 07:33:49 +00:00
ru
71acbf5699 mdoc(7) fixes. 2004-07-06 07:26:23 +00:00
ru
76704175b3 Correct typos in the function name.
mdoc(7) tweaks.
2004-07-06 07:12:34 +00:00
ru
8d28dbb84f Fixed the .Os call (missing or wrong). 2004-07-06 07:02:31 +00:00
ru
c1e28c4e1f mdoc(7) fixes. 2004-07-06 06:53:42 +00:00
ru
7d68d46370 Slightly improve the markup. 2004-07-05 18:13:50 +00:00
ru
d384729d50 Fix the NAME section making whatis(1) happy in particular. 2004-07-05 17:12:53 +00:00
ru
6651f20e0d Sort SEE ALSO references (in dictionary order, ignoring case). 2004-07-04 20:55:50 +00:00
bms
7b57b2dba3 Add documentation for the ieee80211_node.c functions.
Submitted by:	Darron Broad
2004-07-04 18:07:58 +00:00
scottl
833ca0492e Document that boundaries cannot be smaller than the max segment size. 2004-07-04 04:50:00 +00:00
ru
c79648de84 Merge junk. 2004-07-03 22:53:50 +00:00
ru
1cf1598667 Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00
ru
4b39413aeb Removed trailing whitespace. 2004-07-02 19:07:33 +00:00
scottl
4ee5f5f697 Small grammar fix. 2004-07-02 15:52:44 +00:00
bde
2e35fb1a4c Fixed a style bug in the previous commit. 2004-06-26 09:02:44 +00:00
obrien
2194f33c4e Embellish the getopt(3) example with mixed case.
Reviewed by:	bde
2004-06-26 05:15:00 +00:00
le
e94d425852 Catch up with the dev_t -> struct cdev change. 2004-06-22 20:18:15 +00:00
mpp
eaa9f15572 Spelling fixes. 2004-06-21 14:11:45 +00:00
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
truckman
9e29439889 Change len pararmeter from u_int to size_t.
Document vslock() return values.
2004-03-15 10:05:27 +00:00
jhb
3b9c3dff42 Rewrite sleepqueue manpage to catch up to the new sleep queue interface. 2004-03-12 19:07:18 +00:00
pjd
edecc780e9 mdoc(7): New sentence should start on new line.
Pointed out by:	hmp
2004-03-11 22:22:03 +00:00
pjd
2063fea7ec Add reference to the g_access(9) manual page. 2004-03-11 19:53:22 +00:00
pjd
39a7f0c491 Connect g_access(9) to the build. 2004-03-11 19:51:14 +00:00
pjd
7367796ebb Add manual page for g_access(9) GEOM function. 2004-03-11 19:23:48 +00:00
jhb
82864cac2a - Document cv_broadcastpri().
- Remove references to cv_waitq_*() as they no longer exist.
2004-03-10 15:57:25 +00:00
bms
791e1cc501 Update pmap_pinit(9) to reflect pmap_pinit2() removal by alc. 2004-03-08 15:07:14 +00:00
josef
81beb7a4fe 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
jkoshy
894cb81b6c Link in contigmalloc(9) to the build. 2004-03-06 08:01:16 +00:00
jkoshy
3537c363d9 Cross-reference contigmalloc(9). 2004-03-06 02:13:03 +00:00
jkoshy
c01775c228 A manual page for contigmalloc(9).
Reviewed by:	ru
2004-03-06 02:09:17 +00:00
imp
335717fbe6 Add warning about loading/unloading drivers and identify 2004-03-05 22:21:18 +00:00
ru
5bd82537fb This interface doesn't return any values.
Submitted by:	Mark Santcroos
2004-03-05 16:38:01 +00:00
bms
25f5843029 Fix a typo. 2004-03-05 02:50:28 +00:00
bms
578e7d07f0 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
bms
98ca3095ce Add an MLINKS entry for radiotap(9). 2004-03-04 12:54:22 +00:00
bms
2897d868a2 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
1dc1bc8010 - 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
le
83cfe7493c Add MLINKs for MALLOC_DEFINE and MALLOC_DECLARE.
Approved by:     grog (mentor)
2004-02-28 23:01:20 +00:00
phk
7707bac885 Add contents to manualpage for generic watchdog facility.
Formatting likely to break several UN resolutions.
2004-02-28 20:08:41 +00:00
ru
65491e7b35 mtod() returns pointer to the specified type, not necessarily "void *". 2004-02-27 17:14:00 +00:00
des
1d0a3939bf Document sysctl_move_oid(). 2004-02-27 17:13:42 +00:00
rwatson
765e9ab485 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
jhb
602c2e6421 - 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
njl
6c22ad59a4 bus_set_resource takes a rid, not a pointer to a rid. 2004-02-22 00:29:04 +00:00
ru
6aeedc2908 Improve formatting. 2004-02-19 12:02:54 +00:00
phk
c36749b9a5 Improve contents, ruin formatting. 2004-02-18 22:10:08 +00:00
maxim
180ac35cac o Be consistent with the declaration: pri -> priority.
Spotted by:	Dmitry Rzhavin
MFC after:	1 week
2004-02-17 13:31:36 +00:00
des
00e29c835f Back out previous commit due to objections. 2004-02-16 21:36:59 +00:00
des
b5f599aa9c Document the change in M_WAITOK semantics. 2004-02-16 18:46:16 +00:00
pjd
ea234afcbd 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
pjd
73de8e89a4 Create symbolic link for g_print_bio(9) manual page.
Approved by:	scottl (mentor)
2004-02-11 18:43:20 +00:00
pjd
7065c8e2b7 Document g_print_bio() function.
Approved by:	scottl (mentor)
2004-02-11 18:36:31 +00:00
pjd
36a5b6eedb Added GEOM kernel API manuals to the build.
Reviewed by:	scottl
Approved by:	phk, scottl (mentor)
2004-02-11 10:09:17 +00:00
pjd
dbc7255199 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
bms
e68c776541 Document the functions m_apply() and m_getptr().
Requested by: Maxim Konovalov
2004-02-11 02:39:24 +00:00
jmg
4c9c51e06e 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
bms
085ada6de7 Spelling. 2004-02-10 16:11:08 +00:00
pjd
d4d0f8b9e0 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
4f14e0fa86 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
ale
11fbbb1d40 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
rwatson
0d118a298f Add debug.mutex.prof.reset. 2004-01-28 22:21:04 +00:00
mux
bef77d3b6d Fix another typo. 2004-01-28 13:29:40 +00:00
mux
ce7255c52f Fix typo. 2004-01-28 13:28:45 +00:00
imp
f08bacde3c 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
njl
439d3ab327 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
yar
e0fbbdee58 Document the interface method if_input(). 2004-01-26 12:51:00 +00:00
des
7487bc82a7 mdoc cleanup.
Submitted by:	ru
2004-01-26 12:50:30 +00:00
yar
d46e2b1219 Clearly state that upon SIOCSIFFLAGS, ifp->if_flags is updated
at the common ifioctl() level.
2004-01-26 12:08:23 +00:00
yar
6b1a5f4424 Extend the description of SIOCSIFCAP. 2004-01-26 11:48:26 +00:00
des
53ac97ae75 Add more implentation notes based on the comments in sys/conf/NOTES. 2004-01-25 12:30:35 +00:00
des
f4ceb3a98d Add a cross-reference to MUTEX_PROFILING(9). 2004-01-25 12:24:23 +00:00
des
0f844e3f9a Add a manual page for the mutex profiling code. 2004-01-25 12:23:53 +00:00
des
42f562f3a8 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
yar
7cdb0aaab9 Extend the description of the framework of interface capabilities. 2004-01-22 00:10:21 +00:00
yar
7e2d68f5cb 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
yar
a260fb7b00 A couple of minor clarifications. 2004-01-21 13:17:24 +00:00
yar
c939cff388 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
ru
ad42658a8b 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
yar
12d55dd7ec 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
yar
967828a92a Update the list of mbuf types from <sys/mbuf.h>. 2004-01-18 21:29:46 +00:00
yar
1f04fb4a42 Update the list of possible mbuf flags from <sys/mbuf.h>. 2004-01-18 21:23:30 +00:00
rwatson
6f30d8a7a3 Minor typo: no line break after .Fn. 2004-01-11 19:57:42 +00:00
rwatson
7daf0c9588 Add a basic manpage for vn_fullpath().
Sponsored by:	DARPA, McAfee Research
2004-01-11 19:54:48 +00:00
des
ff23b25ca9 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
3e77d90534 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
scottl
44def18522 Document taskqueue_enqueue_fast() 2004-01-02 07:23:40 +00:00
jkoshy
eb1c647689 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
jkoshy
5c61422855 Use of the MTX_SYSINIT macro requires the inclusion of <sys/kernel.h>. 2003-12-28 01:39:18 +00:00
jkoshy
89eb2dfeeb 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
jkoshy
7fe60e3764 Improve continuity of text. 2003-12-27 14:01:08 +00:00
roam
284d477413 Fix a couple of typos: hexidecimal -> hexadecimal.
Reviewied by:	scottl
2003-12-12 11:08:51 +00:00
jkoshy
0b146f01b2 Typo fix. 2003-12-11 13:30:26 +00:00
jkoshy
41da867ce4 Document a few kernel functions and the sysctl tunables that
affect their behaviour.
2003-12-11 13:29:05 +00:00
mtm
5b310e02ed Grammar 2003-12-09 09:04:45 +00:00
scottl
e9b8241ac7 Add a manual page for the consolidated debugging commit. 2003-12-07 20:48:00 +00:00
trhodes
893ed3a244 Remove an extra 'for' in the HISTORY section. 2003-11-15 14:23:48 +00:00
fanf
22656dea02 Better English usage.
Submitted by: wollman
2003-11-12 10:53:52 +00:00
hmp
3b1d84afe4 Manual page for Asynchronous Logging Queues (ALQ) facility.
The manual page contains enough information to get someone started
with ALQ.

MLINKS have been added appropriately.

Approved by:	jeff, des
Reviewed by:	des, jeff, sam, brooks, rwatson, mtm
2003-11-10 22:45:09 +00:00
fanf
168e47de63 Clarify the rule about structure typedefs being discouraged, following
a discussion on src-committers.
2003-11-10 14:32:13 +00:00
jkoshy
296d11f9a1 Cross-reference pgfind(9) and pfind(9) from each others manual pages. 2003-11-08 13:41:22 +00:00
des
bf689a07a0 device_get_name(9) and device_get_nameunit(9) return const char *, not int. 2003-11-06 15:54:32 +00:00
imp
6e26b88350 Remove the file 2003-11-05 04:36:44 +00:00
imp
0769fd6e03 resource_query_string is dead. Kill it. 2003-11-05 04:36:13 +00:00
brooks
f1e94c6f29 Replace the if_name and if_unit members of struct ifnet with new members
if_xname, if_dname, and if_dunit. if_xname is the name of the interface
and if_dname/unit are the driver name and instance.

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

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

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

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

  * Remove incorrect usage of .Fa.

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

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

  * Replace 'man' with 'manual' for consistency.
2003-10-23 06:06:33 +00:00