Commit Graph

929 Commits

Author SHA1 Message Date
mux
1bee454ec7 Backout part of my previous commit dealing with bus_dmasync_op_t
documentation since people think it was better the way it was before.

Requested by:	gibbs (some time ago)
2003-06-25 13:15:51 +00:00
hmp
fd75f32b65 Add MLINK for busdma(9) to bus_dma(9).
This resolves confusion for at least 10 people.

Suggested by:	Bruce M. Simpson <bms@spc.org>
Approved by:	des (mentor)
2003-06-17 19:50:59 +00:00
yar
59a924bc28 Name a function argument "mbuf", not "buf", if it is
a pointer to struct mbuf for clarity and consistency.
2003-06-15 14:47:12 +00:00
yar
18c9b0b6c2 Add missing descriptions of macros M_ALIGN and MH_ALIGN.
Remove a reference to the defunct macro M_COPY_PKTHDR;
document the new functions m_dup_pkthdr() and m_move_pkthdr(),
and the macro variant of the latter, M_MOVE_PKTHDR().
2003-06-15 14:40:03 +00:00
yar
e159c6524a Add more markup to the mbuf(9) manpage. This includes:
- tagging plaintext "mbuf", "mbuf cluster", and "mbuf chain"
  with .Vt (variable type) since all of them are ways of managing
  data, i.e., they can be seen as data types;

- using .Vt/.Va instead of .Li (literal) where appropriate;

- tagging plaintext words that actually refer to function arguments
  with .Fa.

Suggested by:	ru
2003-06-15 14:14:11 +00:00
yar
771182b0e8 Use .Va, not .Fa, to refer to structure members.
mdoc(7) contains an ambiguous statement on the issue,
but our mdoc(7) police's opinion is solid.

Suggested by:	ru
2003-06-15 12:42:41 +00:00
mux
f7f38ecf5e - Document the fact that you can specify several DMA operations to
bus_dmamap_sync() by OR'ing them together.
- Don't document what BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE and
  BUS_DMASYNC_POSTREAD|BUS_DMASYNC_POSTWRITE is supposed to do when
  passed to bus_dmamap_sync().  There are other possible combinations
  and the reader just needs to know what the individual flags do and
  that he can combine different DMA operations.
- Use .An when listing authors.

Reviewed by:	hmp
2003-06-13 20:07:49 +00:00
hmp
ecf3e78573 Remove paragraph which describes how we might switch our packet queueing
discipline to Random Early Detection (RED) in the future.  The same para
incorrectly spelt ``Random Early Detection'' as ``Random Early Drop''.

While I am there, nuke IF_ENQ_DROP from the list of functions.  More
work will be done on this, since some of the functions like
if_enq_drop() and if_queue_drop() were replaced with one function
called if_handoff() that does the job of enqueing the packet and
updating interface statistics as necessary.

Reviewed by:		wollman
Approved by:		des (mentor)
MFC after:		1 day
2003-06-12 21:33:00 +00:00
harti
246f3d9c06 This is a driver for the physical layer chips used in ATM interfaces.
It currently supports the PMC Sierra Lite, Ultra and 622 chips and
the IDT 77105. The driver handles media options and state in a consistent
manner for ATM drivers. The next commit to the midway driver will make
it use utopia.
2003-06-12 14:28:32 +00:00
harti
8ce1f89230 Document the fact that one is allowed to sleep while holding an sx lock.
Discussed with: jhb@
2003-06-12 09:06:25 +00:00
harti
c707f7c3f3 Rename the section 'locking considerations' into 'context'.
Change the wording in this section to get rid of references to mutexes
and talk about sleeping instead.

Discussed with: jhb@, ru@
2003-06-12 09:03:15 +00:00
sheldonh
f33eceddeb Add cross-references to pci(4) and pciconf(8). 2003-06-10 09:20:04 +00:00
hmp
286a32fdca Hook up pci(9) manual page to the build.
Approved by:	des (mentor)
2003-06-09 17:33:25 +00:00
hmp
a223347156 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
charnier
802148582e Add or correct section number in .Xr 2003-06-08 13:27:57 +00:00
rwatson
b4d5efdf4a Document VOP_LISTEXTATTR(9).
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-06-05 14:20:48 +00:00
rwatson
ddc7fd7848 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
rwatson
db515f9f9e 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
rwatson
732b5c97ea 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
ru
0078b69f61 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
ru
cdf8f3ce4a Restore one usage of .Ar that was legal. 2003-06-02 15:32:34 +00:00
ru
29f9643911 Assorted mdoc(7) fixes. 2003-06-02 15:02:06 +00:00
hmp
7283092cef 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
hmp
d535a2bede 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
hmp
5d71788a05 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
hmp
06641851f8 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
ru
9480eb3914 Assorted mdoc(7) fixes. 2003-05-30 21:13:32 +00:00
hmp
8b46771dce 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
ru
6fc42a1335 Link {be,le}{16,32,64}{enc,dec}.9 to byteorder.9.
Approved by:	re (blanket)
2003-05-21 17:37:22 +00:00
ru
feaf41d514 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
ru
19a4968055 Kill whitespace at EOL.
Approved by:	re (blanket)
2003-05-21 15:55:40 +00:00
ru
4651223aa2 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
ru
aaa0f05b80 Assorted mdoc(7), grammar, spelling, and punctuation fixes.
Approved by:	re (blanket)
2003-05-21 15:49:01 +00:00
ru
5a893bc465 Fixed troff(1) and mdoc(7) warnings.
Approved by:	re (blanket)
2003-05-18 21:05:22 +00:00
hmp
7d7228c36b Remove an extraneous .El' that was reported by groff -z`.
Approved by: des (mentor), re (scottl)
2003-05-16 19:57:38 +00:00
hmp
161e6cddaa Remove an extraneous space, reported by groff -z.
Approved by: des (mentor), re (scottl)
2003-05-16 19:55:52 +00:00
hmp
73bedef574 Remove a bogus NOTES section. Move that content elsewhere.
Approved by: des (mentor), re (scottl)
2003-05-16 19:54:20 +00:00
hmp
c2a920683c 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
jhb
15ba1fce6f - 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
hmp
85ab052a63 Add a manual page for the CTASSERT(9) macro.
Approved by: des (mentor), re (scottl)
2003-05-16 15:24:07 +00:00
hmp
934c5dcced Document the VFCF_* flags.
Approved by: des (mentor), re (scottl)
2003-05-16 15:21:20 +00:00
hmp
9df1d1f84b 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
hmp
94f281ee94 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
trhodes
cae8c47af0 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
trhodes
4d37b34b62 Xref sytle.Makefile(5).
PR:	51183
2003-04-26 15:37:39 +00:00
imp
823ba059c1 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
imp
b126d5fd0e Document device_printf(9). 2003-04-22 03:32:31 +00:00
imp
8515f23dc5 Document device_set_ivars(9) as well. 2003-04-22 03:25:14 +00:00
imp
eea2b01ecc man page for device_get_parent. 2003-04-22 00:26:02 +00:00
imp
197d721da8 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