39 Commits

Author SHA1 Message Date
jh
de8a1071d5 Reject spaces and double quotation marks in device names. devctl(4)
and devd(8) can't handle names with such characters properly.

PR:		bin/144736, kern/161912
Discussed with:	imp, kib, pjd
2012-12-22 13:33:28 +00:00
joel
1994f885d3 Remove superfluous paragraph macro. 2012-03-24 13:37:57 +00:00
ae
b550bd1bd7 Formatting fixes:
o Fix date
 o Break sentences
 o Remove trailing whitespaces
 o Sort xrefs by section number

Requested by:	ru
MFC after:	2 weeks
2011-05-05 09:55:55 +00:00
ae
7f98cbc876 Document make_dev_alias_p().
MFC after:	2 weeks
2011-05-03 18:55:16 +00:00
jh
e2b6245a5d Fix typos. 2011-01-22 15:19:25 +00:00
jh
d5b2b0a30f Use .Dv with NULL. 2010-10-24 16:10:32 +00:00
jh
8c0783a03a Document make_dev_p(9).
Reviewed by:	brueffer, kib
2010-10-24 15:56:21 +00:00
jh
d93ad5245d Check the device name validity on device registration.
A new function prep_devname() sanitizes a device name by removing
leading and redundant sequential slashes. The function returns an error
for names which already exist or are considered invalid.

A new flag MAKEDEV_CHECKNAME for make_dev_p(9) and make_dev_credf(9)
indicates that the caller is prepared to handle an error related to the
device name. An invalid name triggers a panic if the flag is not
specified.

Document the MAKEDEV_CHECKNAME flag in the make_dev(9) manual page.

Idea from:	kib
Reviewed by:	kib
2010-10-07 18:00:55 +00:00
kib
f346e51345 Document MAKEDEV_ETERNAL.
MFC after:	3 days
2010-09-05 14:47:46 +00:00
pjd
0586b71665 Correct function name.
MFC after:	3 days
2010-08-01 21:54:25 +00:00
uqs
d88f969fdd mdoc cleanup
Garbage collect unused sections, macros and arguments. Fix prologue and
remove empty lines.

Found by: mdocml
2010-06-02 10:20:23 +00:00
kib
67cbc172f7 Document MAKEDEV_NOWAIT flag for make_dev_credf(9).
Reviewed by:	jh
MFC after:	2 weeks
2010-05-06 19:23:49 +00:00
uqs
3960614646 mdoc: order prologue macros consistently by Dd/Dt/Os
Although groff_mdoc(7) gives another impression, this is the ordering
most widely used and also required by mdocml/mandoc.

Reviewed by:	ru
Approved by:	philip, ed (mentors)
2010-04-14 19:08:06 +00:00
ed
3b64cecd5c Several documentation fixups related to device minor/major numbers:
- Document the minor(3), major(3) and makedev(3) macro's. They also
  apply to umajor() and uminor() in the kernel, but hopefully we'll sort
  that out one day.

- Briefly dev2unit() inside the make_dev(9) manual page, since this is
  now the preferred macro to obtain character device unit numbers inside
  the kernel.

- Remove the device_ids(9) manual page. It contains highly inaccurate
  information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
ed
d421caabf9 Rename the minor' argument of make_dev(9) to unit'.
To prevent any further confusion about device minor and unit numbers,
we'd better just refer to device unit numbers. Many people still think
the numbers we show inside devfs have any relation to the numbers passed
to make_dev(9), which is not the case.

Discussed with:	kib
2008-09-26 14:31:24 +00:00
kib
d397045a7c Document make_dev_credf(9), destroy_dev_sched(9) and destroy_dev_drain(9)
functions.

Reviewed by:	brueffer
2008-09-11 11:38:48 +00:00
brueffer
a9b6a09c31 Bump date for previous commit, also new sentence -> new line. 2007-05-09 05:05:50 +00:00
jmg
fe80882b9b Document the additional fields, si_drv1 and si_drv2 that are available
for the user to use...

MFC after:	1 week
2007-05-06 18:20:16 +00:00
imp
7aa1b5698e Make it clear that the device name may contain '/' characters to place
a device in a subdirectory.  Also explicitly state that the name is
constructed using fmt like printf would print it.

MFC After: 3 days
2006-11-24 13:10:30 +00:00
jmg
87a18c121f match w/ prototype...
MFC after:	3 days
2006-05-08 04:25:35 +00:00
imp
a63b8f739d Bump date to Sept 20, the date of the last content change 2006-01-18 05:48:45 +00:00
imp
e808439374 Sprinkle a few stars where they belong. 2005-09-20 02:38:43 +00:00
brueffer
9ace7d5e0b Bump .Dd for the previous commit. 2005-03-28 10:28:57 +00:00
brueffer
4a77c83cbd The make_dev(9) functions no longer handle dev_ts, but struct cdevs.
PR:		78172
Submitted by:	"Wojciech A. Koszek" <dunstan@freebsd.czest.pl>
MFC after:	3 days
2005-03-28 08:57:07 +00:00
hmp
9aa04eacb5 Mdoc Janitor:
* Fix hard sentence breaks.

  * NOTE: devstat(9) requires more mdoc(7) work.
2003-10-23 01:54:06 +00:00
ru
1c23ef339b mdoc(7): Use the new feature of the .In macro. 2003-09-08 19:57:22 +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
dd
b7924cd5f6 The routine is dev_depends(); consistently spell it that way.
PR:		34047
Submitted by:	Maxime Henrion <mux@sneakerz.org>
Pointy hat to:	dd
2002-02-11 01:21:29 +00:00
mpp
52a504f88d ispell sweep of share/man/man9/*. 2002-01-09 11:43:48 +00:00
bde
e344ce4b2a 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
ru
623da62a5a mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00
schweikh
511e378b14 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
ru
40f8484e05 mdoc(7) police: cosmetics. 2001-07-04 15:32:44 +00:00
dd
4f8e07138f Document depends_dev.
Reviewed by:	phk
2001-05-29 04:14:33 +00:00
ru
2d1b95a96f mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00
ru
2833cfc211 mdoc(7) police:
removed hard sentence breaks, use Ft for function return type.
2001-03-12 10:15:03 +00:00
mjacob
49ab6df486 Document the make_dev_alias function. 2001-03-11 20:10:45 +00:00
bde
5eb92e1444 "Fixed" assorted bitrot. remove_dev() was renamed to destroy_dev().
VOP_ABORTOP() went away.  at_shutdown() was replaced by undocumented
event handling.  Rename remove_dev() here too, and remove the dead
and dead wrong man pages.
1999-12-23 17:16:32 +00:00
chris
6dfa6014e0 Document the make_dev(9) and remove_dev(9) facilities.
remove_dev(9) is created as a link to the existing make_dev(9) page.

Reviewed by:	phk
1999-09-25 20:12:01 +00:00