doc: dynamic mount requires dynroot and fakestat
authorMichael Meffie <mmeffie@sinenomine.net>
Mon, 10 Dec 2012 17:01:38 +0000 (12:01 -0500)
committerKen Dreyer <ktdreyer@ktdreyer.com>
Thu, 10 Jan 2013 18:33:59 +0000 (10:33 -0800)
Document that dynamic mount (/afs/.:mount) requires
dynroot and fakestat on non-linux unix.

Change-Id: I947edd30d510c7cc6840bc2cc74d0ef07b692afb
Reviewed-on: http://gerrit.openafs.org/8739
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Chas Williams - CONTRACTOR <chas@cmf.nrl.navy.mil>
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
Reviewed-by: Ken Dreyer <ktdreyer@ktdreyer.com>

doc/man-pages/pod8/afsd.pod
doc/txt/README.linux-nfstrans
doc/xml/AdminGuide/auagd010.xml

index 9616ac1..391a5ad 100644 (file)
@@ -536,6 +536,16 @@ the F<CellAlias> file can be used to provide shortname for common AFS cells
 which provides equivalent functionality to the most commonly used symbolic
 links.
 
+When the dynamic root (B<-dynroot>, B<-dynroot-sparse>) and the fake stat
+(B<-fakestat>, B<-fakestat-all>) modes are in effect, the cache manager
+provides a special directory named F</afs/.:mount> which allows access to
+volumes by volume name or ID.  The F</afs/.:mount> directory appears to be
+empty, but any name in the form of I<cell>:I<volume> will be resolved as a
+read-write mount point to the specified volume.  This dynamic mount feature is
+recommended only for temporary access to a volume.  Linux-based cache managers
+provide this dynamic mount feature even when dynamic root (B<-dynroot>,
+B<-dynroot-sparse>) is not in effect.
+
 =item B<-dynroot-sparse>
 
 In addition to operating in the manner described for dynroot above,
index ba4faa3..901080f 100644 (file)
@@ -193,7 +193,9 @@ a volume which is no longer in the cache (and thus has no known mount
 point), it will complete the path to the AFS root using the dynamic
 mount directory.
 
-This feature is available whenever the dynamic AFS root is enabled.
+On non-linux cache managers, this feature is available when dynamic
+root and fake stat modes are enabled.
+
 On Linux systems, it is also available even when dynroot is not enabled,
 to support the NFS translator.  It is presently not possible to disable
 this feature, though that ability may be added in the future.  It would
index b2e2a46..6892fd3 100644 (file)
       recommended for temporary access to a volume. For example, if you
       have recently restored a volume from a backup, you can use this
       syntax to quickly access the volume without mounting it.</para>
+
+      <para>This feature is available with Windows and Linux based cache
+      managers by default. This feature is available with other Unix based
+      cache managers when the dynamic root (-dynroot) and fake stat
+      (-fakestat) modes are enabled.</para>
+
       <para>Examples:</para>
       <itemizedlist>
           <listitem>