Commit Graph

705 Commits

Author SHA1 Message Date
Ruslan Ermilov
c4d9468ea0 mdoc(7) police:
Avoid using parenthesis enclosure macros (.Pq and .Po/.Pc) with plain text.
Not only this slows down the mdoc(7) processing significantly, but it also
has an undesired (in this case) effect of disabling hyphenation within the
entire enclosed block.
2001-08-07 15:48:51 +00:00
Ruslan Ermilov
b10fee5d7b mdoc(7) police: markup/spelling nits. 2001-08-07 14:12:13 +00:00
Jason Evans
920ae52d67 Document sx_try_[sx]lock(). 2001-08-07 04:29:53 +00:00
Sheldon Hearn
86f478757a MFS: in HISTORY section, fix release number of first appearance 2001-08-01 12:15:21 +00:00
Alfred Perlstein
0a6ca2a733 More updates from Chad.
Submitted by: Chad David <davidc@acns.ab.ca>
Reviewed by: sheldonh
2001-07-30 22:14:23 +00:00
Chris Costello
2ec27ccd83 Add a short man page describing the vfs_unmountall() function.
MFC after:	1 week
2001-07-27 03:54:59 +00:00
Dima Dorfman
3b08168907 Change the errx() example. Error messages passed to the err(3)
functions shouldn't have the first word capitalized, and shouldn't
have a period at the end.  This is how most of our programs, and most
(all?) of the 4.4BSD programs, are.  In the past, we've even done
sweeps to change things to comply to this.
2001-07-22 11:47:15 +00:00
Dima Dorfman
ebb02791f2 Add: ``If you have to wrap a long statement, put the operator at the
end of the line.''

Reviewed by:	alfred, bde
2001-07-22 10:35:02 +00:00
Alfred Perlstein
1bb3a48f15 remove -*- nroff -*- thingy 2001-07-22 10:18:53 +00:00
David E. O'Brien
16a7ef9327 State explicitly how the manpage "DESCRIPTION" options should be listed. 2001-07-19 18:03:43 +00:00
Dag-Erling Smørgrav
22cbe5e31f 4.4 will have sbufs. 2001-07-19 09:07:51 +00:00
Alfred Perlstein
609ad476a3 Install and provide MLINKS for:
pbuf.9 vm_page_alloc.9 vm_page_copy.9 vm_page_flag.9 vm_page_hold.9
 vm_page_insert.9 vm_page_io.9 vm_page_lookup.9 vm_page_protect.9
 vm_page_sleep_busy.9 vm_page_wakeup.9 vm_page_wire.9
 vm_page_zero_fill.9 vm_set_page_size.9
2001-07-18 06:10:33 +00:00
Alfred Perlstein
6484c361f7 Document some of the kernel vm_page API as well as the pbuf API.
Submitted by: Chad David <davidc@acns.ab.ca>
2001-07-18 06:09:13 +00:00
Ruslan Ermilov
60f79c3c34 Spelling: aquire -> acquire. 2001-07-16 07:37:22 +00:00
Ruslan Ermilov
17a3206c22 Manpage for pfind() and zpfind().
Submitted by:	Evan Sarmiento <kaworu@sektor7.ath.cx>
2001-07-16 07:04:09 +00:00
Jens Schweikhardt
c1f3e4bf21 Removed whitespace at end-of-line; no content changes. I simply did
cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//'

BTW, what editors are the culprits? I'm using vim and it shows
me whitespace at EOL in troff files with a thick blue block...

Reviewed by:	Silence from cvs diff -b
MFC after:	7 days
2001-07-14 19:41:16 +00:00
Jens Schweikhardt
d1ed27b64a Fixed double word typo.
MFC after:	7 days
2001-07-13 20:11:43 +00:00
Ruslan Ermilov
4772483c00 Add a few more manpages from Chad.
Fold major.9, minor.9, umajor.9, and uminor.9 into a single device_ids.9.
2001-07-13 18:35:48 +00:00
Alexander Langer
4dad593a95 - correct two typos
- Use NULL instead of 0 for pointers (style(9)!)

Submitted by:	Joel Wilsson <siigron@sii.linuxsweden.nu>
MFC after:	37 days
2001-07-13 16:10:39 +00:00
Ruslan Ermilov
e8b02a428d mdoc(7) police: -xwidth has been fold into -width. 2001-07-13 09:09:52 +00:00
Ruslan Ermilov
034709cb72 Merge Chad's fixes. 2001-07-13 08:14:54 +00:00
Ruslan Ermilov
2378902495 mdoc(7) police: fixed markup and some content typos. 2001-07-11 10:31:49 +00:00
Ruslan Ermilov
4bc6a387c2 mdoc(7) police: fixed markup. 2001-07-11 09:13:12 +00:00
Alfred Perlstein
0ef36920de I have gone through all of the functions and added
the correct includes and changed the functions as
    requested.

