docs/110200: VOP_FSYNC() and VFS_SYNC() man pages need "cred" removal

Jamie Jones jamie at bishopston.net
Sun Mar 11 20:30:07 UTC 2007


>Number:         110200
>Category:       docs
>Synopsis:       VOP_FSYNC() and VFS_SYNC() man pages need "cred" removal
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Mar 11 20:30:04 GMT 2007
>Closed-Date:
>Last-Modified:
>Originator:     Jamie Jones
>Release:        6.2-RELEASE
>Organization:
>Environment:
FreeBSD thompson.bishopston.net 6.2-STABLE FreeBSD 6.2-STABLE #0: Mon Feb 26 09:23:42 GMT 2007     root at thompson.bishopston.net:/usr/obj/usr/src/sys/THOMPSON  i386
>Description:
The man pages for VOP_FSYNC and VFS_SYNC still reference the "cred" parameter which has long since been removed.

i.e. int
     VOP_FSYNC(struct vnode *vp, struct ucred *cred, int waitfor,
         struct thread *td);
and int
     VFS_SYNC(struct mount *mp, int waitfor, struct ucred *cred,
         struct thread *td);


>How-To-Repeat:
man VOP_FSYNC
man VFS_SYNC
>Fix:
Updated the man pages as per the attached patch

cheers, 
Jamie

Patch attached with submission follows:

--- share/man/man9/VFS_SYNC.9.orig	Sun Mar 11 20:22:14 2007
+++ share/man/man9/VFS_SYNC.9	Sun Mar 11 20:24:00 2007
@@ -39,7 +39,7 @@
 .In sys/mount.h
 .In sys/vnode.h
 .Ft int
-.Fn VFS_SYNC "struct mount *mp" "int waitfor" "struct ucred *cred" "struct thread *td"
+.Fn VFS_SYNC "struct mount *mp" "int waitfor" "struct thread *td"
 .Sh DESCRIPTION
 The
 .Fn VFS_SYNC
@@ -61,8 +61,6 @@
 .It Dv MNT_LAZY
 push data not written by file system syncer
 .El
-.It Fa cred
-The caller's credentials.
 .It Fa td
 The calling thread.
 .El

--- share/man/man9/VOP_FSYNC.9.orig	Sun Mar 11 20:22:39 2007
+++ share/man/man9/VOP_FSYNC.9	Sun Mar 11 20:24:53 2007
@@ -38,7 +38,7 @@
 .In sys/param.h
 .In sys/vnode.h
 .Ft int
-.Fn VOP_FSYNC "struct vnode *vp" "struct ucred *cred" "int waitfor" "struct thread *td"
+.Fn VOP_FSYNC "struct vnode *vp" "int waitfor" "struct thread *td"
 .Sh DESCRIPTION
 This call flushes any dirty file system buffers for the file.
 It is used to implement the
@@ -51,8 +51,6 @@
 .Bl -tag -width waitfor
 .It Fa vp
 The vnode of the file.
-.It Fa cred
-The caller's credentials.
 .It Fa waitfor
 Whether the function should wait for I/O to complete.
 Possible values are:
@@ -84,7 +82,7 @@
 .Sh PSEUDOCODE
 .Bd -literal
 int
-vop_fsync(struct vnode *vp, struct ucred *cred, int waitfor, struct thread *td)
+vop_fsync(struct vnode *vp, int waitfor, struct thread *td)
 {
     struct buf *bp;
     struct buf *nbp;

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



More information about the freebsd-doc mailing list