docs/56584: Updates for VOP_GETPAGES(9) and VOP_PUTPAGES(9)

[Andrey Simonenko]

>Number:         56584
>Category:       docs
>Synopsis:       Updates for VOP_GETPAGES(9) and VOP_PUTPAGES(9)
>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:   Mon Sep 08 00:20:07 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator:     Andrey Simonenko
>Release:        FreeBSD 4.8-STABLE and 5.1-RELEASE
>Organization:
>Environment:
>Description:

I suppose that VOP_GETPAGES(9) and VOP_PUTPAGES(9) contain mistakes,
also following patch adds descriptions for not described previously
arguments.

Comments?

>How-To-Repeat:
>Fix:
--- VOP_GETPAGES.9.orig	Thu Jun  5 04:56:16 2003
+++ VOP_GETPAGES.9	Sun Sep  7 23:04:59 2003
@@ -40,29 +40,33 @@
 .In sys/vnode.h
 .In vm/vm.h
 .Ft int
-.Fn VOP_GETPAGES "struct vnode *vp" "vm_page_t *m" "int count" "int reqpage" "vm_ooffset_t offset"
+.Fn VOP_GETPAGES "struct vnode *vp" "vm_page_t *m" "int bytecount" "int reqpage" "vm_ooffset_t offset"
 .Ft int
-.Fn VOP_PUTPAGES "struct vnode *vp" "vm_page_t *m" "int count" "int sync" "int *rtvals" "vm_ooffset_t offset"
+.Fn VOP_PUTPAGES "struct vnode *vp" "vm_page_t *m" "int bytecount" "int sync" "int *rtvals" "vm_ooffset_t offset"
 .Sh DESCRIPTION
+These entry points read and write VM pages from a file respectively.
+.Pp
 The arguments are:
 .Bl -tag -width reqpage
 .It Ar vp
 The file to access.
 .It Ar m
-A page ???
-.It Ar count
-How many pages to access.
+The array of vm_page_t.
+.It Ar bytecount
+How many bytes to access (multiple of the page size), should be
+divided by the page size to get the number of elements in the array
+.Ar m .
 .It Ar sync
 Nonzero if the write should be synchronous.
 .It Ar rtvals
-???
+The array of return values for corresponding pages in the array
+.Ar m .
 .It Ar reqpage
-???
+The index of the requested page in the array
+.Ar m .
 .It Ar offset
 Offset in the file to start accessing.
 .El
-.Pp
-Not quite sure about this one.
 .Sh RETURN VALUES
 Zero is returned on success, otherwise an error is returned.
 .Sh SEE ALSO
>Release-Note:
>Audit-Trail:
>Unformatted:
 To: FreeBSD-gnats-submit at freebsd.org
 From: Andrey Simonenko <simon at comsys.ntu-kpi.kiev.ua>
 Reply-To: Andrey Simonenko <simon at comsys.ntu-kpi.kiev.ua>
 Cc: 
 X-send-pr-version: 3.113
 X-GNATS-Notify: