Uploaded image for project: 'Hadoop HDFS'
  1. Hadoop HDFS
  2. HDFS-3994

misleading comment in CommonConfigurationKeysPublic

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Won't Fix
    • Affects Version/s: 2.0.3-alpha
    • Fix Version/s: None
    • Component/s: hdfs-client
    • Labels:
      None

      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.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              cmccabe Colin McCabe
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: