[src/trunk]: src/share/man/man9 Rewrite vput(9) description.

[riastradh <riastradh%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/2163d989a0b8
branches:  trunk
changeset: 807717:2163d989a0b8
user:      riastradh <riastradh%NetBSD.org@localhost>
date:      Mon Apr 20 14:07:24 2015 +0000

description:
Rewrite vput(9) description.

diffstat:

 share/man/man9/vnode.9 |  28 ++++++++++++++++++----------
 1 files changed, 18 insertions(+), 10 deletions(-)

diffs (43 lines):

diff -r 33d3ae4b42f7 -r 2163d989a0b8 share/man/man9/vnode.9
--- a/share/man/man9/vnode.9    Mon Apr 20 14:03:10 2015 +0000
+++ b/share/man/man9/vnode.9    Mon Apr 20 14:07:24 2015 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: vnode.9,v 1.62 2015/04/20 14:03:10 riastradh Exp $
+.\"     $NetBSD: vnode.9,v 1.63 2015/04/20 14:07:24 riastradh Exp $
 .\"
 .\" Copyright (c) 2001, 2005, 2006 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -582,16 +582,24 @@
 on success.
 .El
 .It Fn vput "vp"
-Unlock vnode
-.Fa vp
-and decrement its
-.Em v_usecount .
-Depending on the reference counts, move the vnode to the holdlist or
-the freelist.
-This operation is functionally equivalent to calling
+Legacy convenience routine for unlocking and releasing
+.Fa vp .
+Equivalent to:
+.Bd -literal -offset abcd
+.No "VOP_UNLOCK(" Ns Fa vp Ns Li ");"
+.No "vrele(" Ns Fa vp Ns Li ");"
+.Ed
+.Pp
+Note that this is
+.Em not
+an inverse of
+.Fn vget .
+The name appears so for hysterical raisins.
+New code should prefer using
 .Xr VOP_UNLOCK 9
-followed by
-.Fn vrele .
+and
+.Fn vrele
+directly.
 .It Fn vhold "vp"
 Mark the vnode
 .Fa vp