d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
880222c4c8
freebsd-skq/share/man/man9/VOP_OPENCLOSE.9

115 lines
3.3 KiB
Groff
Raw Normal View History

This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.\" -*- nroff -*-
.\"
.\" Copyright (c) 1996 Doug Rabson
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.\"
.Dd July 24, 1996
.Os
.Dt VOP_OPEN 9
.Sh NAME
.Nm VOP_OPEN ,
.Nm VOP_CLOSE
.Nd open or close a file
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/param.h
.In sys/vnode.h
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Ft int
Document the 'fdidx' argument of VOP_OPEN(9). PR: 56911 Noticed by: Jun Su <junsu@m-net.arbornet.org>
2004-05-10 23:17:09 +00:00
.Fn VOP_OPEN "struct vnode *vp" "int mode" "struct ucred *cred" "struct thread *td" "int fdidx"
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Ft int
- Fix a number of man pages broken by the KSE merger.
2001-11-20 18:19:19 +00:00
.Fn VOP_CLOSE "struct vnode *vp" "int mode" "struct ucred *cred" "struct thread *td"
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh DESCRIPTION
The
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_OPEN
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
entry point is called before a file is accessed by a process and the
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_CLOSE
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
entry point is called after a file is finished with by the process.
.Pp
The arguments are:
.Bl -tag -width mode
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)
2003-05-31 14:07:25 +00:00
.It Fa vp
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
The vnode of the file.
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)
2003-05-31 14:07:25 +00:00
.It Fa mode
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
The access mode required by the calling process.
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)
2003-05-31 14:07:25 +00:00
.It Fa td
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
The thread which is accessing the file.
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.El
Formatting tweaks.
1997-03-04 10:02:44 +00:00
.Pp
Document the 'fdidx' argument of VOP_OPEN(9). PR: 56911 Noticed by: Jun Su <junsu@m-net.arbornet.org>
2004-05-10 23:17:09 +00:00
Additionally,
.Fn VOP_OPEN
can accept a file descriptor number in
.Fa fdidx ;
Add a comma after `e.g.', so that mdoc does not add two whitespaces automatically. Noticed by: Ruslan Ermilov <ru at FreeBSD.org>
2004-05-11 14:13:52 +00:00
this is useful for file systems which require such information, e.g.,
Fixed xref.
2005-01-21 10:17:17 +00:00
.Xr fdescfs 5 .
Document the 'fdidx' argument of VOP_OPEN(9). PR: 56911 Noticed by: Jun Su <junsu@m-net.arbornet.org>
2004-05-10 23:17:09 +00:00
.Pp
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
The access mode is a set of flags, including
.Dv FREAD ,
.Dv FWRITE ,
.Dv O_NONBLOCK ,
.Dv O_APPEND .
.Sh LOCKS
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_OPEN
More clarification of locking requirements.
1999-09-24 10:42:45 +00:00
expects
.Fa vp
to be locked on entry and will leave it locked on return.
.Pp
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_CLOSE
More clarification of locking requirements.
1999-09-24 10:42:45 +00:00
expects at least a reference to be associated with the vnode and does not
Mdoc Janitor: * Fix hard sentence breaks in VFS_*(9) and VOP_*(9) manual pages.
2003-10-23 02:11:14 +00:00
care whether the vnode is locked or not.
The lock and reference state is left unchanged on return.
Note that
More clarification of locking requirements.
1999-09-24 10:42:45 +00:00
.Fa vn_close
expects an unlocked, referenced vnode and will dereference the vnode prior
to returning.
Document the 'fdidx' argument of VOP_OPEN(9). PR: 56911 Noticed by: Jun Su <junsu@m-net.arbornet.org>
2004-05-10 23:17:09 +00:00
.Sh IMPLEMENTATION NOTES
The
.Fa fdidx
argument to
.Fn VOP_OPEN
is currently unused, use
.Ql \-1
for the meantime; however, this will change in future.
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh RETURN VALUES
Zero is returned on success, otherwise an error code is returned.
.Sh PSEUDOCODE
.Bd -literal
int
- Fix a number of man pages broken by the KSE merger.
2001-11-20 18:19:19 +00:00
vop_open(struct vnode *vp, int mode, struct ucred *cred, struct thread *td)
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
{
/*
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
* Most file systems don't do much here.
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
*/
return 0;
}
.Ed
.Sh SEE ALSO
.Xr vnode 9 ,
.Xr VOP_LOOKUP 9
.Sh AUTHORS
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq.
1998-03-12 07:31:21 +00:00
This man page was written by
.An Doug Rabson .
Reference in New Issue Copy Permalink