hadoop-hdfs-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Colin Patrick McCabe (JIRA)" <j...@apache.org>
Subject [jira] [Created] (HDFS-3994) misleading comment in CommonConfigurationKeysPublic
Date Mon, 01 Oct 2012 19:03:08 GMT
Colin Patrick McCabe created HDFS-3994:
------------------------------------------

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

Mime
View raw message