[jira] [Commented] (HDFS-3994) misleading comment in CommonConfigurationKeysPublic

["Kousuke Saruta (JIRA)" <ji...@apache.org>]

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

Kousuke Saruta commented on HDFS-3994:
--------------------------------------

Colin, do you mean it' wrong to use CommonConfigurationKeys and we should use a class extending CommonConfigurationKeysPublic right?
                
> misleading comment in CommonConfigurationKeysPublic
> ---------------------------------------------------
>
>                 Key: HDFS-3994
>                 URL: https://issues.apache.org/jira/browse/HDFS-3994
>             Project: Hadoop HDFS
>          Issue Type: Bug
>          Components: hdfs-client
>    Affects Versions: 2.0.3-alpha
>            Reporter: Colin Patrick McCabe
>            Priority: Trivial
>
> {{CommonConfigurationKeysPublic}} contains a potentially misleading comment:
> {code}
> /** 
>  * This class contains constants for configuration keys used
>  * in the common code.
>  *
>  * It includes all publicly documented configuration keys. In general
>  * this class should not be used directly (use CommonConfigurationKeys
>  * instead)
>  */
> {code}
> This comment suggests that the user use {{CommonConfigurationKeys}}, despite the fact that that class is {{InterfaceAudience.private}} whereas {{CommonConfigurationKeysPublic}} is {{InterfaceAudience.public}}.  Perhaps this should be rephrased.

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