Author: ggregory
Date: Tue Aug 13 15:48:21 2013
New Revision: 1513564

URL: http://svn.apache.org/r1513564
Log:
[VFS-368] SFTP documentation implies that "userDirIsRoot" defaults to true.

Modified:
    commons/proper/vfs/trunk/src/changes/changes.xml
    commons/proper/vfs/trunk/src/site/xdoc/filesystems.xml

Modified: commons/proper/vfs/trunk/src/changes/changes.xml
URL: 
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/src/changes/changes.xml?rev=1513564&r1=1513563&r2=1513564&view=diff
==============================================================================
--- commons/proper/vfs/trunk/src/changes/changes.xml (original)
+++ commons/proper/vfs/trunk/src/changes/changes.xml Tue Aug 13 15:48:21 2013
@@ -26,6 +26,9 @@
 <!--       <action issue="VFS-443" dev="ggregory" type="update" 
due-to="nickallen"> -->
 <!--           [Local] Need an easy way to convert from a FileObject to a 
File. -->
 <!--       </action> -->
+      <action issue="VFS-368" dev="ggregory" type="update" due-to="Brendan 
Long">
+        SFTP documentation implies that "userDirIsRoot" defaults to true.
+      </action>
       <action issue="VFS-265" dev="ggregory" type="update" due-to="Scott 
Bjerstedt">
         [FTP] Set user dir as root dir by default.
       </action>

Modified: commons/proper/vfs/trunk/src/site/xdoc/filesystems.xml
URL: 
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/src/site/xdoc/filesystems.xml?rev=1513564&r1=1513563&r2=1513564&view=diff
==============================================================================
--- commons/proper/vfs/trunk/src/site/xdoc/filesystems.xml (original)
+++ commons/proper/vfs/trunk/src/site/xdoc/filesystems.xml Tue Aug 13 15:48:21 
2013
@@ -595,7 +595,7 @@
                     <i>password</i>]@]
                     <i>hostname</i>[:
                     <i>port</i>][
-                    <i>absolute-path</i>]
+                    <i>relative-path</i>]
                 </code>
             </p>
 
@@ -608,6 +608,13 @@
                 </li>
             </ul>
 
+            <p>
+                By default, the path is relative to the user's home directory. 
This can be changed with:
+            </p>
+            <p>
+                
<code>FtpFileSystemConfigBuilder.getInstance().setUserDirIsRoot(options, 
false);</code>
+            </p>
+
         </section>
 
         <section name="FTPS">
@@ -656,7 +663,7 @@
                     <i>password</i>]@]
                     <i>hostname</i>[:
                     <i>port</i>][
-                    <i>absolute-path</i>]
+                    <i>relative-path</i>]
                 </code>
             </p>
 
@@ -669,6 +676,13 @@
                 </li>
             </ul>
 
+            <p>
+                By default, the path is relative to the user's home directory. 
This can be changed with:
+            </p>
+            <p>
+                
<code>FtpFileSystemConfigBuilder.getInstance().setUserDirIsRoot(options, 
false);</code>
+            </p>
+            
         </section>
 
         <section name="CIFS">


Reply via email to