d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mdoc Janitor:

Browse Source 
* Fix hard sentence breaks in VFS_*(9) and VOP_*(9) manual pages.
This commit is contained in:
Hiten Pandya 2003-10-23 02:11:14 +00:00
parent 61ba65809d
commit c1c03d4944
19 changed files with 63 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
share/man/man9/VFS_FHTOVP.9
View File

@ -54,10 +54,12 @@ Return parameter for the new locked vnode.
.El
.Pp
The contents of the filehandle are defined by the file system and are
not examined by any other part of the system. It should contain
not examined by any other part of the system.
It should contain
enough information to uniquely identify a file within the file system
as well as noticing when a file has been removed and the file system
resources have been reused for a new file. For instance, UFS
resources have been reused for a new file.
For instance, UFS
file system stores the inode number and inode generation counter in its
filehandle.
.Pp

3
share/man/man9/VFS_INIT.9
View File

@ -42,7 +42,8 @@
.Fn VFS_INIT
.Sh DESCRIPTION
This function is called once to allow a file system to initialize any
global data structures that it might have. It is either called when
global data structures that it might have.
It is either called when
the operating system boots or, for dynamically loaded file systems,
when the kernel module containing the file system is loaded.
.Sh SEE ALSO

10
share/man/man9/VFS_MOUNT.9
View File

