commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gary Gregory (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (VFS-368) SFTP documentation implies that "userDirIsRoot" defaults to true
Date Tue, 13 Aug 2013 14:13:48 GMT

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

Gary Gregory updated VFS-368:
-----------------------------

    Summary: SFTP documentation implies that "userDirIsRoot" defaults to true  (was: SFTP
documentation implies that "userDirIsRoot" defaults to true (but it defaults to false))
    
> SFTP documentation implies that "userDirIsRoot" defaults to true
> ----------------------------------------------------------------
>
>                 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
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message