Module Name: src
Committed By: pooka
Date: Tue Nov 30 18:08:46 UTC 2010
Modified Files:
src/lib/librumpvfs: rump_etfs.3
Log Message:
ahem, use public interface names in the doc
To generate a diff of this commit:
cvs rdiff -u -r1.1 -r1.2 src/lib/librumpvfs/rump_etfs.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/librumpvfs/rump_etfs.3
diff -u src/lib/librumpvfs/rump_etfs.3:1.1 src/lib/librumpvfs/rump_etfs.3:1.2
--- src/lib/librumpvfs/rump_etfs.3:1.1 Tue Nov 30 17:32:29 2010
+++ src/lib/librumpvfs/rump_etfs.3 Tue Nov 30 18:08:46 2010
@@ -1,4 +1,4 @@
-.\" $NetBSD: rump_etfs.3,v 1.1 2010/11/30 17:32:29 pooka Exp $
+.\" $NetBSD: rump_etfs.3,v 1.2 2010/11/30 18:08:46 pooka Exp $
.\"
.\" Copyright (c) 2010 Antti Kantee. All rights reserved.
.\"
@@ -34,16 +34,16 @@
.Sh SYNOPSIS
.In rump/rump.h
.Ft int
-.Fo etfs_register
+.Fo rump_pub_etfs_register
.Fa "const char *key" "const char *hostpath" "enum rump_etfs_type ftype"
.Fc
.Ft int
-.Fo etfs_register_withsize
+.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"
.Fc
.Ft int
-.Fn etfs_remove "const char *key"
+.Fn rump_pub_etfs_remove "const char *key"
.Sh DESCRIPTION
The rump ExtraTerrestrial File System
.Nm ( )
@@ -101,21 +101,21 @@
.Pp
The interfaces are:
.Bl -tag -width xxxx
-.It Fn etfs_register "key" "hostpath" "ftype"
+.It Fn rump_pub_etfs_register "key" "hostpath" "ftype"
Map
.Fa key
to a file of type
.Fa ftype
with the contents of
.Fa hostpath .
-.It Fn etfs_register_withsize "key" "hostpath" "ftype" "begin" "size"
+.It Fn rump_pub_etfs_register_withsize "key" "hostpath" "ftype" "begin" "size"
Like the above, but map only
.Fa [ begin , begin+size ]
from
.Fa hostpath .
This is useful when mapping disk images where only one partition is
relevant to the application.
-.It Fn etfs_remove "key"
+.It Fn rump_pub_etfs_remove "key"
Remove etfs mapping for
.Fa key .
This routine may be called only if the file related to the mapping
@@ -124,7 +124,7 @@
Map a host image file to a mountable /dev/harddisk path using
window offsets from the disklabel.
.Bd -literal -offset indent
-rump_etfs_register_withsize("/dev/harddisk", "disk.img",
+rump_pub_etfs_register_withsize("/dev/harddisk", "disk.img",
RUMP_ETFS_BLK,
pp->p_offset << DEV_BSHIFT, pp->p_size << DEV_BSHIFT);
.Ed
@@ -132,7 +132,7 @@
Make the host kernel module directory hierarchy available within the
rump kernel.
.Bd -literal -offset indent
-rump_etfs_register("/stand/i386/5.99.41",
+rump_pub_etfs_register("/stand/i386/5.99.41",
"/stand/i386/5.99.41", RUMP_ETFS_DIR_SUBDIRS);
.Ed
.Sh SEE ALSO