@ -50,7 +50,8 @@ Structure representing the file system.
.It Fa path
Pathname where the file system is being mounted.
.It Fa data
File system specific data. This should be read into the kernel using
File system specific data.
This should be read into the kernel using
.Xr copyin 9 .
.It Fa ndp
Contains the result of a
@ -61,7 +62,8 @@ Thread which is mounting the file system.
.El
.Pp
This is called both to mount new file systems and to change the
attributes of an existing file system. If the
attributes of an existing file system.
If the
.Dv MNT_UPDATE
flag is set in
.Fa mp->mnt_flag
@ -75,8 +77,8 @@ to update the NFS export information for the file system.
.Pp
If the
.Dv MNT_UPDATE
flag is not specified, then this is a newly mounted file system. The
file system code should allocate and initialize
flag is not specified, then this is a newly mounted file system.
The file system code should allocate and initialize
any private data needed to represent
the file system (it can use the
.Fa mp->mnt_data

3
share/man/man9/VFS_QUOTACTL.9
View File

@ -41,7 +41,8 @@
.Ft int
.Fn VFS_QUOTACTL "struct mount *mp" "int cmds" "uid_t uid" "caddr_t arg" "struct thread *td"
.Sh DESCRIPTION
Implement file system quotas. See
Implement file system quotas.
See
.Xr quotactl 2
for a description of the arguments.
.Sh SEE ALSO

3
share/man/man9/VFS_VGET.9
View File

@ -56,7 +56,8 @@ Return parameter for the vnode.
.El
.Pp
This is an optional file system entry-point for file systems which have a
unique id number for every file in the file system. It is used
unique id number for every file in the file system.
It is used
internally by the UFS file system and also by the NFSv3 server to
implement the
.Dv READDIRPLUS

9
share/man/man9/VOP_ACLCHECK.9
View File

@ -58,12 +58,14 @@ the thread checking the ACL
The
.Fa cred
pointer may be NULL to indicate that access control checks are not to be
performed, if possible. This cred setting might be used to allow the
performed, if possible.
This cred setting might be used to allow the
kernel to authorize ACL verification that the active process might not be
permitted to do.
.Pp
The vnode ACL interface defines the syntax, and not semantics, of file and
directory ACL interfaces. More information about ACL management in kernel
directory ACL interfaces.
More information about ACL management in kernel
may be found in
.Xr acl 9 .
.Sh LOCKS
@ -76,7 +78,8 @@ pointer points to a valid ACL of type
.Fa type
for the object
.Fa vp ,
then zero is returned. Otherwise, an appropriate error code is returned.
then zero is returned.
Otherwise, an appropriate error code is returned.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EINVAL

4
share/man/man9/VOP_ADVLOCK.9
View File

@ -67,8 +67,8 @@ semantics for lock
.El
.El
.Pp
This entry point manipulates advisory record locks on the file. Most
file systems delegate the work for this call to
This entry point manipulates advisory record locks on the file.
Most file systems delegate the work for this call to
.Fn lf_advlock .
.Sh RETURN VALUES
Zero is returned on success, otherwise an error is returned.

3
share/man/man9/VOP_CREATE.9
View File

@ -93,7 +93,8 @@ If the call is successful, the new object will be returned locked.
.Sh RETURN VALUES
If successful, the vnode for the new object is placed in
.Fa *vpp
and zero is returned. Otherwise, an appropriate error is returned.
and zero is returned.
Otherwise, an appropriate error is returned.
.Sh PSEUDOCODE
.Bd -literal
int

8
share/man/man9/VOP_GETACL.9
View File

@ -64,16 +64,16 @@ This cred setting might be used to allow the kernel to authorize ACL
retrieval that the active process might not be permitted to do.
.Pp
The vnode ACL interface defines the syntax, and not semantics, of file and
directory ACL interfaces. More information about ACL management in kernel
may be found in
directory ACL interfaces.
More information about ACL management in kernel may be found in
.Xr acl 9 .
.Sh LOCKS
The vnode will be locked on entry and should remain locked on return.
.Sh RETURN VALUES
If the
.Fa aclp
pointer will point to a valid ACL, then zero is returned. Otherwise,
an appropriate error code is returned.
pointer will point to a valid ACL, then zero is returned.
Otherwise, an appropriate error code is returned.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EINVAL

3
share/man/man9/VOP_GETEXTATTR.9
View File

@ -95,7 +95,8 @@ More information on extended attributes may be found in
The vnode will be locked on entry and should remain locked on return.
.Sh RETURN VALUES
On success, zero will be returned, and the uio structure will be updated to
reflect data read. Otherwise, an appropriate error code is returned.
reflect data read.
Otherwise, an appropriate error code is returned.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er ENOATTR

4
share/man/man9/VOP_GETPAGES.9
View File

@ -59,8 +59,8 @@ method does the converse; that is to say, it writes out adjacent dirty
pages of virtual memory.
.Pp
On entry, the vnode lock is held but neither the page queue nor VM object
locks are held. Both methods return in the same state on both success and
error returns.
locks are held.
Both methods return in the same state on both success and error returns.
.Pp
The arguments are:
.Bl -tag -width reqpage

6
share/man/man9/VOP_INACTIVE.9
View File

@ -50,7 +50,8 @@ the vnode being reclaimed
.El
.Pp
.Fn VOP_INACTIVE
is called when the kernel is no longer using the vnode. This may be
is called when the kernel is no longer using the vnode.
This may be
because the reference count reaches zero or it may be that the
file system is being forcibly unmounted while there are open files.
It can be used to reclaim space for 'open but deleted' files.
@ -59,7 +60,8 @@ is called when a vnode is being reused for a different file system.
Any file system specific resources associated with the vnode should be
freed.
.Sh LOCKS
For VOP_INACTIVE, the vp will be locked on entry. Your VOP_INACTIVE code
For VOP_INACTIVE, the vp will be locked on entry.
Your VOP_INACTIVE code
must unlock the vp prior to returning.
.Pp
For VOP_RECLAIM, the vp will not be locked on entry and should be left

10
share/man/man9/VOP_LEASE.9
View File

@ -40,15 +40,17 @@
.Ft int
.Fn VOP_LEASE "struct vnode *vp" "struct thread *td" "struct ucred *cred" "int type"
.Sh DESCRIPTION
This entry point is currently not implemented. I believe the idea is to
This entry point is currently not implemented.
I believe the idea is to
validate a vnode for a particular set of user credentials and operation type.
The two operation types supported are LEASE_READ and LEASE_WRITE. The
function currently always returns 0.
The two operation types supported are LEASE_READ and LEASE_WRITE.
The function currently always returns 0.
.Sh LOCKS
The vnode must be exclusively locked on entry, and should remain exclusively
locked on return.
.Sh RETURN VALUES
If successful, zero is returned. Otherwise, well... zero is returned too.
If successful, zero is returned.
Otherwise, well... zero is returned too.
.Sh ERRORS
.Sh SEE ALSO
.Xr VOP_READ 9 ,

3
share/man/man9/VOP_LISTEXTATTR.9
View File

@ -97,7 +97,8 @@ More information on extended attributes may be found in
The vnode will be locked on entry and should remain locked on return.
.Sh RETURN VALUES
On success, zero will be returned, and the uio structure will be updated to
reflect the list read. Otherwise, an appropriate error code is returned.
reflect the list read.
Otherwise, an appropriate error code is returned.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EACCES

5
share/man/man9/VOP_OPENCLOSE.9
View File

@ -72,8 +72,9 @@ to be locked on entry and will leave it locked on return.
.Pp
.Fn VOP_CLOSE
expects at least a reference to be associated with the vnode and does not
care whether the vnode is locked or not. The lock and reference state is
left unchanged on return. Note that
care whether the vnode is locked or not.
The lock and reference state is left unchanged on return.
Note that
.Fa vn_close
expects an unlocked, referenced vnode and will dereference the vnode prior
to returning.

3
share/man/man9/VOP_RDWR.9
View File

@ -63,7 +63,8 @@ The
argument is used to give directives and hints to the file system.
When attempting a read, the high 16 bits are used to provide a
read-ahead hint (in units of file system blocks) that the file system
should attempt. The low 16 bits are a bit mask which can contain
should attempt.
The low 16 bits are a bit mask which can contain
the following flags:
.Bl -tag -width IO_NODELOCKED
.It Dv IO_UNIT

6
share/man/man9/VOP_READDIR.9
View File

@ -58,7 +58,8 @@ directory seek cookies generated for NFS (NULL if not wanted)
.El
The directory contents are read into
.Vt struct dirent
structures. If the on-disc data structures differ from this then they
structures.
If the on-disc data structures differ from this then they
should be translated.
.Sh LOCKS
The directory should be locked on entry and will still be locked on exit.
@ -77,7 +78,8 @@ should be set to TRUE if the end of the directory is reached while
reading.
The directory seek cookies are returned to the NFS client and may be used
later to restart a directory read part way through the directory.
There should be one cookie returned per directory entry. The value of
There should be one cookie returned per directory entry.
The value of
the cookie should be the offset within the directory where the on-disc
version of the appropriate directory entry starts.
Memory for the cookies should be allocated using:

6
share/man/man9/VOP_RENAME.9
View File

@ -60,13 +60,15 @@ pathname information about the file's new name
.El
.Sh LOCKS
The source directory and file are unlocked but are expected to have their
ref count bumped on entry. The VOP routine is expected to
ref count bumped on entry.
The VOP routine is expected to
.Fn vrele
both prior
to returning.
.Pp
The destination directory and file are locked as well as having their ref
count bumped. The VOP routine is expected to
count bumped.
The VOP routine is expected to
.Fn vput
both prior to
returning.

7
share/man/man9/VOP_SETACL.9
View File

@ -70,14 +70,15 @@ This cred setting might be used to allow the kernel to authorize ACL
changes that the active process might not be permitted to make.
.Pp
The vnode ACL interface defines the syntax, and not semantics, of file and
directory ACL interfaces. More information about ACL management in kernel
directory ACL interfaces.
More information about ACL management in kernel
may be found in
.Xr acl 9 .
.Sh LOCKS
The vnode will be locked on entry and should remain locked on return.
.Sh RETURN VALUES
If the ACL is successfully set, then zero is returned. Otherwise, an
appropriate error code is returned.
If the ACL is successfully set, then zero is returned.
Otherwise, an appropriate error code is returned.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EINVAL