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)
This commit is contained in:
Hiten Pandya 2003-05-31 14:07:25 +00:00
parent acb9e0f3f6
commit 0640e9e01b
46 changed files with 167 additions and 167 deletions

View File

@ -41,13 +41,13 @@ to a client.
.Pp
Its arguments are:
.Bl -tag -width credanonp
.It Ar mp
.It Fa mp
The mount point to be checked.
.It Ar nam
.It Fa nam
An mbuf containing the network address of the client.
.It Ar exflagsp
.It Fa exflagsp
Return parameter for the export flags for this client.
.It Ar credanonp
.It Fa credanonp
Return parameter for the anonymous credentials for this client.
.El
.Pp
@ -62,7 +62,7 @@ to validate that a client has access to the file system.
The file system should call
.Xr vfs_export_lookup 9
with the address of an appropriate
.Dv netexport
.Vt netexport
structure and the address of the client,
.Fa nam ,
to verify that the client can access this file system.

View File

@ -45,11 +45,11 @@ This is used by the NFS server to turn an NFS filehandle into a vnode.
.Pp
Its arguments are:
.Bl -tag -width vpp
.It Ar mp
.It Fa mp
The file system.
.It Ar fhp
.It Fa fhp
The filehandle to convert.
.It Ar vpp
.It Fa vpp
Return parameter for the new locked vnode.
.El
.Pp

View File

@ -45,18 +45,18 @@ Mount a file system into the system's namespace.
.Pp
Its arguments are:
.Bl -tag -width data
.It Ar mp
.It Fa mp
Structure representing the file system.
.It Ar path
.It Fa path
Pathname where the file system is being mounted.
.It Ar data
.It Fa data
File system specific data. This should be read into the kernel using
.Xr copyin 9 .
.It Ar ndp
.It Fa ndp
Contains the result of a
.Xr namei 9
call on the pathname of the mountpoint.
.It Ar td
.It Fa td
Thread which is mounting the file system.
.El
.Pp

View File

@ -45,9 +45,9 @@ Return a locked vnode for the root directory of the file system.
.Pp
Its arguments are:
.Bl -tag -width vpp
.It Ar mp
.It Fa mp
The file system.
.It Ar vpp
.It Fa vpp
Return parameter for the root vnode.
.El
.Sh SEE ALSO

View File

@ -46,11 +46,11 @@ This is called after
and before the first access to the file system.
Its arguments are:
.Bl -tag -width flags
.It Ar mp
.It Fa mp
The file system.
.It Ar flags
.It Fa flags
??
.It Ar td
.It Fa td
Thread which is starting the file system.
.El
.Sh SEE ALSO

View File

@ -46,11 +46,11 @@ including recommended I/O sizes, free space, free inodes, etc.
.Pp
Its arguments are:
.Bl -tag -width sbp
.It Ar mp
.It Fa mp
The file system.
.It Ar sbp
.It Fa sbp
Return parameter for the file system's status.
.It Ar td
.It Fa td
The thread which is querying the file system.
.El
.Sh SEE ALSO

View File

@ -45,9 +45,9 @@ This writes out all unwritten data in a file system.
.Pp
Its arguments are:
.Bl -tag -width waitfor
.It Ar mp
.It Fa mp
The file system.
.It Ar waitfor
.It Fa waitfor
Whether the function should wait for I/O to complete.
Possible values are:
.Bl -tag -width MNT_NOWAIT
@ -58,9 +58,9 @@ start all I/O, but do not wait for it
.It Dv MNT_LAZY
push data not written by file system syncer
.El
.It Ar cred
.It Fa cred
The caller's credentials.
.It Ar td
.It Fa td
The calling thread.
.El
.Pp

View File

@ -45,11 +45,11 @@ Unmount a file system.
.Pp
Its arguments are:
.Bl -tag -width mntflags
.It Ar mp
.It Fa mp
The file system.
.It Ar mntflags
.It Fa mntflags
Various flags.
.It Ar td
.It Fa td
Thread which is unmounting the file system.
.El
.Pp

View File

