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] [Commented] (VFS-368) SFTP documentation implies that "userDirIsRoot" defaults to true
Date Tue, 13 Aug 2013 14:15:56 GMT

    [ https://issues.apache.org/jira/browse/VFS-368?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13738264#comment-13738264
] 

Gary Gregory commented on VFS-368:
----------------------------------

I changed the title from "SFTP documentation implies that "userDirIsRoot" defaults to true
(but it defaults to false)" to "SFTP documentation implies that "userDirIsRoot" defaults to
true" because the current code (trunk) does in fact defaults to true:

{code:java}
    /**
     * Returns <code>true</code> if the user directory is the root directory.
Defaults to <code>true</code>.
     * 
     * @param opts
     *            The FileSystemOptions.
     * @return <code>true</code> if the user directory is the root; defaults to
<code>true</code>.
     * @see #setUserDirIsRoot
     */
    public Boolean getUserDirIsRoot(final FileSystemOptions opts)
    {
        return this.getBoolean(opts, USER_DIR_IS_ROOT, Boolean.TRUE);
    }
{code}

I've improved the Javadoc and site documentation (trunk, not actually on the live site.)

To see the site, checkout trunk, and run "mvn site" then open "target/site/index.html".
                
> 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