Return-Path: X-Original-To: apmail-hadoop-hdfs-dev-archive@minotaur.apache.org Delivered-To: apmail-hadoop-hdfs-dev-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4786B10934 for ; Wed, 17 Jul 2013 17:42:02 +0000 (UTC) Received: (qmail 59122 invoked by uid 500); 17 Jul 2013 17:41:57 -0000 Delivered-To: apmail-hadoop-hdfs-dev-archive@hadoop.apache.org Received: (qmail 57468 invoked by uid 500); 17 Jul 2013 17:41:51 -0000 Mailing-List: contact hdfs-dev-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: hdfs-dev@hadoop.apache.org Delivered-To: mailing list hdfs-dev@hadoop.apache.org Received: (qmail 56892 invoked by uid 99); 17 Jul 2013 17:41:48 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 17 Jul 2013 17:41:48 +0000 Date: Wed, 17 Jul 2013 17:41:48 +0000 (UTC) From: "Colin Patrick McCabe (JIRA)" To: hdfs-dev@hadoop.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Resolved] (HDFS-3994) misleading comment in CommonConfigurationKeysPublic MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/HDFS-3994?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Colin Patrick McCabe resolved HDFS-3994. ---------------------------------------- Resolution: Won't Fix I looked at this again, and I think the intention is just that you use {{CommonConfigurationKeys}} throughout your code, since that inherits a bunch of constants from {{CommonConfigurationKeysPublic}} > 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