[src/trunk]: src/lib/librumpvfs fix prototype, document RUMP_ETFS_SIZE_ENDOFF

[pooka <pooka%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/cd45a52a9752
branches:  trunk
changeset: 761627:cd45a52a9752
user:      pooka <pooka%NetBSD.org@localhost>
date:      Thu Feb 03 10:21:58 2011 +0000

description:
fix prototype, document RUMP_ETFS_SIZE_ENDOFF

diffstat:

 lib/librumpvfs/rump_etfs.3 |  13 ++++++++++---
 1 files changed, 10 insertions(+), 3 deletions(-)

diffs (41 lines):

diff -r 89ce6a5d918b -r cd45a52a9752 lib/librumpvfs/rump_etfs.3
--- a/lib/librumpvfs/rump_etfs.3        Thu Feb 03 10:06:06 2011 +0000
+++ b/lib/librumpvfs/rump_etfs.3        Thu Feb 03 10:21:58 2011 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: rump_etfs.3,v 1.4 2010/11/30 22:00:01 wiz Exp $
+.\"     $NetBSD: rump_etfs.3,v 1.5 2011/02/03 10:21:58 pooka Exp $
 .\"
 .\" Copyright (c) 2010 Antti Kantee.  All rights reserved.
 .\"
@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd November 30, 2010
+.Dd February 3, 2011
 .Dt RUMP_ETFS 3
 .Os
 .Sh NAME
@@ -40,7 +40,7 @@
 .Ft int
 .Fo rump_pub_etfs_register_withsize
 .Fa "const char *key" "const char *hostpath" "enum rump_etfs_type ftype"
-.Fa "uint64_t begin" "uint64_t end"
+.Fa "uint64_t begin" "uint64_t size"
 .Fc
 .Ft int
 .Fn rump_pub_etfs_remove "const char *key"
@@ -115,6 +115,13 @@
 .Fa hostpath .
 This is useful when mapping disk images where only one partition is
 relevant to the application.
+If
+.Ar size
+is given the special value
+.Dv RUMP_ETFS_SIZE_ENDOFF ,
+the underlying file is mapped from
+.Ar begin
+to the end of the file.
 .It Fn rump_pub_etfs_remove "key"
 Remove etfs mapping for
 .Fa key .