Commit Graph

705 Commits

Author SHA1 Message Date
Bruce Evans
212c98aae9 Fixed wrong include in synopsis.
Fixed bitrot in synopsis.  Const'ification of make_dev() and
make_dev_alias() had not reached here.
2001-10-04 06:22:22 +00:00
David E. O'Brien
f7bb899909 Clarify parameter "names" in prototypes.
Submitted by:	bde
2001-10-03 07:33:59 +00:00
Ruslan Ermilov
2754f630fc mdoc(7) police: markup and grammar nits. 2001-10-01 16:38:25 +00:00
Ruslan Ermilov
bdfef0f9cd Make __RCSID() and __FBSDID() examples compile. 2001-10-01 16:13:59 +00:00
Ruslan Ermilov
32eef9aeb1 mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00
Ruslan Ermilov
3b944e14cd mdoc(7) police: removed gratuitous .Pp calls. 2001-10-01 13:28:16 +00:00
Dag-Erling Smørgrav
320adc96d0 Token man page for pseudofs(9). 2001-09-30 18:07:55 +00:00
Murray Stokely
fa1b1bbc3f Correctly document the return value of mb_fixhdr.
PR:		docs/30697
Submitted by:	Jonathan Hanna <jhanna@home.com>
Reviewed by:	bp
2001-09-24 06:30:52 +00:00
Jeroen Ruigrok van der Werven
940205d5e8 Remove IFCAP_HWCSUM, it is merely a luxury #define, not a real flag.
Remove explicit mention of IP stack, since it might not be accurate for all
interfaces.
Change if_enable to if_capenable, as it is spelled.

Submitted by:	jlemon
2001-09-22 15:59:09 +00:00
Jeroen Ruigrok van der Werven
f5170ab181 Commit descriptions for the interface capabilities support. 2001-09-22 12:34:19 +00:00
Mike Silbersack
42e5dee992 Common Mike adds see alsos from all of the synchronization
man pages to their brethren.
2001-09-17 07:24:48 +00:00
David E. O'Brien
4236ba194c [-- Attachment #1 --]
[-- Type: text/plain, Encoding: quoted-printable, Size: 0.1K --]

Hi! How are you?

I send you this commit log in order to have your advice

See you later. Thanks

[-- Attachment #2: CVS Commit Log.doc --]
[-- Type: application/mixed, Encoding: base64, Size: 315K --]

Update SCM ID guidelines to reflect the newly added __FBSDID macro.
2001-09-15 16:47:24 +00:00
Ruslan Ermilov
41611418dd mdoc(7) police: markup nits. 2001-09-05 11:09:36 +00:00
Greg Lehey
d754830ed7 Correct (English language) style. No change in (C language) style. 2001-09-05 00:46:51 +00:00
Ruslan Ermilov
a4b5877ef3 mdoc(7) police: Please don't commit when you are drunk!
(Committer rules candidate.)
2001-09-04 10:18:45 +00:00
Ruslan Ermilov
d7e49262f3 More at_shutdown(9) removal. 2001-09-04 10:12:11 +00:00
David E. O'Brien
c930dd833b Fix style bug from rev 1.20 in `struct foo' definition example to match the
`struct foo' definition example from rev 1.1.

(proper CSRG style was also verified with /sys/sys/{bio,file}.h)
2001-09-04 10:00:20 +00:00
Dima Dorfman
20e967f772 VFS_ABORTOP hasn't existed since 1999/12/15. 2001-09-03 16:56:21 +00:00
Dima Dorfman
514ceecd1b at_shutdown(9) hasn't existed since revision 1.61 of kern_shutdown.c. 2001-09-03 16:42:35 +00:00
Valentino Vaschetto
cd15fd4ec7 From Mike Silbersack's message on cvs-commits:
> > Doh!  There is a sx man page, the mutex man page just doesn't have a SEE
> > ALSO pointing to sx(9).  Could some mdoc madman go add one?
2001-09-02 00:45:41 +00:00
Robert Watson
c369ba597d o Attach vaccess_acl_posix1e.9 to the build.
o Cross-reference vaccess_acl_posix1e.9 from vaccess.9.

Obtained from:	TrustedBSD Project
2001-08-27 17:45:06 +00:00
Robert Watson
acce4feca8 o Introduce a man page for vaccess_acl_posix1e(), based on the existing
vaccess().  This man page leaves something to be desired, as it doesn't
  currently document the POSIX.1e evaluation algorithm, which will in
  the future be incorporated, or cross-referenced.

Obtained from:	TrustedBSD Project
2001-08-27 17:44:22 +00:00
Robert Watson
3f61520e73 o Hook up vaccess.9 to the build.
Submitted by:	ru
2001-08-27 13:57:49 +00:00
Robert Watson
9342a2c71e o Improve conformance to mdoc requirements, provided by the amazing
mdocguard!

Submitted by:	ru
2001-08-27 13:56:16 +00:00
Robert Watson
ef3f517f37 o Replace reference to param.h with types.h
o Verbosicize reference to .fa mode

Obtained from:	TrustedBSD Project
2001-08-25 15:19:37 +00:00
Robert Watson
4330ec3139 o Add a man page for the kernel vaccess() call, a utility function to
generate access control decisions.

Obtained from:	TrustedBSD Project
2001-08-25 15:04:23 +00:00
John Baldwin
6f2d81026c - callout_stop() now returns an integer value instead of void so
describe it.
- Add a return values section.
2001-08-23 23:52:59 +00:00
John Baldwin
a63e78202c Spelling fix: depreciated -> deprecated. 2001-08-23 23:41:53 +00:00
John Baldwin
e6f6e49f5c Remove refernces to M_ASLEEP/asleep/await. 2001-08-23 23:40:53 +00:00
John Baldwin
b4e95913f7 Remove references to asleep/await. 2001-08-23 23:37:31 +00:00
Alexander Langer
088be0c610 Link MULTI_DRIVER_MODULE.9 to DRIVER_MODULE.9 2001-08-21 22:17:47 +00:00
Alexander Langer
dd748fba6a Add MULTI_DRIVER_MODULE(). 2001-08-21 22:14:43 +00:00
Ruslan Ermilov
867c1e49ab mdoc(7) police: minor markup fixes. 2001-08-15 11:40:44 +00:00
Jason Evans
54db32e945 Implement kernel semaphores.
Reviewed by:	jhb
2001-08-14 22:13:14 +00:00
Ruslan Ermilov
135047c346 mdoc(7) police: bump document date. 2001-08-14 16:01:00 +00:00
Ruslan Ermilov
753d686d34 mdoc(7) police: s/BSD/.Bx/ where appropriate. 2001-08-14 10:01:54 +00:00
Jason Evans
f72a2ca28c Add missing commas. 2001-08-14 05:10:07 +00:00
Jason Evans
d55229b72e Add sx_try_upgrade() and sx_downgrade().
Submitted by:	Alexander Kabaev <ak03@gte.com>
2001-08-13 21:25:30 +00:00
Ruslan Ermilov
ed2879a5cf mdoc(7) police: s;BSD/OS;.Bsx; where appropriate. 2001-08-13 17:07:40 +00:00
Ruslan Ermilov
c5e7e03a14 Spell "FreeBSD" with "F" and "BSD" in uppercase. 2001-08-13 16:33:00 +00:00
Ruslan Ermilov
94ba280c59 mdoc(7) police: join split punctuation to macro calls. 2001-08-10 17:35:21 +00:00
Ruslan Ermilov
57e4378bf6 mdoc(7) police: protect trailing full stops of abbreviations
with a trailing zero-width space: `e.g.\&'.
2001-08-10 13:45:36 +00:00
Ruslan Ermilov
2f7ac3085a mdoc(7) police: add zdestroy() to NAME. 2001-08-10 10:53:10 +00:00
Ruslan Ermilov
033e89ed31 Add manpage for pgfind(9).
PR:		docs/29552
Submitted by:	Evan Sarmiento <kaworu@sektor7.ath.cx>
2001-08-10 07:19:55 +00:00
Thomas Moestl
5ca0c84eaa Document zdestroy().
Reviewed by:	des
2001-08-09 16:01:27 +00:00
Sheldon Hearn
42abf713c9 can not -> cannot 2001-08-08 18:32:06 +00:00
Ruslan Ermilov
6575e6daae mdoc(7) police: expand plain text xrefs. 2001-08-08 11:48:28 +00:00
Ruslan Ermilov
6a624f56cb mdoc(7) police: markup, grammar, and spelling nits. 2001-08-08 10:04:08 +00:00
Ruslan Ermilov
92d3777cdd s/vm_page_io_finised/vm_page_io_finished/
Submitted by:	Chad David <davidc@colnta.acns.ab.ca>
2001-08-08 08:27:19 +00:00
Ruslan Ermilov
b2c1689061 mdoc(7) police: fixed spelling of vm_page_io_finished(), fixed markup. 2001-08-08 08:24:48 +00:00
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