@ -44,14 +44,14 @@
This converts an inode number into a locked vnode.
.Pp
Its arguments are:
.Bl -tag -width ".Ar flags"
.It Ar mp
.Bl -tag -width flags
.It Fa mp
The file system.
.It Ar ino
.It Fa ino
The inode representing the file.
.It Ar flags
.It Fa flags
Additional locking flags to pass through.
.It Ar vpp
.It Fa vpp
Return parameter for the vnode.
.El
.Pp

View File

@ -47,9 +47,9 @@ to access the file in the future.
.Pp
Its arguments are:
.Bl -tag -width fhp
.It Ar vp
.It Fa vp
The vnode to make a filehandle for.
.It Ar fhp
.It Fa fhp
Return parameter for the filehandle.
.El
.Sh SEE ALSO

View File

@ -46,13 +46,13 @@ given credentials.
.Pp
Its arguments are:
.Bl -tag -width mode
.It Ar vp
.It Fa vp
the vnode of the file to check
.It Ar mode
.It Fa mode
the type of access required
.It Ar cred
.It Fa cred
the user credentials to check
.It Ar td
.It Fa td
the thread which is checking
.El
.Pp

View File

@ -43,15 +43,15 @@ control list (ACL) for a particular file or directory.
.Pp
Its arguments are:
.Bl -tag -width type
.It Ar vp
.It Fa vp
the vnode of the file or directory
.It Ar type
.It Fa type
the type of ACL to check
.It Ar aclp
.It Fa aclp
a pointer to an ACL structure from which to retrieve the ACL data
.It Ar cred
.It Fa cred
the user credentials to use in authorizing the request
.It Ar td
.It Fa td
the thread checking the ACL
.El
.Pp

View File

@ -44,16 +44,16 @@
.Sh DESCRIPTION
The arguments are:
.Bl -tag -width flags
.It Ar vp
.It Fa vp
the vnode being manipulated
.It Ar id
.It Fa id
the id token which is changing the lock
.It Ar op
.It Fa op
the operation to perform (see
.Xr fcntl 2 )
.It Ar fl
.It Fa fl
description of the lock
.It Ar flags
.It Fa flags
One of more of the following:
.Bl -column F_UNLCK -offset indent
.It Dv F_RDLCK Ta "shared or read lock"

View File

@ -42,9 +42,9 @@
.Sh DESCRIPTION
The arguments are:
.Bl -tag -width 2n
.It Ar vp
.It Fa vp
the vnode of the file being written to
.It Ar bp
.It Fa bp
the buffer to be written
.El
.Sh RETURN VALUES

View File

@ -55,15 +55,15 @@ in a given directory.
.Pp
The arguments are:
.Bl -tag -width target
.It Ar dvp
.It Fa dvp
the locked vnode of the directory
.It Ar vpp
.It Fa vpp
the address of a variable where the resulting locked vnode should be stored
.It Ar cnp
.It Fa cnp
the pathname component created
.It Ar vap
.It Fa vap
the attributes that the new object should be created with
.It Ar target
.It Fa target
the pathname of the target of the symlink
.El
.Pp

View File

@ -49,11 +49,11 @@ system calls.
.Pp
Its arguments are:
.Bl -tag -width waitfor
.It Ar vp
.It Fa vp
the vnode of the file
.It Ar cred
.It Fa cred
the caller's credentials
.It Ar waitfor
.It Fa waitfor
whether the function should wait for I/O to complete.
Possible values are:
.Bl -tag -width MNT_NOWAIT
@ -64,7 +64,7 @@ start all I/O, but do not wait for it
.It Dv MNT_LAZY
push data not written by file system syncer
.El
.It Ar td
.It Fa td
the calling thread
.El
.Pp

View File

@ -53,7 +53,7 @@ Its arguments are:
.Bl -tag -width ".Fa attrnamespace"
.It Fa vp
the vnode of the file or directory
.It Ar attrnamespace
.It Fa attrnamespace
integer constant indicating which extended attribute namespace the attribute
name is present in
.It Fa name

View File

