Commit Graph

916 Commits

Author SHA1 Message Date
Hiten Pandya
aac0aafa05 Bring in a manual page documenting some important functions of the
PCI bus interface.  I have made some modifications to this manual
page, so it looks a bit different from the original version that
was posted to me.

Submitted by:		Bruce M. Simpson <bms@spc.org>
Reviewed by:		imp, mdodd (early copy)
Approved by:		des (mentor)

MFC after:		3 days
2003-06-09 17:32:41 +00:00
Philippe Charnier
c2d6966a95 Add or correct section number in .Xr 2003-06-08 13:27:57 +00:00
Robert Watson
1792c88d10 Document VOP_LISTEXTATTR(9).
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-06-05 14:20:48 +00:00
Robert Watson
fa414127fb ENOATTR is now used for error returns indicating an undefined
extended attribute.

EINVAL can also reflect an invalid namespace for either a get
or set operation on EAs.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-06-05 13:42:37 +00:00
Robert Watson
e652f5ba74 Document the BUG (feature) that you can pass in an empty name to
VOP_GETEXTATTR() to retrieve the attribute name list on some file
systems, and note that this will be replaced with its own VOP
in due course.

Pointed out by:	Dominic Giampaolo <dbg@apple.com>
2003-06-04 04:03:58 +00:00
Robert Watson
d160576639 The vnode operations for extended attributes no longer suffer from
the features (bugs) in the BUGS section related to querying the
required buffer size, or telling if an overflow occured.
2003-06-04 04:01:44 +00:00
Ruslan Ermilov
f880146813 The devclass is an object type, mark it as such.
This also unbreaks the devclass_find(9) manpage.
2003-06-02 15:34:14 +00:00
Ruslan Ermilov
d6071d2f5f Restore one usage of .Ar that was legal. 2003-06-02 15:32:34 +00:00
Ruslan Ermilov
09f84dd1d3 Assorted mdoc(7) fixes. 2003-06-02 15:02:06 +00:00
Hiten Pandya
15c3fb05e5 Mass cleanup of the namei(9) manual page.
- Nuke markup indicators for editors.
	- Bump the date
	- Use mdoc(7) specifiers for marking up defines, etc.
	- Update the prototypes
	- Flash out the description
	- Cleanup english, spelling and grammar
	- Update .Xr's
	- Add following SEE ALSOs: uio(9), uma(9), vput(9), vref(9)
	- Reorder sections to be in agreement with mdoc(7)
	- Add FILES section
	- Update Copyright and AUTHORS section.

Approved by:	des (mentor)
2003-05-31 14:38:45 +00:00
Hiten Pandya
e07f1d5fd7 Various mdoc(7) fixes:
Add devfs(5) reference                   - make_dev.9
	 Change .Xr from VFS_VGET(9) to vget(9)   - vnode.9
	 Spelling fix, 'useage' to 'usage'        - zone.9

Approved by:	des (mentor)
2003-05-31 14:20:30 +00:00
Hiten Pandya
0640e9e01b Some mdoc(7) fixes:
Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately.
The .Ar mdoc(7) specifier should only be used when displaying command line
arguments.

Approved by:	des (mentor)
2003-05-31 14:07:25 +00:00
Hiten Pandya
2450346579 Add the bus_dma(9) manual page to our section 9 collection. It
provides comprehensive documentation on FreeBSD's Bus DMA interface.

Approved by: gibbs, re@ (scottl)
Reviewed by: gibbs, scottl, des, sam, jake, tmm
2003-05-30 22:57:54 +00:00
Ruslan Ermilov
3e1cee04f8 Assorted mdoc(7) fixes. 2003-05-30 21:13:32 +00:00
Hiten Pandya
1012d9d76c Bring vnode(9) man page to its senses:
- remove '-*- nroff -*-'
	- bump the date

	- nuke outdated ``struct vnode''
	  (it is just better to lookup the struct in the header)

	- nuke ``enum vtype'' and related junk
	- add a one line about ``struct vnode''
	- use .Va instead of .Dv for vnode struct fields

Approved by: des (mentor), re (bmah)
Reviewed by: arch@, mentor
2003-05-24 18:19:11 +00:00
Ruslan Ermilov
02531bb0b0 Link {be,le}{16,32,64}{enc,dec}.9 to byteorder.9.
Approved by:	re (blanket)
2003-05-21 17:37:22 +00:00
Ruslan Ermilov
0bf85f4f7e Fixed the whatis(1) entry for this manpage by using only
one short description (.Nd).

Submitted by:	sheldonh

Added bswap*() functions to the NAME section.

Approved by:	re (blanket)
2003-05-21 17:32:55 +00:00
Ruslan Ermilov
149c72305b Kill whitespace at EOL.
Approved by:	re (blanket)
2003-05-21 15:55:40 +00:00
Ruslan Ermilov
923d84c0bc mdoc(7) fixes.
This manpage should really have only one short description (.Nd);
if anyone could come up with a wording suitable for both conversion
and decoding/encoding functions, that would unbreak the whatis(1)
output for this manpage.

