vfs: bring getnewvnode manpage closer to reality

This commit is contained in:
Mateusz Guzik 2023-11-01 08:20:12 +00:00
parent ef85fd507e
commit 1692e50f25

View file

@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
.\" DAMAGE.
.\"
.Dd November 21, 2001
.Dd November 1, 2023
.Dt GETNEWVNODE 9
.Os
.Sh NAME
@ -35,14 +35,12 @@
.In sys/vnode.h
.In sys/mount.h
.Ft int
.Fn getnewvnode "const char *tag" "struct mount *mp" "vop_t **vops" "struct vnode **vpp"
.Fn getnewvnode "const char *tag" "struct mount *mp" "struct vop_vector *vops" "struct vnode **vpp"
.Sh DESCRIPTION
The
.Fn getnewvnode
function initializes a new vnode, assigning it the vnode operations passed in
.Fa vops .
The vnode is either freshly allocated, or taken from the head of the
free list depending on the number of vnodes already in the system.
.Pp
The arguments to
.Fn getnewvnode
@ -61,7 +59,8 @@ Points to the new vnode upon successful completion.
.Sh RETURN VALUES
.Fn getnewvnode
returns 0 on success.
There are currently no failure conditions - that do not result in a panic.
.Sh BUGS
It never return an error, instead either succeeds or blocks indefinitely.
.Sh AUTHORS
This manual page was written by
.An Chad David Aq Mt davidc@acns.ab.ca .