[jira] [Updated] (VFS-368) SFTP documentation implies that "userDirIsRoot" defaults to true (but it defaults to false)

["Gary D. Gregory (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/VFS-368?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gary D. Gregory updated VFS-368:
--------------------------------

    Comment: was deleted

(was: How much of a surprise would this change be for current implementations that use the defaults?

IOW, how much would this break existing apps?)
    
> SFTP documentation implies that "userDirIsRoot" defaults to true (but it defaults to false)
> -------------------------------------------------------------------------------------------
>
>                 Key: VFS-368
>                 URL: https://issues.apache.org/jira/browse/VFS-368
>             Project: Commons VFS
>          Issue Type: Bug
>            Reporter: Brendan Long
>            Priority: Minor
>              Labels: sftp
>
> On this documentation page:
> http://commons.apache.org/vfs/filesystems.html#SFTP
> It says:
>     SFTP
>     Provides access to the files on an SFTP server (that is, an SSH or SCP server).
>     URI Format
>     sftp://[ username[: password]@] hostname[: port][ absolute-path]
>     Examples
>         sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz
> The default is actually that the path is relative from the user's home directory. This can be changed by running:
>     SftpFileSystemConfigBuilder
>     .getInstance()
>     .setUserDirIsRoot(options, false);
> I suggest changing the documentation to say [ relative-path ] and adding a note about absolute paths (but I'm not sure how to make it fit the style of this page).

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira