Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 3 May 2002 20:35:20 +0200 (CEST)
From:      Poul-Henning Kamp <phk@critter.freebsd.dk>
To:        FreeBSD-gnats-submit@FreeBSD.org
Subject:   docs/37719: Detail VOP_ naming in a relevant man-page
Message-ID:  <200205031835.g43IZKjD020626@critter.freebsd.dk>

next in thread | raw e-mail | index | archive | help

>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




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200205031835.g43IZKjD020626>