@ -46,19 +46,19 @@
.Sh DESCRIPTION
The arguments are:
.Bl -tag -width reqpage
.It Ar vp
.It Fa vp
The file to access.
.It Ar m
.It Fa m
A page ???
.It Ar count
.It Fa count
How many pages to access.
.It Ar sync
.It Fa sync
Nonzero if the write should be synchronous.
.It Ar rtvals
.It Fa rtvals
???
.It Ar reqpage
.It Fa reqpage
???
.It Ar offset
.It Fa offset
Offset in the file to start accessing.
.El
.Pp

View File

@ -45,7 +45,7 @@
.Sh DESCRIPTION
The arguments are:
.Bl -tag -width 2n
.It Ar vp
.It Fa vp
the vnode being reclaimed
.El
.Pp

View File

@ -44,17 +44,17 @@ Manipulate a file in device dependent ways.
.Pp
Its arguments are:
.Bl -tag -width command
.It Ar vp
.It Fa vp
the vnode of the file (normally representing a device)
.It Ar command
.It Fa command
the device specific operation to perform
.It Ar cnp
.It Fa cnp
extra data for the specified operation
.It Ar fflag
.It Fa fflag
some flags ???
.It Ar cred
.It Fa cred
the caller's credentials
.It Ar td
.It Fa td
the calling thread
.El
.Pp

View File

@ -44,11 +44,11 @@ This links a new name in the specified directory to an existing file.
.Pp
Its arguments are:
.Bl -tag -width 8n
.It Ar dvp
.It Fa dvp
the vnode of the directory
.It Ar vp
.It Fa vp
the vnode of the file to be linked
.It Ar cnp
.It Fa cnp
pathname information about the file
.El
.Pp

View File

@ -56,9 +56,9 @@ same time.
.Pp
The arguments are:
.Bl -tag -width flags
.It Ar vp
.It Fa vp
the vnode being locked or unlocked
.It Ar flags
.It Fa flags
One of the lock request types:
.Bl -column LK_EXCLUPGRADE -offset indent
.It Dv LK_SHARED Ta "Shared lock"
@ -90,7 +90,7 @@ with these control flags:
.It Dv LK_RETRY Ta "Retry until locked"
.It Dv LK_NOOBJ Ta "Don't create object"
.El
.It Ar td
.It Fa td
thread context to use for the locks
.El
.Pp

View File

@ -45,11 +45,11 @@ This entry point looks up a single pathname component in a given directory.
.Pp
Its arguments are:
.Bl -tag -width vpp
.It Ar dvp
.It Fa dvp
the locked vnode of the directory to search
.It Ar vpp
.It Fa vpp
the address of a variable where the resulting locked vnode should be stored
.It Ar cnp
.It Fa cnp
the pathname component to be searched for
.El
.Pp

View File

@ -51,11 +51,11 @@ entry point is called after a file is finished with by the process.
.Pp
The arguments are:
.Bl -tag -width mode
.It Ar vp
.It Fa vp
the vnode of the file
.It Ar mode
.It Fa mode
the access mode required by the calling process
.It Ar td
.It Fa td
the thread which is accessing the file
.El
.Pp

View File

@ -43,11 +43,11 @@
.Sh DESCRIPTION
The arguments are:
.Bl -tag -width retval
.It Ar vp
.It Fa vp
the vnode to get information about
.It Ar name
.It Fa name
the type of information to return
.It Ar retval
.It Fa retval
the place to return the information
.El
.Pp

View File

@ -42,7 +42,7 @@
.Sh DESCRIPTION
The arguments are:
.Bl -tag -width 2n
.It Ar vp
.It Fa vp
the vnode to print
.El
.Sh RETURN VALUES

View File

@ -48,13 +48,13 @@ These entry points read or write the contents of a file
.Pp
The arguments are:
.Bl -tag -width ioflag
.It Ar vp
.It Fa vp
the vnode of the file
.It Ar uio
.It Fa uio
the location of the data to be read or written
.It Ar ioflag
.It Fa ioflag
various flags
.It Ar cnp
.It Fa cnp
the credentials of the caller
.El
.Pp

View File

