Commit Graph

3775 Commits

Author SHA1 Message Date
Frank Durda IV
9211e402f5 Re-introduction of the matcd Compact Disc drive driver documentation.
The matcd.4 man page has been upgraded to reflect current 5.1.x
functionality, and efforts were made to match the style and layout found
in similar-single purpose block drivers man pages found in the 5.1 tree
man4 area while not losing useful information.  However, the documentation
folks should still take a look, since the man pages used as guides were
somewhat inconsistent on a variety of points.

Approved by:	markm(mentor)
2003-06-17 04:28:12 +00:00
Hartmut Brandt
eeb23684ec Reference the new natmip(4) man page. 2003-06-16 15:51:55 +00:00
Yaroslav Tykhiy
5d96084f89 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
Yaroslav Tykhiy
da72b9983c 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
Yaroslav Tykhiy
7b2fd1831f 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
Yaroslav Tykhiy
be82a0bc5a 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
Mike Makonnen
da02c8c47e Catch up man page with reality in rc.d/named.
Pointed out by:	Simon L. Nielsen <simon@nitro.dk>
2003-06-14 22:43:40 +00:00
Tom Rhodes
1cbb9689ed Remove the old xref to kerberos(1), and replace it with an xref to
kerberos(8).  According to markm, the kerberos(8) manual page is
installed if NO_KERBEROS is set.

PR:	30443
2003-06-14 13:23:49 +00:00
Maxime Henrion
b9b855dd65 - 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
Hartmut Brandt
27dcc304bf Factor out the description of how to configure a CLIP into its own
man page. This will be more scaleable as more driver man pages hit
the tree. Add also a description on how to do this configuration
in the rc.conf script.
2003-06-13 12:33:33 +00:00
Hartmut Brandt
9f03490f0e Remove the documentation of the raw AAL0 access which has been removed.
This raw cell stuff not used in the tree and a doubt that it is used
anywhere else. It was also very Midway specific.
2003-06-13 12:27:41 +00:00
Hartmut Brandt
1ba46a03b7 Make the midway driver use the new ATM phy driver. This allows one to
toggle several media options (sonet/sdh, for example) with ifconfig and
to see the carrier state in ifconfig's output. It gives also read/write
access (given the right privilegs) to the S/Uni registers to user space
programs.
2003-06-13 12:08:09 +00:00
Hiten Pandya
97a30ee292 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
Hartmut Brandt
591f4054cb 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
Hartmut Brandt
33f73ee488 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
Hartmut Brandt
eb74baf398 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
Thomas Moestl
cc264d0083 - Add manpages for the gem and hme ethernet drivers. These were obtained
from NetBSD, and changed slightly to account for FreeBSD specifics.
- Hook them up to the build.
- Add them to the list of miibus-using drivers in miibus(4).
2003-06-10 18:53:15 +00:00
Sheldon Hearn
7c2c06f2cd Add cross-references to pci(4) and pciconf(8). 2003-06-10 09:20:04 +00:00
Hiten Pandya
33659d9aad Hook up pci(9) manual page to the build.
Approved by:	des (mentor)
2003-06-09 17:33:25 +00:00
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
Peter Pentchev
f4c311e6ff Remove duplicate 'of the'.
PR:		53073
Submitted by:	Priit Piipuu <priit.piipuu@mail.ee>
MFC after:	2 weeks
2003-06-09 09:19:21 +00:00
Ruslan Ermilov
93303bace1 Document the NOLIBPTHREAD and NOLIBTHR knobs. 2003-06-08 23:48:02 +00:00
Ceri Davies
8d760375f2 Apply a couple of grammatical improvements.
MFC after:	2 days
2003-06-08 19:49:37 +00:00
Philippe Charnier
c42ce50d6a The .Xr utility 2003-06-08 13:35:40 +00:00
Philippe Charnier
f06471d44a Use .Ic instead of .Xr for internal commands 2003-06-08 13:33:50 +00:00
Philippe Charnier
55241cdbe7 Remove reference to deprecated xtend(8) 2003-06-08 13:31:38 +00:00
Philippe Charnier
c2d6966a95 Add or correct section number in .Xr 2003-06-08 13:27:57 +00:00
Mike Makonnen
d679c13014 The dhcp_program and dhcp_flags variables have to be renamed to
take advantage of the rc.subr(8) glue. They are renamed dhclient_program
and dhclient_flags.
	o Rename them in rc.conf(5)
	o Rename them in /etc/defaults/rc.conf
	o Add the deprecated variables to /etc/rc.subr
	o Isolate the use  of the 'command' variable to the
	  NetBSD specific parts in /etc/rc.d/dhclient.
	o Now that dhcp_flags has also been renamed it will
	  be applied properly by rc.subr(8) glue code.

Reported by:	John Nielsen <john@jnielsen.net>
2003-06-07 10:31:17 +00:00
Ruslan Ermilov
7ad3fab81e Fixed cross references to pccbb(4), fixed spelling of "device cbb",
and linked the pccbb(4) manpage to cbb(4).

Reviewed by:	imp
2003-06-05 21:12:55 +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
Hiten Pandya
f6c211ae08 Mdoc: fix hard sentence breaks.
Approved by: des (mentor)
2003-06-03 14:19:24 +00:00
Hartmut Brandt
ca7810d47e The midway driver has been busdmaified and is not i386-specific anymore.
Repo-copy it from the i386 specific man4 section to the common one.
Remove the i386 keyword from the man page header.
Document the sysctl interface to the driver.
Fix a spelling error (ALL -> AAL).
2003-06-03 07:58:39 +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
Ruslan Ermilov
f937c268cf Assorted mdoc(7) fixes. 2003-06-02 11:19:24 +00:00
Gordon Tetlow
c94887be10 Document netfs_types. 2003-06-02 04:51:55 +00:00
Ruslan Ermilov
3cc3bf5282 Assorted mdoc(7) fixes. 2003-06-01 21:52:59 +00:00
Ruslan Ermilov
bdf95cdef0 Add missing markup bits. 2003-05-31 18:49:23 +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
Ruslan Ermilov
07a38a786a Assorted mdoc(7) fixes. 2003-05-29 21:41:11 +00:00
Ruslan Ermilov
bc9a9cb4d0 Assorted mdoc(7) fixes.
Approved by:	re (blanket)
2003-05-29 21:28:36 +00:00
Ruslan Ermilov
734ac3b543 mdoc(7) fixes.
Approved by:	re (blanket)
2003-05-24 19:53:08 +00:00