d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
832e6ede23
freebsd-skq/share/man/man9/VOP_INACTIVE.9

82 lines
2.7 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
.\"
VOP_INACTIVE(9): clarify wording Reviewed by: kib, 0mp MFC after: 2 weeks Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D19596
2019-03-15 21:11:47 +00:00
.Dd March 15, 2019
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
.Dt VOP_INACTIVE 9
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
.Os
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 NAME
.Nm VOP_INACTIVE ,
.Nm VOP_RECLAIM
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
.Nd reclaim file system resources for a vnode
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 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
- Fix a number of man pages broken by the KSE merger.
2001-11-20 18:19:19 +00:00
.Fn VOP_INACTIVE "struct vnode *vp" "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
.Ft int
- Fix a number of man pages broken by the KSE merger.
2001-11-20 18:19:19 +00:00
.Fn VOP_RECLAIM "struct vnode *vp" "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 arguments are:
mdoc(7) police: eliminate warnings.
2000-11-17 15:40:57 +00:00
.Bl -tag -width 2n
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 being reclaimed.
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
.Pp
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_INACTIVE
VOP_INACTIVE(9): clarify wording Reviewed by: kib, 0mp MFC after: 2 weeks Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D19596
2019-03-15 21:11:47 +00:00
is usually called when the kernel is no longer using the vnode.
However, there is no guarantee that it will be called at all, for example if
the last reference was dropped while the vnode lock could not be upgraded
to exclusive without sleeping.
Mdoc Janitor: * Fix hard sentence breaks in VFS_*(9) and VOP_*(9) manual pages.
2003-10-23 02:11:14 +00:00
This may be
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
because the reference count reaches zero or it may be that the
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
file system is being forcibly unmounted while there are open files.
VOP_INACTIVE(9): clarify wording Reviewed by: kib, 0mp MFC after: 2 weeks Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D19596
2019-03-15 21:11:47 +00:00
It can be used to reclaim space on the last close of an
Mdoc Janitor: * Make use of .Sq mdoc command. * Add a .Pp for separating VOP_RECLAIM text from VOP_INACTIVE * Make use of .Fa for the vnode pointer function arg.
2003-10-23 03:07:56 +00:00
.Sq open but deleted
VOP_INACTIVE(9): clarify wording Reviewed by: kib, 0mp MFC after: 2 weeks Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D19596
2019-03-15 21:11:47 +00:00
file.
Mdoc Janitor: * Make use of .Sq mdoc command. * Add a .Pp for separating VOP_RECLAIM text from VOP_INACTIVE * Make use of .Fa for the vnode pointer function arg.
2003-10-23 03:07:56 +00:00
.Pp
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_RECLAIM
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
is called when a vnode is being reused for a different file system.
Any file system specific resources associated with the vnode should be
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
freed.
Update errors in documentation for various VOP_ calls. Specifically, describe the correct locking state expected on entry and return.
1999-09-24 07:07:02 +00:00
.Sh LOCKS
Correct the locking statement. Sponsored by: The FreeBSD Foundation MFC after: 3 days
2014-07-27 20:47:06 +00:00
For both
.Fn VOP_INACTIVE
and
.Fn VOP_RECLAIM ,
the
Mdoc Janitor: * Make use of .Sq mdoc command. * Add a .Pp for separating VOP_RECLAIM text from VOP_INACTIVE * Make use of .Fa for the vnode pointer function arg.
2003-10-23 03:07:56 +00:00
.Fa vp
Explicitely mention that inactivated or reclaimed vnode is locked exclusively. Sponsored by: The FreeBSD Foundation MFC after: 3 days
2014-07-27 20:55:47 +00:00
will be exclusively locked on entry, and must be left exclusively
locked on return.
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 SEE ALSO
.Xr vnode 9
.Sh AUTHORS
Use 'manual page' instead of 'man page' for consistency. Approved by: re (hrs)
2005-06-28 20:15:19 +00:00
This manual page was written by
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq.
1998-03-12 07:31:21 +00:00
.An Doug Rabson .
Reference in New Issue Copy Permalink