@ -43,21 +43,21 @@
.Sh DESCRIPTION
Read directory entries.
.Bl -tag -width ncookies
.It Ar vp
.It Fa vp
the vnode of the directory
.It Ar uio
.It Fa uio
where to read the directory contents
.It Ar cred
.It Fa cred
the caller's credentials
.It Ar eofflag
.It Fa eofflag
return end of file status (NULL if not wanted)
.It Ar ncookies
.It Fa ncookies
number of directory cookies generated for NFS (NULL if not wanted)
.It Ar cookies
.It Fa cookies
directory seek cookies generated for NFS (NULL if not wanted)
.El
The directory contents are read into
.Dv struct dirent
.Vt struct dirent
structures. If the on-disc data structures differ from this then they
should be translated.
.Sh LOCKS

View File

@ -43,11 +43,11 @@
.Sh DESCRIPTION
This reads the target pathname of a symbolic link
.Bl -tag -width uio
.It Ar vp
.It Fa vp
the vnode of the symlink
.It Ar uio
.It Fa uio
the location of the data to be read or written
.It Ar cred
.It Fa cred
the credentials of the caller
.El
.Sh LOCKS

View File

@ -42,9 +42,9 @@
.Sh DESCRIPTION
The arguments are:
.Bl -tag -width buflist
.It Ar vp
.It Fa vp
the file to manipulate
.It Ar buflist
.It Fa buflist
a list of buffers to rearrange
.El
.Pp

View File

@ -47,11 +47,11 @@ These entry points remove files and directories respectively.
.Pp
The arguments are:
.Bl -tag -width dvp
.It Ar dvp
.It Fa dvp
the vnode of the directory
.It Ar vp
.It Fa vp
the vnode of the file to be removed
.It Ar cnp
.It Fa cnp
pathname information about the file
.El
.Sh LOCKS

View File

@ -45,17 +45,17 @@ If the destination object exists, it will be removed first.
.Pp
Its arguments are:
.Bl -tag -width fdvp
.It Ar fdvp
.It Fa fdvp
the vnode of the old parent directory
.It Ar fvp
.It Fa fvp
the vnode of the file to be renamed
.It Ar fcnp
.It Fa fcnp
pathname information about the file's current name
.It Ar tdvp
.It Fa tdvp
the vnode of the new parent directory
.It Ar tvp
.It Fa tvp
the vnode of the target file (if it exists)
.It Ar tcnp
.It Fa tcnp
pathname information about the file's new name
.El
.Sh LOCKS

View File

@ -42,9 +42,9 @@
.Sh DESCRIPTION
The arguments are:
.Bl -tag -width 2n
.It Ar vp
.It Fa vp
the vnode that the buffer is for
.It Ar bp
.It Fa bp
the buffer to be read or written
.El
.Pp

View File

@ -47,9 +47,9 @@ to access the file in the future.
.Pp
Its arguments are:
.Bl -tag -width fhp
.It Ar vp
.It Fa vp
The vnode to make a filehandle for.
.It Ar fhp
.It Fa fhp
Return parameter for the filehandle.
.El
.Sh SEE ALSO

View File

@ -67,7 +67,7 @@ They can be used to implement reference counts or as building blocks for more
advanced synchronization primitives such as mutexes.
.Ss Types
Each atomic operation operates on a specific
.Ar type .
.Fa type .
The type to use is indicated in the function name.
The available types that can be used are:
.Pp
@ -125,7 +125,7 @@ pseudo-lock requiring further operations to wait until it has completed.
To denote this, the suffix
.Dq Li _acq
is inserted into the function name immediately prior to the
.Dq Li _ Ns Aq Ar type
.Dq Li _ Ns Aq Fa type
suffix.
For example, to subtract two integers ensuring that any later writes will
happen after the subtraction is performed, use
@ -139,7 +139,7 @@ any pending data accesses to be completed before its operation is performed.
To denote this, the suffix
.Dq Li _rel
is inserted into the function name immediately prior to the
.Dq Li _ Ns Aq Ar type
.Dq Li _ Ns Aq Fa type
suffix.
For example, to add two long integers ensuring that all previous
writes will happen first, use

View File