Approved by:	re (blanket)
2003-05-21 15:52:43 +00:00
Ruslan Ermilov
c8185672b2 Assorted mdoc(7), grammar, spelling, and punctuation fixes.
Approved by:	re (blanket)
2003-05-21 15:49:01 +00:00
Ruslan Ermilov
aba60fa66b Fixed troff(1) and mdoc(7) warnings.
Approved by:	re (blanket)
2003-05-18 21:05:22 +00:00
Hiten Pandya
72a3951459 Remove an extraneous .El' that was reported by groff -z`.
Approved by: des (mentor), re (scottl)
2003-05-16 19:57:38 +00:00
Hiten Pandya
e48d599e4f Remove an extraneous space, reported by groff -z.
Approved by: des (mentor), re (scottl)
2003-05-16 19:55:52 +00:00
Hiten Pandya
5466eeeaa7 Remove a bogus NOTES section. Move that content elsewhere.
Approved by: des (mentor), re (scottl)
2003-05-16 19:54:20 +00:00
Hiten Pandya
5f616912b4 Document the ``resource management'' routines in rman(9).
Submitted by: Bruce M. Simpson <bms@spc.org>
Reviewed by: mdodd

Approved by: des (mentor), re (scottl)
2003-05-16 19:22:27 +00:00
John Baldwin
2adcfc5855 - Use better terminology when describing mutex operations in msleep(9)'s
description.
- Remove some bogus commas.
- Use the past tense when referring to the removal of the sleep() function
  since it happened quite a while ago and since the previous sentence in the
  paragraph already uses the past tense.

Approved by:	re (rwatson)
2003-05-16 15:52:32 +00:00
Hiten Pandya
0d740fd5e8 Add a manual page for the CTASSERT(9) macro.
Approved by: des (mentor), re (scottl)
2003-05-16 15:24:07 +00:00
Hiten Pandya
30ecad6f4b Document the VFCF_* flags.
Approved by: des (mentor), re (scottl)
2003-05-16 15:21:20 +00:00
Hiten Pandya
03a0a09e98 Add missing MLINK for arc4rand(9). It is documented in
random(9) and referenced by gbde(4).

PR: docs/51254
Submitted by: Simon L. Nielsen <simon@nitro.dk>
Approved and Reviewed by: des (mentor), re (bmah)
2003-05-09 09:12:10 +00:00
Hiten Pandya
73692bebe4 malloc(9) types can be used to identify multiple allocations.
PR: docs/38618
Approved by: des (mentor)
2003-05-06 19:10:17 +00:00
Tom Rhodes
b655544297 fnet(9) claims that "those interfaces supporting reception of multicast
datagrams have a LIST of multicast group memberships...".  On -CURRENT, that
LIST is actually a TAILQ.  Note that -STABLE still uses a LIST

PR:		50426
Submitted by:	Scott Mitchell <scott+freebsd@fishballoon.org>
2003-05-01 18:34:13 +00:00
Tom Rhodes
f0aa77427a Xref sytle.Makefile(5).
PR:	51183
2003-04-26 15:37:39 +00:00
Warner Losh
bf2331bae4 Document device_set_driver(9)
# now all driver_* functions used outside of subr_bus.o in my kernel
# are documented.
2003-04-22 03:43:44 +00:00
Warner Losh
6e684dce35 Document device_printf(9). 2003-04-22 03:32:31 +00:00
Warner Losh
c56c6bab42 Document device_set_ivars(9) as well. 2003-04-22 03:25:14 +00:00
Warner Losh
44d993e38a man page for device_get_parent. 2003-04-22 00:26:02 +00:00
Warner Losh
c82d43ff7a device_is_alive already was documented in device_get_state, so remove the
separate man page.  Document new device_is_attached there and remove that
new man page too.

Connect device_get_name to build, and install a link for
device_get_nameunit.

strangely nobody noticed this yet...
2003-04-22 00:21:28 +00:00
Warner Losh
f6bcbf520a Add man page for device_get_name and device_get_nameunit. 2003-04-22 00:18:55 +00:00
Warner Losh
1f27c12a7e Xref these two functions, since they are similar enough to cause confusion. 2003-04-21 18:27:44 +00:00
Warner Losh
41c44039c9 Simple man page for new device_is_attached. 2003-04-21 18:25:04 +00:00
Warner Losh
dd7520c9eb Add a man page for device_is_alive. 2003-04-21 18:24:05 +00:00
Mike Silbersack
5a00719d7b Add a description of m_defragrandomfailures. 2003-04-15 02:26:13 +00:00
Mike Silbersack
3cab047e0b Add info on how to use the MBUF_STRESS_TEST options. (Only 1 option
at present.)
2003-04-13 23:31:06 +00:00
Hartmut Brandt
7081c47416 Forced commit to fill in the fields below for the last commit. Also
bump the date of the man page.

PR:		docs/24797
Reviewed by:	bde, jake, jhb
2003-04-10 10:18:56 +00:00
Hartmut Brandt
473e34ce22 Explicitely document the locking requirements for the malloc interface.
While beeing here also correct the following:

 - list missing macros in the header
 - document MALLOC_DEFINE and MALLOC_DECLARE in the SYNOPSIS section
 - document additional include requirements for MALLOC_DEFINE
 - M_NOWAIT is not 0 anymore
 - remove rotted diagnostic messages
2003-04-09 08:27:32 +00:00
Poul-Henning Kamp
21ee4ab688 Add inline functions {be,le}{16,32,64}{enc,dec}() for encoding decoding
into byte strings of unknown alignment.
2003-04-03 08:58:04 +00:00
Warner Losh
4e6e1b8646 rid is not a pointer to int, but rather just a plain int. 2003-03-30 00:30:29 +00:00
Warner Losh
d082b08904 Document what bus_set_resource(9) does. It is used by bus drivers to
bind resources that client drivers later access.
2003-03-30 00:25:23 +00:00
Kris Kennaway
6a897e3f7e Correct a typo in previous commit 2003-03-29 10:12:15 +00:00
Warner Losh
ec33f2d50f Add a new man page for bus_activate_resource and
bus_deactivate_resource.  It could use some improvement, and others
are welcomed to do so :-)
2003-03-29 05:16:15 +00:00