Browse Source

9p: Update documentation to add fscache related bits

Update the documentation to describe FS-Cache related
caching parameters. This patch also updates the pointers
to 9p-related papers and adds pointer to the Wiki.

Signed-off-by: Abhishek Kulkarni <adkulkar@umail.iu.edu>
Signed-off-by: Eric Van Hensbergen <ericvh@gmail.com>
Abhishek Kulkarni 15 years ago
parent
commit
f4edeeb393
1 changed files with 26 additions and 14 deletions
  1. 26 14
      Documentation/filesystems/9p.txt

+ 26 - 14
Documentation/filesystems/9p.txt

@@ -18,11 +18,11 @@ the 9p client is available in the form of a USENIX paper:
 
 
 Other applications are described in the following papers:
 Other applications are described in the following papers:
 	* XCPU & Clustering
 	* XCPU & Clustering
-		http://www.xcpu.org/xcpu-talk.pdf
+		http://xcpu.org/papers/xcpu-talk.pdf
 	* KVMFS: control file system for KVM
 	* KVMFS: control file system for KVM
-		http://www.xcpu.org/kvmfs.pdf
-	* CellFS: A New ProgrammingModel for the Cell BE
-		http://www.xcpu.org/cellfs-talk.pdf
+		http://xcpu.org/papers/kvmfs.pdf
+	* CellFS: A New Programming Model for the Cell BE
+		http://xcpu.org/papers/cellfs-talk.pdf
 	* PROSE I/O: Using 9p to enable Application Partitions
 	* PROSE I/O: Using 9p to enable Application Partitions
 		http://plan9.escet.urjc.es/iwp9/cready/PROSE_iwp9_2006.pdf
 		http://plan9.escet.urjc.es/iwp9/cready/PROSE_iwp9_2006.pdf
 
 
@@ -48,6 +48,7 @@ OPTIONS
                                 (see rfdno and wfdno)
                                 (see rfdno and wfdno)
 			virtio	- connect to the next virtio channel available
 			virtio	- connect to the next virtio channel available
 				(from lguest or KVM with trans_virtio module)
 				(from lguest or KVM with trans_virtio module)
+			rdma	- connect to a specified RDMA channel
 
 
   uname=name	user name to attempt mount as on the remote server.  The
   uname=name	user name to attempt mount as on the remote server.  The
   		server may override or ignore this value.  Certain user
   		server may override or ignore this value.  Certain user
@@ -59,16 +60,22 @@ OPTIONS
   cache=mode	specifies a caching policy.  By default, no caches are used.
   cache=mode	specifies a caching policy.  By default, no caches are used.
 			loose = no attempts are made at consistency,
 			loose = no attempts are made at consistency,
                                 intended for exclusive, read-only mounts
                                 intended for exclusive, read-only mounts
+			fscache = use FS-Cache for a persistent, read-only
+				cache backend.
 
 
   debug=n	specifies debug level.  The debug level is a bitmask.
   debug=n	specifies debug level.  The debug level is a bitmask.
-  			0x01 = display verbose error messages
-			0x02 = developer debug (DEBUG_CURRENT)
-			0x04 = display 9p trace
-			0x08 = display VFS trace
-			0x10 = display Marshalling debug
-			0x20 = display RPC debug
-			0x40 = display transport debug
-			0x80 = display allocation debug
+			0x01  = display verbose error messages
+			0x02  = developer debug (DEBUG_CURRENT)
+			0x04  = display 9p trace
+			0x08  = display VFS trace
+			0x10  = display Marshalling debug
+			0x20  = display RPC debug
+			0x40  = display transport debug
+			0x80  = display allocation debug
+			0x100 = display protocol message debug
+			0x200 = display Fid debug
+			0x400 = display packet debug
+			0x800 = display fscache tracing debug
 
 
   rfdno=n	the file descriptor for reading with trans=fd
   rfdno=n	the file descriptor for reading with trans=fd
 
 
@@ -100,6 +107,10 @@ OPTIONS
 			any   = v9fs does single attach and performs all
 			any   = v9fs does single attach and performs all
 				operations as one user
 				operations as one user
 
 
+  cachetag	cache tag to use the specified persistent cache.
+		cache tags for existing cache sessions can be listed at
+		/sys/fs/9p/caches. (applies only to cache=fscache)
+
 RESOURCES
 RESOURCES
 =========
 =========
 
 
@@ -118,7 +129,7 @@ and export.
 A Linux version of the 9p server is now maintained under the npfs project
 A Linux version of the 9p server is now maintained under the npfs project
 on sourceforge (http://sourceforge.net/projects/npfs).  The currently
 on sourceforge (http://sourceforge.net/projects/npfs).  The currently
 maintained version is the single-threaded version of the server (named spfs)
 maintained version is the single-threaded version of the server (named spfs)
-available from the same CVS repository.
+available from the same SVN repository.
 
 
 There are user and developer mailing lists available through the v9fs project
 There are user and developer mailing lists available through the v9fs project
 on sourceforge (http://sourceforge.net/projects/v9fs).
 on sourceforge (http://sourceforge.net/projects/v9fs).
@@ -126,7 +137,8 @@ on sourceforge (http://sourceforge.net/projects/v9fs).
 A stand-alone version of the module (which should build for any 2.6 kernel)
 A stand-alone version of the module (which should build for any 2.6 kernel)
 is available via (http://github.com/ericvh/9p-sac/tree/master)
 is available via (http://github.com/ericvh/9p-sac/tree/master)
 
 
-News and other information is maintained on SWiK (http://swik.net/v9fs).
+News and other information is maintained on SWiK (http://swik.net/v9fs)
+and the Wiki (http://sf.net/apps/mediawiki/v9fs/index.php).
 
 
 Bug reports may be issued through the kernel.org bugzilla 
 Bug reports may be issued through the kernel.org bugzilla 
 (http://bugzilla.kernel.org)
 (http://bugzilla.kernel.org)