Bug 23745

Summary: man page for vcount(9)
Product: Documentation Reporter: Andrew Stevenson <andrew>
Component: Books & ArticlesAssignee: Jeroen Ruigrok van der Werven <asmodai>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Andrew Stevenson 2000-12-22 06:00:01 UTC
When trying to understand a part of the kernel I found a number of undocumented
functions. I documented vcount based on the comments in the code...I think I've
got it right but haven't manged to get any reviewers as yet.

Fix: 

.\" -*- nroff -*-
.\"
.\" Copyright (c) 2000 Andrew Stevenson
.\"
.\" 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.
.\"
.\"
.\" If this man page travels to places exotic (like projects other than
.\" FreeBSD) I would love to hear about it.
.\"	Andrew <andrew@ugh.net.au>
.\"
.\" $Id$
.\"
.Dd November 4th, 2000
.Os
.Dt VCOUNT 9
.Sh NAME
.Nm vcount ,
.Nm count_dev
.Nd get total number of references to a device.
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/conf.h>
.Fd #include <sys/vnode.h>
.Ft int
.Fn vcount "struct vnode *vp"
.Ft int
.Fn count_dev "dev_t dev"

.Sh DESCRIPTION

.Fn vcount
is used to get the number of users of (code with references to)  a
particular device. It allows for the fact that multiple vnodes may
reference the same device.

.Fn count_dev
does the same thing as vcount but takes a dev_t rather than a vnode
pointer as an argument.

.Sh RETURN VALUES
.Fn vcount
and
.Fn count_dev
both return the number of users of the device.

.Sh SEE ALSO
.Xr VFS 9 ,
.Xr vnode 9 ,
.Pa src/sys/kern/vfs_subr.c
.Sh AUTHORS
This man page was written by
.An Andrew Stevenson .
Comment 1 Jeroen Ruigrok van der Werven freebsd_committer freebsd_triage 2001-02-06 09:05:12 UTC
State Changed
From-To: open->closed

Committed to -CURRENT.  STABLE to follow. 

Thanks! 


Comment 2 Jeroen Ruigrok van der Werven freebsd_committer freebsd_triage 2001-02-06 09:05:12 UTC
Responsible Changed
From-To: freebsd-doc->asmodai

I committed it.