[VFS-368] SFTP documentation implies that "userDirIsRoot" defaults to true

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.1
• Labels: sftp
• Assignee: Unassigned
• Reporter: Brendan Long
• Created: 13/Oct/11 17:10
• Updated: 19/May/16 18:26
• Resolved: 13/Aug/13 14:21

Description

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).