1) Fix prototype in vget(9).
[dragonfly.git] / share / man / man9 / vrele.9
1 .\" Copyright (c) 1996 Doug Rabson
2 .\"
3 .\" All rights reserved.
4 .\"
5 .\" This program is free software.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: src/share/man/man9/vrele.9,v 1.6.2.2 2001/12/17 11:30:19 ru Exp $
28 .\" $DragonFly: src/share/man/man9/vrele.9,v 1.5 2007/03/04 02:45:08 swildner Exp $
29 .\"
30 .Dd July 24, 1996
31 .Os
32 .Dt VRELE 9
33 .Sh NAME
34 .Nm vrele
35 .Nd decrement the use count for a vnode
36 .Sh SYNOPSIS
37 .In sys/param.h
38 .In sys/vnode.h
39 .Ft void
40 .Fn vrele "struct vnode *vp"
41 .Sh DESCRIPTION
42 Decrement the
43 .Va v_usecount
44 field of a vnode.
45 .Bl -tag -width ".Fa vp"
46 .It Fa vp
47 The vnode to decrement.
48 .El
49 .Pp
50 Any code in the system which is using a vnode should call
51 .Fn vrele
52 when it is finished with the vnode.
53 If the
54 .Va v_usecount
55 field of the vnode reaches zero, then it will be placed on the free list.
56 .Sh SEE ALSO
57 .Xr vget 9 ,
58 .Xr vnode 9 ,
59 .Xr vput 9 ,
60 .Xr vref 9
61 .Sh AUTHORS
62 This manual page was written by
63 .An Doug Rabson .