From owner-freebsd-doc  Fri May  3 11:40:16 2002
Delivered-To: freebsd-doc@hub.freebsd.org
Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP id C0F5B37B419
	for <freebsd-doc@hub.freebsd.org>; Fri,  3 May 2002 11:40:01 -0700 (PDT)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.11.6/8.11.6) id g43Ie1T43645;
	Fri, 3 May 2002 11:40:01 -0700 (PDT)
	(envelope-from gnats)
Received: from critter.freebsd.dk (critter.freebsd.dk [212.242.86.163])
	by hub.freebsd.org (Postfix) with ESMTP id 9AC2337B426
	for <FreeBSD-gnats-submit@freebsd.org>; Fri,  3 May 2002 11:35:45 -0700 (PDT)
Received: from critter.freebsd.dk (localhost [127.0.0.1])
	by critter.freebsd.dk (8.12.2/8.12.2) with ESMTP id g43IZKQ4020627
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 3 May 2002 20:35:20 +0200 (CEST)
	(envelope-from phk@critter.freebsd.dk)
Received: (from phk@localhost)
	by critter.freebsd.dk (8.12.2/8.12.2/Submit) id g43IZKjD020626;
	Fri, 3 May 2002 20:35:20 +0200 (CEST)
Message-Id: <200205031835.g43IZKjD020626@critter.freebsd.dk>
Date: Fri, 3 May 2002 20:35:20 +0200 (CEST)
From: Poul-Henning Kamp <phk@critter.freebsd.dk>
Reply-To: Poul-Henning Kamp <phk@critter.freebsd.dk>
To: FreeBSD-gnats-submit@FreeBSD.org
X-Send-Pr-Version: 3.113
Subject: docs/37719: Detail VOP_ naming in a relevant man-page
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-doc.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-doc>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-doc>
X-Loop: FreeBSD.org


>Number:         37719
>Category:       docs
>Synopsis:       Detail VOP_ naming in a relevant man-page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Fri May 03 11:40:01 PDT 2002
>Closed-Date:
>Last-Modified:
>Originator:     Poul-Henning Kamp
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD critter.freebsd.dk 5.0-CURRENT FreeBSD 5.0-CURRENT #89: Thu Apr 11 07:45:32 CEST 2002 root@critter.freebsd.dk:/freebsd/src/sys/i386/compile/CRITTER i386


>Description:

	we should detail in some relevant man-page the naming scheme
	for vnode operations.  vnode(9) is not quite the place I feel
	but we have no VOP(9) corresponding to VFS(9).

	The functions which can appear in the vnode vectors SHOULD
	follow this naming scheme:

	Methods implemented in a particular filesystem:
		<filesystem>_<vop>
	examples
		msdosfs_read(), devfs_lookup(), ufs_inactive()

	Generic default functions:
		vop_std<vop>
	examples:
		vop_stdinactive(), vop_stdgetpages()

	Generic do-nothing functions:
		vop_null<vop>
	examples:
		vop_nullinactive(), vop_nullread()

	Generic don't-do functions:
		vop_no<vop>
	examples
		vop_noioctl().

	Generic return-error functions:
		vop_<error>
	examples:
		vop_einval(), vop_eopnotsupp()

	The difference between do-nothing and don't-do can be subtle
	and hard to get right.  Be careful.
	

>How-To-Repeat:
	
>Fix:

	


>Release-Note:
>Audit-Trail:
>Unformatted:

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message