@ -38,18 +38,18 @@
.Vt typedef struct devclass *devclass_t ;
.Sh DESCRIPTION
The
.Dv devclass
.Nm
object has two main functions in the system. The first is to manage
the allocation of unit numbers for device instances and the second is
to hold the list of device drivers for a particular bus type.
Each
.Dv devclass
.Nm
has a name and there cannot be two devclasses with the same name.
This ensures that unique unit numbers are allocated to device
instances.
.Pp
Beware that this means
.Dv devclass
.Nm
must be the same for different bus attachments of the same device driver.
.Sh SEE ALSO
.Xr devclass_add_driver 9 ,

View File

@ -41,11 +41,11 @@
.Fn devclass_find "const char *classname"
.Sh DESCRIPTION
Search for the
.Dv devclass
.Nm
with the specified name.
.Sh RETURN VALUES
If the
.Dv devclass
.Nm
exists, it is returned, otherwise
.Dv NULL
is returned.

View File

@ -41,16 +41,16 @@ The device object represents a piece of hardware attached to the
system such as an expansion card, the bus which that card is plugged
into, disk drives attached to the expansion card etc.
The system defines one device,
.Dv root_bus
.Va root_bus
and all other devices are created dynamically during
autoconfiguration. Normally devices representing top-level busses in
the system (ISA, PCI etc.) will be attached directly to
.Dv root_bus
.Va root_bus
and other devices will be added as children of their relevant bus.
.Pp
The devices in a system form a tree.
All devices except
.Dv root_bus
.Va root_bus
have a parent (see
.Xr device_get_parent 9 ) .
In addition, any device can have children attached to it (see
@ -83,13 +83,13 @@ and a set of driver-specific variables (see
.Pp
Devices can be in one of several states:
.Bl -tag -width DS_NOTPRESENT
.It Ar DS_NOTPRESENT
.It Dv DS_NOTPRESENT
the device has not been probed for existence or the probe failed
.It Ar DS_ALIVE
.It Dv DS_ALIVE
the device probe succeeded but not yet attached
.It Ar DS_ATTACHED
.It Dv DS_ATTACHED
the device has been successfully attached
.It Ar DS_BUSY
.It Dv DS_BUSY
the device is currently open
.El
.Pp

View File

@ -114,11 +114,11 @@ then
.Fn kobj_class_compile_static
should be called with the class and a pointer to a statically
allocated
.Dv kobj_ops
.Vt kobj_ops
structure before the class is used to initialise any objects.
.Pp
To define a class, first define a simple array of
.Dv kobj_method_t .
.Vt kobj_method_t .
Each method which the class implements should be entered into the
table using the macro
.Fn KOBJMETHOD
@ -128,7 +128,7 @@ The table should be terminated with two zeros.
The macro
.Fn DEFINE_CLASS
can then be used to initialise a
.Dv kobj_class_t
.Vt kobj_class_t
structure.
The size argument to
.Fn DEFINE_CLASS

View File

@ -62,7 +62,7 @@ or
.Xr gdb 1 .
.Pp
Events are created and logged in the kernel via the
.Dv CTR Ns Ar x
.Dv CTR Ns x
macros.
The first parameter is a mask of event types
.Pq Dv KTR_*

View File

@ -85,7 +85,7 @@ address in question and modify the route appropriately.
The default interface is
.Fn rtalloc .
Its only argument is
.Ar ro ,
.Fa ro ,
a pointer to a
.Dq Li "struct route" ,
which is defined as follows:
@ -104,7 +104,7 @@ for the first time, callers should ensure that unused bits of the
structure are set to zero. On subsequent calls,
.Fn rtalloc
returns without performing a lookup if
.Ar ro->ro_rt
.Va ro->ro_rt
is non-null and the
.Dv RTF_UP
flag is set in the route's
@ -120,11 +120,11 @@ in the presence of the
and
.Dv RTF_PRCLONING
flags are undesired. The
.Ar ro
.Fa ro
argument is the same as
.Fn rtalloc ,
but there is additionally a
.Ar flags
.Fa flags
argument, which lists the flags in the route which are to be
.Em ignored
(ordinarily, one or both of
@ -145,9 +145,9 @@ space than is in a traditional
Instead, it takes a
.Dq Li "struct sockaddr *"
directly as the
.Ar sa
.Fa sa
argument. The second argument,
.Ar report ,
.Fa report ,
controls whether
.Dv RTM_RESOLVE
requests are sent to the lower layers when an
@ -158,7 +158,7 @@ route is cloned. Ordinarily a value of one should be passed, except
in the processing of those lower layers which use the cloning
facility.
The third argument,
.Ar flags ,
.Fa flags ,
is a set of flags to ignore, as in
.Fn rtalloc_ign .
.Sh RETURN VALUES
@ -185,7 +185,7 @@ facility first appeared in
although with much different internals. The
.Fn rtalloc_ign
function and the
.Ar flags
.Fa flags
argument to
.Fn rtalloc1
first appeared in
@ -198,6 +198,6 @@ as were the changes to implement
and the
.Fn rtalloc_ign
function and the
.Ar flags
.Fa flags
argument to
.Fn rtalloc1 .

View File

@ -56,17 +56,17 @@ If a process must wait for an
external event, it is put on sleep by
.Fn tsleep .
The parameter
.Ar ident
.Fa ident
is an arbitrary address that uniquely identifies the event on which
the process is being asleep. All processes sleeping on a single
.Ar ident
.Fa ident
are woken up later by
.Fn wakeup ,
often called from inside an interrupt routine, to indicate that the
resource the process was blocking on is available now.
.Pp
The parameter
.Ar wmesg
.Fa wmesg
is a string describing the sleep condition for tools like
.Xr ps 1 .
Due to the limited space of those programs to display arbitrary strings,
@ -89,12 +89,12 @@ Suspends the current process until a wakeup is
performed on the specified identifier.
The process will then be made
runnable with the specified
.Ar priority .
.Fa priority .
Sleeps at most
.Ar timo
.Fa timo
\&/ hz seconds (0 means no timeout).
If
.Ar pri
.Fa pri
includes the
.Dv PCATCH
flag, signals are checked before and after sleeping, else signals are
@ -116,16 +116,16 @@ The
.Fn msleep
function is a variation on tsleep.
The parameter
.Ar mtx
.Fa mtx
is a mutex which will be released before sleeping and reacquired before
.Fn msleep
returns.
If
.Ar pri
.Fa pri
includes the
.Dv PDROP
flag, the
.Ar mtx
.Fa mtx
parameter will not be reacquired before returning.
The mutex is
used to ensure that a condition can be checked atomically, and
@ -152,7 +152,7 @@ The
.Fn sleep
function used to be the traditional form.
It did not let you specify a timeout or a
.Ar wmesg ,
.Fa wmesg ,
hence it was discontinued.
.Sh AUTHORS
.An -nosplit

View File

@ -42,9 +42,9 @@
.Sh DESCRIPTION
Get a vnode from the free list and increment its reference count.
.Bl -tag -width lockflag
.It Ar vp
.It Fa vp
the vnode to remove from the free list
.It Ar lockflag
.It Fa lockflag
if non-zero, the vnode will also be locked
.El
.Pp

View File

@ -41,10 +41,10 @@
.Fn vput "struct vnode *vp"
.Sh DESCRIPTION
Decrement the
.Dv v_usecount
.Va v_usecount
field of a vnode and unlock the vnode.
.Bl -tag -width 2n
.It Ar vp
.It Fa vp
the vnode to decrement
.El
.Pp

View File

@ -41,10 +41,10 @@
.Fn vref "struct vnode *vp"
.Sh DESCRIPTION
Increment the
.Dv v_usecount
.Va v_usecount
field of a vnode.
.Bl -tag -width 2n
.It Ar vp
.It Fa vp
the vnode to increment
.El
.Pp

View File

@ -41,10 +41,10 @@
.Fn vrele "struct vnode *vp"
.Sh DESCRIPTION
Decrement the
.Dv v_usecount
.Va v_usecount
field of a vnode.
.Bl -tag -width 2n
.It Ar vp
.It Fa vp
the vnode to decrement
.El
.Pp
@ -52,7 +52,7 @@ Any code in the system which is using a vnode should call
.Fn vrele
when it is finished with the vnode.
If the
.Dv v_usecount
.Va v_usecount
field of the vnode reaches zero, then it will be placed on the free list.
.Sh SEE ALSO
.Xr vget 9 ,