Mailing-List: contact issues-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: issues@commons.apache.org
Date: Thu, 13 Oct 2011 17:11:12 +0000 (UTC)
From: "Brendan Long (Created) (JIRA)" <jira@apache.org>
To: issues@commons.apache.org
Message-ID: 
 <1887094468.9935.1318525872040.JavaMail.tomcat@hel.zones.apache.org>
Subject: [jira] [Created] (VFS-368) SFTP documentation implies that
 "userDirIsRoot" defaults to true (but it defaults to false)
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit

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


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