Submitted by: Chad David <davidc@acns.ab.ca>
2001-07-11 03:51:44 +00:00
Ruslan Ermilov
3d45e180f4 mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00
Alfred Perlstein
d248afb3b2 Sort MAN= section. 2001-07-10 07:42:35 +00:00
Alfred Perlstein
8adb2d7b0e Install:
cdevsw_add.9 cdevsw_remove.9 devsw.9
major.9 minor.9 umajor.9 uminor.9 vn_isdisk.9
2001-07-10 07:28:11 +00:00
Alfred Perlstein
f1ccaa63b8 Document some of the dev_t related APIs.
Submitted by: Chad David <davidc@acns.ab.ca>
2001-07-10 07:25:18 +00:00
Alfred Perlstein
5c5e4328d3 Link in new manpages:
BUF_LOCK.9 BUF_LOCKFREE.9 BUF_LOCKINIT.9
BUF_REFCNT.9 BUF_TIMELOCK.9 BUF_UNLOCK.9
lockcount.9 lockdestroy.9 lockmgr.9 lockmgr_printinfo.9 lockstatus.9
2001-07-10 04:35:22 +00:00
Alfred Perlstein
983bb14077 Note that this function is for debugging purposes. 2001-07-10 04:31:33 +00:00
Alfred Perlstein
275a0fac29 Fix explanation of LK_SLEEPFAIL option.
Remove extra period from end of sentance.
2001-07-10 04:29:24 +00:00
Alfred Perlstein
ec12cfb58b fix typos: s/BUF_LOCK/BUF_TIMELOCK, order xrefs. 2001-07-10 04:27:03 +00:00
Alfred Perlstein
82ed18ac0c Document some of the kernel API dealing with locks used primarily by VFS.
Submitted by: Chad David <davidc@acns.ab.ca>
2001-07-10 04:22:14 +00:00
Dima Dorfman
70d51341bf mdoc(7) police: remove extraneous .Pp before and/or after .Sh. 2001-07-09 09:54:33 +00:00
Alfred Perlstein
ffe734e3a2 Link in manpages for vfs_busy, vfs_mount, vfs_unbusy, and vinvalbuf. 2001-07-09 07:15:51 +00:00
Alfred Perlstein
8981fef84c Document kernel API for vfs_busy(), vfs_mount(), vfs_unbusy(), and
vinvalbuf().

Submitted by: Chad David <davidc@acns.ab.ca>
2001-07-09 06:47:10 +00:00
Ruslan Ermilov
5521ff5a4d mdoc(7) police: sort SEE ALSO xrefs (sort -b -f +2 -3 +1 -2). 2001-07-06 16:46:48 +00:00
Ruslan Ermilov
83c9300962 mdoc(7) police: minor formatting fixes. 2001-07-06 09:20:19 +00:00
Dag-Erling Smørgrav
8cce2ebaf3 Constify the format string.
Submitted by:	Mike Barcroft <mike@q9media.com>
Forgotten by:	des
2001-07-05 22:34:11 +00:00
Ruslan Ermilov
d68b700a78 mdoc(7) police: mark type with .Vt, sort xrefs. 2001-07-04 15:37:13 +00:00
Ruslan Ermilov
e3718e310c mdoc(7) police: cosmetics. 2001-07-04 15:32:44 +00:00
Joerg Wunsch
72fb076dce Don't give a bad example by starting a struct tag name with an
underscore.  Names starting with an underscore are reserved.
2001-07-03 16:22:42 +00:00
John Baldwin
a1382e7fd2 Add a new manpage to document the CTRx macros used when adding new KTR
tracepoints to kernel code.
2001-06-28 07:20:05 +00:00
Dima Dorfman
9e28aca5d2 mdoc(7) police: use the Fn macro where appropriate. 2001-06-24 01:38:20 +00:00
Dima Dorfman
a910f192bb Remove duplicate words. 2001-06-24 01:34:38 +00:00
Dima Dorfman
bdd87f4f44 Correct a typo. 2001-06-24 01:30:38 +00:00
Dima Dorfman
c91ed2eb6c Correct getopt usage and a syntax error (period used instead of a semicolon). 2001-06-18 20:36:06 +00:00
Robert Watson
0734b428c7 o The VOP_RDWR man page neglected to mention (at least) two error modes
possible when writing:

     [EFBIG]            An attempt was made to write a file that exceeds
                        the process's file size limit or the maximum file
                        size.

     [EPERM]            An append-only flag is set on the file, but the
                        caller is attempting to write before the current
                        end of file.
2001-06-15 16:12:41 +00:00
Dag-Erling Smørgrav
b0def2b548 Add sbuf_copyin(). Also add 'b' variants of sbuf_{cat,copyin,cpy}() which
ignore NUL bytes in the source string.
2001-06-11 17:05:52 +00:00
Dag-Erling Smørgrav
d647935801 sbuf_new(9) now returns a struct sbuf * instead of an int. If the caller
does not provide a struct sbuf, sbuf_new(9) will allocate one and return
a pointer to it.
2001-06-10 15:48:04 +00:00
Ruslan Ermilov
0b381bf1fd Remove vestiges of MFS. 2001-06-01 10:07:28 +00:00
Dima Dorfman
8a6ecebcdf Link make_dev.9 to make_dev_alias.9 and depends_dev.9. 2001-05-29 04:17:36 +00:00
Dima Dorfman
f14b89faeb Document depends_dev.
Reviewed by:	phk
2001-05-29 04:14:33 +00:00
Dima Dorfman
a19771414c Remove obsolete DEVFS manual pages. The routines they describe don't
exist in the new (phk's) DEVFS.

Approved by:	phk
2001-05-28 20:27:23 +00:00
Jimmy Olgeni
88bc7f853c Fix typo: "an socket" -> "a socket".
Place period at the end of AUTHORS section.

MFC after:	1 week
2001-05-27 22:17:46 +00:00
David E. O'Brien
19d4c7b3d7 Back out rev 1.50. VCS was correct -- it is Version Control System. 2001-05-17 02:05:36 +00:00
Doug Barton
6c7344c5dd Minor typos 2001-05-17 01:36:01 +00:00
Dima Dorfman
2656302f76 Fix a typo (pasto?). 2001-05-09 05:03:35 +00:00
Kazuo Horikawa
fdabcac610 Fix typos.
o replace `of possible' with `if possible'
o VOP_SETACL(9) is modified to say about `ACL' instead of `extended
  attributed'
o EOPNOTSUPP of VOP_SETEXTATTR(9) is modified to say about
  VOP_SETEXTATTR(9) instead of VOP_GETEXTATTR(9)

Reviewed by: Robert Watson <rwatson@FreeBSD.org>,
	 Chris Costello <chris@calldei.com>
2001-05-07 22:15:18 +00:00
Ruslan Ermilov
15c613547e A bit of markup and spelling fixes. 2001-05-07 12:48:38 +00:00
Dima Dorfman
563aaa6519 s/mtx_try_enter/mtx_trylock/ 2001-05-06 22:04:17 +00:00
Dima Dorfman
1f7eace1d1 Add printf.9, and add links to tprintf.9 and uprintf.9. 2001-05-05 00:25:39 +00:00
Dima Dorfman
1be41bcf25 A manual page for the printf(), uprintf(), and tprintf() kernel functions.
Submitted by:	Andrew R. Reiter <arr@watson.org>
Reviewed by:	jhb
2001-05-04 23:25:58 +00:00
Jens Schweikhardt
e986850f9f Fixed typos: dependant -> dependent 2001-05-01 14:10:12 +00:00
Alexander Langer
63060b7aef Improve description of "new_sysent". 2001-04-28 13:19:20 +00:00
Alexander Langer
50c39ea7a5 Add SYSCALL_MODULE.9, a manpage for the SYSCALL_MODULE wrapper macro
for syscall klds.

Some text of this manpage is based on the comments in the example
syscall module written by Assar Westerlund.

Reviewed by:	ru
2001-04-28 13:18:40 +00:00
David E. O'Brien
d6eb63ec62 Reduce the number of $FreeBSD$'s from 3 to 2. I believe both remaining
are needed for proper examples.
2001-04-25 20:58:28 +00:00
Ruslan Ermilov
3a3799c99e mdoc(7) police: update HISTORY section.
This interface is not available in 4.3-RELEASE.
2001-04-23 15:22:50 +00:00
David E. O'Brien
58eac5ef6a Address $FreeBSD$ and `rcsid'. 2001-04-22 02:32:42 +00:00
David E. O'Brien
1076a975f5 Fix prototype wrap example and note how to wrap ANSI-style function
definitions.
2001-04-22 02:00:39 +00:00
Ruslan Ermilov
eb0838029f mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00
Ruslan Ermilov
8adc94de6a mdoc(7) police: use .Fx. 2001-04-18 13:39:57 +00:00
Ruslan Ermilov
5f95f24bf4 mdoc(7) police: uppercase document title. 2001-04-18 08:25:26 +00:00
Dima Dorfman
5e75e35cca Grammar police: "its", not "it's", is the possessive form of "it". 2001-04-15 19:53:47 +00:00
Alfred Perlstein
4c7da4f92c note that VOP_STRATEGY may block.
Learned from: vm/swap_pager.c comment above swap_pager_putpages()
2001-04-15 12:04:05 +00:00
Ruslan Ermilov
d6a2bd5bd1 mdoc(7) police: removed final dot from the .Nd call. 2001-04-04 12:00:29 +00:00
Ruslan Ermilov
1f01235249 mdoc(7) police: there is no single manpage that uses ``.Sy not''. 2001-04-04 11:57:03 +00:00
John Baldwin
1c39cfb650 Correct the MLINKS for mutex.9 to reflect the API change and add a new
MLINK for mtx_initialized.

Reminded by:	rwatson
2001-03-30 23:00:00 +00:00
John Baldwin
0630abadd1 - Document mtx_initialized().
- Document that MTX_QUIET can be passed to mtx_init() and the new flag
  MTX_NOWITNESS.
2001-03-30 22:59:02 +00:00
Bruce Evans
eac993bcaa Fixed bitrot in the prototypes for NDINIT and NDFREE. 2001-03-29 10:29:37 +00:00
Bruce Evans
74c3913eb4 Fixed missing and disorded includes in synopsis.
Removed bogus quotes in .Fn invocations.  Single words don't need quoting.
2001-03-29 10:18:54 +00:00
Bruce Evans
16bef91c0a Fixed wrong include in synopsis. <sys/param.h> is a prerequisite for
<sys/mutex.h> due to #include spam in <sys/mutex.h>.  (More precisely,
<sys/time.h> is the prerequisite, but that is provided by standard
#include spam in <sys/param.h>.)

Fixed bitrot in prototype for mtx_init().
2001-03-29 10:06:50 +00:00
Dag-Erling Smørgrav
d67fe1bd2f Prepare for pseudofs. 2001-03-28 22:21:07 +00:00
John Baldwin
ad84c9eb36 - Both <sys/sx.h> and <sys/mutex.h> depend on <sys/types.h> and
<sys/lock.h>.
- <sys/sx.h> depends on <sys/mutex.h>.
2001-03-28 12:45:41 +00:00
John Baldwin
5ecf40428d Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00
Ruslan Ermilov
acaf79e1b9 MAN[1-9] -> MAN. 2001-03-27 13:48:25 +00:00
Kenneth D. Merry
3393f8daa3 Rewrite of the CAM error recovery code.
Some of the major changes include:

	- The SCSI error handling portion of cam_periph_error() has
	  been broken out into a number of subfunctions to better
	  modularize the code that handles the hierarchy of SCSI errors.
	  As a result, the code is now much easier to read.

	- String handling and error printing has been significantly
	  revamped.  We now use sbufs to do string formatting instead
	  of using printfs (for the kernel) and snprintf/strncat (for
	  userland) as before.

	  There is a new catchall error printing routine,
	  cam_error_print() and its string-based counterpart,
	  cam_error_string() that allow the kernel and userland
	  applications to pass in a CCB and have errors printed out
	  properly, whether or not they're SCSI errors.  Among other
	  things, this helped eliminate a fair amount of duplicate code
	  in camcontrol.

	  We now print out more information than before, including
	  the CAM status and SCSI status and the error recovery action
	  taken to remedy the problem.

	- sbufs are now available in userland, via libsbuf.  This
	  change was necessary since most of the error printing code
	  is shared between libcam and the kernel.

	- A new transfer settings interface is included in this checkin.
	  This code is #ifdef'ed out, and is primarily intended to aid
	  discussion with HBA driver authors on the final form the
	  interface should take.  There is example code in the ahc(4)
	  driver that implements the HBA driver side of the new
	  interface.  The new transfer settings code won't be enabled
	  until we're ready to switch all HBA drivers over to the new
	  interface.

src/Makefile.inc1,
lib/Makefile:		Add libsbuf.  It must be built before libcam,
			since libcam uses sbuf routines.

libcam/Makefile:	libcam now depends on libsbuf.

libsbuf/Makefile:	Add a makefile for libsbuf.  This pulls in the
			sbuf sources from sys/kern.

bsd.libnames.mk:	Add LIBSBUF.

camcontrol/Makefile:	Add -lsbuf.  Since camcontrol is statically
			linked, we can't depend on the dynamic linker
			to pull in libsbuf.

camcontrol.c:		Use cam_error_print() instead of checking for
			CAM_SCSI_STATUS_ERROR on every failed CCB.

sbuf.9:			Change the prototypes for sbuf_cat() and
			sbuf_cpy() so that the source string is now a
			const char *.  This is more in line wth the
			standard system string functions, and helps
			eliminate warnings when dealing with a const
			source buffer.

			Fix a typo.

cam.c:			Add description strings for the various CAM
			error status values, as well as routines to
			look up those strings.

			Add new cam_error_string() and
			cam_error_print() routines for userland and
			the kernel.

cam.h:			Add a new CAM flag, CAM_RETRY_SELTO.

			Add enumerated types for the various options
			available with cam_error_print() and
			cam_error_string().

cam_ccb.h:		Add new transfer negotiation structures/types.

			Change inq_len in the ccb_getdev structure to
			be "reserved".  This field has never been
			filled in, and will be removed when we next
			bump the CAM version.

cam_debug.h:		Fix typo.

cam_periph.c:		Modularize cam_periph_error().  The SCSI error
			handling part of cam_periph_error() is now
			in camperiphscsistatuserror() and
			camperiphscsisenseerror().

			In cam_periph_lock(), increase the reference
			count on the periph while we wait for our lock
			attempt to succeed so that the periph won't go
			away while we're sleeping.

cam_xpt.c:		Add new transfer negotiation code.  (ifdefed
			out)

			Add a new function, xpt_path_string().  This
			is a string/sbuf analog to xpt_print_path().

scsi_all.c:		Revamp string handing and error printing code.
			We now use sbufs for much of the string
			formatting code.  More of that code is shared
			between userland the kernel.

scsi_all.h:		Get rid of SS_TURSTART, it wasn't terribly
			useful in the first place.

			Add a new error action, SS_REQSENSE.  (Send a
			request sense and then retry the command.)
			This is useful when the controller hasn't
			performed autosense for some reason.

			Change the default actions around a bit.

scsi_cd.c,
scsi_da.c,
scsi_pt.c,
scsi_ses.c:		SF_RETRY_SELTO -> CAM_RETRY_SELTO.  Selection
			timeouts shouldn't be covered by a sense flag.

scsi_pass.[ch]:		SF_RETRY_SELTO -> CAM_RETRY_SELTO.

			Get rid of the last vestiges of a read/write
			interface.

libkern/bsearch.c,
sys/libkern.h,
conf/files:		Add bsearch.c, which is needed for some of the
			new table lookup routines.

aic7xxx_freebsd.c:	Define AHC_NEW_TRAN_SETTINGS if
			CAM_NEW_TRAN_CODE is defined.

sbuf.h,
subr_sbuf.c:		Add the appropriate #ifdefs so sbufs can
			compile and run in userland.

			Change sbuf_printf() to use vsnprintf()
			instead of kvprintf(), which is only available
			in the kernel.

			Change the source string for sbuf_cpy() and
			sbuf_cat() to be a const char *.

			Add __BEGIN_DECLS and __END_DECLS around
			function prototypes since they're now exported
			to userland.

kdump/mkioctls:		Include stdio.h before cam.h since cam.h now
			includes a function with a FILE * argument.

Submitted by:	gibbs (mostly)
Reviewed by:	jdp, marcel (libsbuf makefile changes)
Reviewed by:	des (sbuf changes)
Reviewed by:	ken
2001-03-27 05:45:52 +00:00
Alexander Langer
80b91e98af Sort includes and remove bogus typedef of modeventhand_t, since this
isn't used in the example any more.

Pointed out by:		bde
2001-03-24 12:18:45 +00:00
Alexander Langer
12829b5fd8 - DECLARE_MODULE needs SYSINIT -> include sys/kernel.h
- modeventhand_t declares a pointer to a function, so it can't be
  used as a forward declaration (d'oh!)

Submitted by:	Harti Brandt <brandt@fokus.gmd.de>
2001-03-23 14:05:05 +00:00
Robert Watson
6feb993d95 o Rename "namespace" argument to "attrnamespace" as namespace is a C++
reserved word

Submitted by:	jkh
Obtained from:	TrustedBSD Project
2001-03-19 05:53:39 +00:00
Alexander Langer
ec5dc5774c Fix typo: s/DRIVERMODULE/DRIVER_MODULE/
PR:		25901
Submitted by:	Maxime Henrion <mux@qualys.com>
2001-03-18 16:54:39 +00:00
Robert Watson
e2cd9aeda3 o The revenge of the mdoc(7) police:
- These pages abused Ar macro (they should have used Fa).
   - NULL and other numeric constants should be marked with Dv.
   - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked
     with Fn.

Submitted by:	ru
2001-03-16 17:42:38 +00:00
Robert Watson
42f558db10 o The mdoc(7) police strike with avengance:
- These pages abused Ar macro (they should have used Fa).
   - NULL constant should be marked with Dv.
   - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked
     with Fn.

Submitted by:	ru
2001-03-16 15:02:30 +00:00
Ruslan Ermilov
ef99442288 mdoc(7) police: empty lines outside displays cause warnings in -mdocNG. 2001-03-16 13:50:50 +00:00
Robert Watson
50b19f1978 o Update some of the kernel man pages associated with extended attributes
to reflect EA API change to explicit namespacing.

Obtained from:	TrustedBSD Project
2001-03-15 03:13:58 +00:00
Ruslan Ermilov
edf0984dae mdoc(7) police:
removed hard sentence breaks, use Ft for function return type.
2001-03-12 10:15:03 +00:00
Ruslan Ermilov
0048d07db2 Fixed typo. 2001-03-12 10:07:33 +00:00
Ruslan Ermilov
90bd299417 mdoc(7) police: misc formatting fixes. 2001-03-12 09:26:32 +00:00
Ruslan Ermilov
e38cc86b60 mdoc(7) police: mark C types with Vt macro. 2001-03-12 08:54:49 +00:00
Boris Popov
e95f56120b Apply some grammar fixes.
Submitted by:	asmodai
2001-03-12 05:18:37 +00:00
Matt Jacob
792b236965 Document the make_dev_alias function. 2001-03-11 20:10:45 +00:00
Alexander Langer
74169a2c54 Add a manpage for the DEV_MODULE kernel macro. 2001-03-11 17:30:08 +00:00
Alexander Langer
3dca0e13fc Use type of modeventhand_t for the event handler (defined in module.h).
Add a reference to module(9) for more info about the event handler.
2001-03-11 17:07:20 +00:00
Alexander Langer
a8ed195d01 Fix brain damage: s/CDEV_MODULE/DEV_MODULE/ 2001-03-11 16:52:17 +00:00
Alexander Langer
ed488dd0c8 Add MODULE_DEPEND.9 and MODULE_VERSION.9 2001-03-11 14:42:38 +00:00
Alexander Langer
7b8dd7efbf Add a manpage for the MODULE_DEPEND macro. 2001-03-11 14:33:34 +00:00
Alexander Langer
3d34e980a0 Add a manpage for the MODULE_VERSION macro. 2001-03-11 14:33:15 +00:00
Alexander Langer
9790b255bb Add calls to MODULE_VERSION and MODULE_DEPEND to the EXAMPLE. 2001-03-11 14:18:23 +00:00
Alexander Langer
26b104142d Cross references between the DEVICE_*(9) manual pages. 2001-03-10 19:53:38 +00:00
Alexander Langer
66abaf8210 Add references to the various DEVICE_*(9) manpages, otherwise people
don't even know about these.
2001-03-10 19:42:26 +00:00
Alexander Langer
448be9f93c Add DEVICE_IDENTIFY.9 2001-03-10 19:37:27 +00:00
Alexander Langer
2fccaec614 Add a manpage for the last of the driver's functions, the identify
routine.

PR:		18654
Submitted by:	myself (reworked today)
2001-03-10 19:34:42 +00:00
Alexander Langer
ab71708be3 Two mdoc fixes:
- .Os is used without "FreeBSD" nowadays.
- remove hard sentence breaks.
2001-03-10 19:12:46 +00:00
Boris Popov
a1a5ca5514 Add documentation for mchain API.
Reviewed by:	asmodai, ru (mbchain.9)
2001-03-10 06:10:48 +00:00
Alexander Langer
85ac71e9c6 Add module.9 and DECLARE_MODULE.9 2001-03-09 14:16:46 +00:00
Alexander Langer
8b26e61fab Add a general manpage about kernel modules, similar to driver(9).
Reviewed by:	dfr, ru
2001-03-09 14:12:43 +00:00
Alexander Langer
b6a55e7adc Add a manpage for the kernel macro DECLARE_MODULE.
Reviewed by:	dfr, ru
2001-03-09 14:11:56 +00:00
John Baldwin
ebadd4f5b1 Document the ithread_* API used to manage interrupt threads and their
list of handlers.
2001-03-09 03:30:20 +00:00
John Baldwin
d265f30080 Add 2001 to copyright. 2001-03-09 03:17:18 +00:00
John Baldwin
29ef536da3 - Add 2001 to copyright.
- Kthread functions return an error status, they don't set errno to an
  error status.
- Remove the BUGS section as all the bugs listed have been fixed now.
2001-03-09 03:09:30 +00:00
Mark Murray
adcaec54eb Grammar police. 2001-03-06 10:19:12 +00:00
Mark Murray
63fe79c5e8 Fix markup.
Submitted by:	ru
2001-03-06 10:08:36 +00:00
Ruslan Ermilov
79cd39f2dd mdoc(7) police: Use Vt for variable types. 2001-03-06 08:22:10 +00:00
John Baldwin
3d92386026 Adjust swi.9 MLINKS to catch up to the new swi API. 2001-03-05 23:48:38 +00:00
John Baldwin
9ebce8e5b5 Catch up to the new swi API. 2001-03-05 23:47:34 +00:00
Jason Evans
6281b30a73 Implement shared/exclusive locks.
Reviewed by:	bmilekic, jake, jhb
2001-03-05 19:59:41 +00:00
Mark Murray
f4e8d446d8 Extra MLINKS to reflect expansion of BUS_SETUP_INTR(9) manpage. 2001-03-03 14:19:39 +00:00
Mark Murray
3adc6e857d Add a whole lot of extra info. Lots was gained from reading code
or comments, and some is as a result of simply documenting the
entropy harvester.

This still needs work: could a newbus guru pleazse follow up
and fix.extend my (no doubt) obvious mistakes!
2001-03-03 14:13:53 +00:00
Ruslan Ermilov
2a7e12fdbd mdoc(7) police: in -offset clause, spell the ``indent'' correctly. 2001-03-02 09:38:50 +00:00
Ruslan Ermilov
e6959b888b Fix the rest of formatting. 2001-03-02 08:09:19 +00:00
Warner Losh
6e5801f1af Add link for resource_query_unit, now documented in the
resource_query_string man page.
2001-03-02 04:32:50 +00:00
Warner Losh
2a2c539448 Flesh out this man page a bit more. Add information about
resource_query_unit and improve the descriptions of the parameters
passed to these functions.

Plus a couple minor formatting/markup changes:
o Quote -1 as \-1.
o .Dq hints to match resource_int_value().
2001-03-02 04:30:16 +00:00
Jeroen Ruigrok van der Werven
a9d6a1e2e5 Correct English used. 2001-03-01 09:37:38 +00:00
Ruslan Ermilov
d99c63df5a Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00
Jeroen Ruigrok van der Werven
392651edbe Hook Warner's resource_* manpages to the build.
This includes appropriate MLINKS for the other functions contained
within them.
2001-03-01 09:06:57 +00:00
Jeroen Ruigrok van der Werven
d8c9da66bd Remove leading . from .Nd description. 2001-03-01 09:02:01 +00:00
Jeroen Ruigrok van der Werven
1b766e78e8 Fix typo: the the -> to the. 2001-03-01 09:01:43 +00:00
Warner Losh
39b793da82 Document the resource_*_value and resource_query_string families of
functions.  These man pages likely need some markup work, so I've
specifically not added them to the Makefile yet.
2001-03-01 04:28:40 +00:00
Ben Smithurst
31e230ad42 Expand
if ((foo = bar()) != 0)

to
	foo = bar();
	if (foo != 0)

Submitted by:	phk
2001-02-21 20:43:55 +00:00
Ben Smithurst
06c8ab0c3c Don't suggest
if (error = function(a1, a2))

since it causes a warning with -Wall.  Change it so it has an explicit test
against zero,

	if ((error = function(a1, a2)) != 0)
2001-02-21 12:10:19 +00:00
Ruslan Ermilov
0b39b3ff10 mdoc(7) police: sanitize previous revision changes. 2001-02-16 09:05:48 +00:00
Bosko Milekic
328c0bbcf7 Document recently-implemented m_getm(). 2001-02-16 03:23:04 +00:00
Bruce Evans
2c9ba841c6 Fixed bitrot in synopsis. The Lite2 change from int to u_long for ioctl
command numbers had not reached here.
2001-02-15 12:54:34 +00:00
Bruce Evans
802cdd5fb2 Fixed rotted-as-committed pseudo-prototype for VFS_CHECKXP(). It had not
caught up with the changes to avoid storing socket addresses in mbufs,
although the VFS_CHECKEXP() code had to since it was committed 2 years
after those changes.

Fixed formatting in this prototype.
2001-02-15 12:41:44 +00:00
Bruce Evans
206402b24d Fixed bitrot in synopsis (some const poisoning had not reached here). 2001-02-15 12:27:11 +00:00
Bruce Evans
a10f4352b9 Fixed missing and wrong includes in synopsis. The prerequisites for
using bus_alloc_resource(), etc., are especially unobvious, but were
especially wrong (<sys/resource.h> has nothing to do with the resources
documented here...).  Order and format the includes as correctly as
possible (a layering violation makes <machine/bus.h> a prerequisite for
<sys/rman.h>).
2001-02-15 12:21:44 +00:00
Bruce Evans
6c613605bc Fixed missing include in synopsis.
Added evil #define of ACCEPT_FILTER_MODULE to synopsis.  Some of
the functions defined in this man page aren't declared unless
ACCEPT_FILTER_MOD is defined before including <sys/socketvar.h>.
2001-02-15 11:58:38 +00:00
Bruce Evans
2ba5bb1ff5 Fixed missing and/or wrong and/or extra includes in synopsis. 2001-02-15 11:47:31 +00:00
Ruslan Ermilov
51b37a2355 mdoc(7) cleanup. 2001-02-12 10:56:50 +00:00
Bosko Milekic
6f08f8297c Catch up to mutex API changes. 2001-02-12 03:14:57 +00:00
Ruslan Ermilov
46eea498da mdoc(7) police: Change -filled displays (which just happen
to be the same as -ragged in the current implementation) to
-ragged.  With mdocNG, -filled displays produce the correct
output, formatted and justified to both margins.
2001-02-07 13:45:30 +00:00
Ruslan Ermilov
b74e63f284 mdoc(7) police: Removed extraneous .No call. The .Nm macro in
mdocNG has been fixed to properly handle its arguments so this
was causing the extraneous (undesirable) space.
2001-02-07 10:11:57 +00:00
Ruslan Ermilov
308aca6c86 mdoc(7) police: minor style/formatting fixes. 2001-02-06 15:07:35 +00:00
Ruslan Ermilov
eb8afd58fe mdoc(7) police: minor style/formatting fixes. 2001-02-06 14:58:39 +00:00
Boris Popov
c7adfa9cf9 Add man page for VOP_GETVOBJECT, VOP_CREATEVOBJECT and VOP_DESTROYVOBJECT
operations.

Reviewed by:	sheldonh
2001-02-06 10:33:37 +00:00
Jeroen Ruigrok van der Werven
bcf588d94e Add vcount.9 / count_dev.9.
Touched up a bit and added some consistency to the text by your's truly.

PR:		23745
Submitted by:	Andrew Stevenson <andrew@ugh.net.au>
2001-02-06 09:04:52 +00:00
Bruce Evans
4d5a3a7a50 Removed vestiges of vop_mmap. 2001-02-02 12:51:22 +00:00
Nik Clayton
4444ad36bf Declaring functions inside functions was deprecated twice. Keep the
second recommendation, which includes more rationale, and nix the first.

PR:             docs/24690
Submitted by:   Alex Kapranoff <alex@kapran.bitmcnit.bryansk.su
2001-02-02 03:11:22 +00:00
John Baldwin
efd39a2f76 mtx_try_enter() returns an int, not void. 2001-02-02 00:49:17 +00:00
Ruslan Ermilov
d0353b836e mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00
Ben Smithurst
d13241e146 Document the mpsafe argument to callout_init().
PR:		24529
Submitted by:	harti brandt <brandt@fokus.gmd.de>
Reviewed by:	jlemon
2001-01-31 12:17:45 +00:00
Dag-Erling Smørgrav
f5fccbbcb4 Style police.
Submitted by:	ru
2001-01-29 08:59:30 +00:00
Dag-Erling Smørgrav
ea48868bf6 Add MLINKS for sbuf_clear() and sbuf_overflowed(). 2001-01-28 00:19:10 +00:00
Dag-Erling Smørgrav
e499b74df0 Document the changes in subr_sbuf.c rev. 1.2. 2001-01-28 00:18:54 +00:00
Dag-Erling Smørgrav
0aa028ffe9 Add a man page for the zone allocator. 2001-01-27 19:13:08 +00:00
Ruslan Ermilov
9aa16122c1 mdoc(7) police: fixed some minor formatting/spelling errors. 2001-01-24 09:41:17 +00:00
John Baldwin
ef7b803dcd - Activate runqueue.9, scheduler.9, and sleepqueue.9 along with appropriate
MLINKS.
- Update MLINKS for mi_switch.9.
2001-01-23 19:38:45 +00:00
John Baldwin
8861ba5bc8 Catch up to the new way that the scheduling code works since the original
SMPng commit.  Also document the new cpu_throw function (currently only
on i386).

Reviewed by:	sheldonh
2001-01-23 19:28:14 +00:00
John Baldwin
969843e476 Document the various functions and variables used by the current
scheduler code.  Includes a rough description of the various priority
values stored in struct proc as well as priority propagation.

Reviewed by:	chris
2001-01-23 19:26:21 +00:00
John Baldwin
533ef7852a Document the current organization and helper functions used to implement
the sleep queues used by msleep/wakeup and friends.

Submitted by:	sheldonh
2001-01-23 19:24:35 +00:00
John Baldwin
40abbce7a6 Document the current organization of the run queues and the various
functions used to manage them.

Reviewed by:	sheldonh
2001-01-23 19:23:42 +00:00
Jason Evans
d1c1b8413e Remove MUTEX_DECLARE() and MTX_COLD. Instead, postpone full mutex
initialization until after malloc() is safe to call, then iterate through
all mutexes and complete their initialization.

This change is necessary in order to avoid some circular bootstrapping
dependencies.
2001-01-21 07:52:20 +00:00
Ruslan Ermilov
404d68d48f mdoc(7) police: add missing .Ed call. 2001-01-18 17:23:15 +00:00
Ruslan Ermilov
e207e465df Prepare for mdoc(7)NG. 2001-01-16 09:32:40 +00:00
Ruslan Ermilov
55f4342b4e mdoc(7) police: use .Fa for function arguments, use .Vt for variable type. 2001-01-16 08:53:04 +00:00
Jason Evans
238510fc46 Implement condition variables. 2001-01-16 01:00:43 +00:00
Mark Murray
47608b56e1 Add a missing argument for SYSCTL_ADD_OPAQUE.
Fix the examples at the end which were horribly broken.
2001-01-14 16:43:41 +00:00
Chris Costello
3c5969ca27 The prototype for cpu_switch() was changed in revision 1.111 of
<sys/proc.h>

PR:		24311
Submitted by:	Robert Drehmel <robert@gizmo.quizbot.org>
2001-01-13 19:00:49 +00:00
Ruslan Ermilov
a05c0d110e Oops, the previous did not work with current mdoc(7). 2001-01-12 16:02:58 +00:00
Ruslan Ermilov
b77b3c00be mdoc(7) police: Ft/Vt now accept punctuation-type arguments. 2001-01-12 15:46:56 +00:00
Ruslan Ermilov
3136363f3e Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00
Bosko Milekic
f73f120bec Change M_WAIT to M_TRYWAIT, the new name of the flag. 2000-12-24 03:08:17 +00:00
John Baldwin
aea5b8ffe1 Catch up to the changes to the kthread API. 2000-12-15 20:39:35 +00:00
Ruslan Ermilov
d003b7796c mdoc(7) police: removed duplicate .Os calls. 2000-12-14 12:40:48 +00:00
Ruslan Ermilov
ed40311694 mdoc(7) police: removed history info from the .Os FreeBSD call. 2000-12-14 11:52:05 +00:00
Sheldon Hearn
67e35919d6 Grammar fix. 2000-12-14 09:36:49 +00:00
Ruslan Ermilov
1405da432e mdoc(7) police: add a missing .Os, change the list type to ``tagged''. 2000-12-14 08:55:32 +00:00
John Baldwin
ea84acd6ad Document the MA_RECURSED and MA_NOTRECURSED assertion flags as well as
the MTX_QUIET flag.
2000-12-13 23:30:43 +00:00
Dag-Erling Smørgrav
863edaec4d Add sbuf(9) man page with links to API function names.
Reviewed by:	ru
2000-12-13 19:53:37 +00:00
Ruslan Ermilov
d7b336c076 mdoc(7) police: use canonical form of .Dd macro. 2000-12-11 15:47:53 +00:00
John Baldwin
baeb94c70d Fix some nits in the globs used to describe the various sets of atomic
operations.

Submitted by:	jake, jasone
2000-12-08 22:10:28 +00:00
Daniel C. Sobral
232095104e Add a brief warning about devclass and multiple device driver attachments. 2000-11-23 17:19:54 +00:00
Ruslan Ermilov
b92a189eb9 mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:11:48 +00:00
Ruslan Ermilov
ea3d1f093f mdoc(7) police: add the missing and required .Dd macro call. 2000-11-22 13:31:01 +00:00
Ruslan Ermilov
f4d874a1db mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00
Ruslan Ermilov
ae9fd6288c mdoc(7) police: minor cleanup. 2000-11-22 08:19:15 +00:00
Alfred Perlstein
a0ae47cd48 Install DELAY(9). 2000-11-22 03:44:55 +00:00
Alfred Perlstein
0b0d531efb Document the DELAY() function. 2000-11-22 03:38:32 +00:00
Bosko Milekic
5d4050cc5d Add description of M_WRITABLE macro and new M_RDONLY flag. Try my best to
conform to line break mdoc FreeBSD standards, although I am new to this.

Reviewed by: sheldonh
2000-11-21 22:29:31 +00:00
Mark Murray
a28724c2c2 Add new man page to the mix. 2000-11-21 20:31:51 +00:00