[HDFS-3994] misleading comment in CommonConfigurationKeysPublic

• Type: Bug
• Status: Resolved
• Priority: Trivial
• Resolution: Won't Fix
• Affects Version/s: 2.0.3-alpha
• Component/s: hdfs-client
• Target Version/s: 2.0.3-alpha
• Assignee: Unassigned
• Reporter: Colin McCabe
• Created: 01/Oct/12 19:02
• Updated: 17/Jul/13 17:40
• Resolved: 17/Jul/13 17:40

Description

CommonConfigurationKeysPublic contains a potentially misleading comment:

/** 
 * 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)
 */

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.