hadoop-hdfs-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Aaron T. Myers (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HDFS-1381) MiniDFSCluster documentation refers to out-of-date configuration parameters
Date Fri, 24 Jun 2011 22:23:47 GMT

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

Aaron T. Myers commented on HDFS-1381:
--------------------------------------

Hey Jim, patch looks great. Thanks a lot for doing this.

Only thing is that I'd recommend using the {{@link}} annotation with the '#' symbol to separate
members so that when Javadocs are generated they'll include hyperlinks to the right place.
This will also let Eclipse and other IDEs refactor the comments correctly if we ever change
the names of these variables.

For example, instead of this:

{code}
DFSConfigKeys.DFS_NAMENODE_NAME_DIR_KEY
{code}

do this:

{code}
{@link DFSConfigKeys#DFS_NAMENODE_NAME_DIR_KEY}
{code}

You should be able to find examples of this throughout the code base.

> MiniDFSCluster documentation refers to out-of-date configuration parameters
> ---------------------------------------------------------------------------
>
>                 Key: HDFS-1381
>                 URL: https://issues.apache.org/jira/browse/HDFS-1381
>             Project: Hadoop HDFS
>          Issue Type: Bug
>          Components: test
>    Affects Versions: 0.20.1
>            Reporter: Jakob Homan
>            Assignee: Jim Plush
>              Labels: newbie
>             Fix For: 0.23.0
>
>         Attachments: HDFS-1381-take1.txt
>
>
> The javadoc for MiniDFSCluster makes repeated references to setting dfs.name.dir and
dfs.data.dir.  These should be replaced with references to DFSConfigKeys' DFS_NAMENODE_NAME_DIR_KEY
and DFS_DATANODE_DATA_DIR_KEY, respectively.  The old values are deprecated in DFSConfigKeys,
but we should switch to the new values where ever we can.
> Also, a quick search the code shows that TestDFSStorageStateRecovery.java and UpgradeUtilities.java
should be updated as well.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message