Return-Path: 
 <common-issues-return-8838-apmail-hadoop-common-issues-archive=hadoop.apache.org@hadoop.apache.org>
Delivered-To: apmail-hadoop-common-issues-archive@minotaur.apache.org
Received: (qmail 65796 invoked from network); 4 Jun 2010 21:53:28 -0000
Received: from unknown (HELO mail.apache.org) (140.211.11.3)
  by 140.211.11.9 with SMTP; 4 Jun 2010 21:53:28 -0000
Received: (qmail 53731 invoked by uid 500); 4 Jun 2010 21:53:28 -0000
Delivered-To: apmail-hadoop-common-issues-archive@hadoop.apache.org
Received: (qmail 53689 invoked by uid 500); 4 Jun 2010 21:53:28 -0000
Mailing-List: contact common-issues-help@hadoop.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:common-issues-help@hadoop.apache.org>
List-Unsubscribe: <mailto:common-issues-unsubscribe@hadoop.apache.org>
List-Post: <mailto:common-issues@hadoop.apache.org>
List-Id: <common-issues.hadoop.apache.org>
Reply-To: common-issues@hadoop.apache.org
Delivered-To: mailing list common-issues@hadoop.apache.org
Received: (qmail 53681 invoked by uid 99); 4 Jun 2010 21:53:28 -0000
Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230)
    by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 04 Jun 2010 21:53:28 +0000
X-ASF-Spam-Status: No, hits=-2000.0 required=10.0
	tests=ALL_TRUSTED
X-Spam-Check-By: apache.org
Received: from [140.211.11.22] (HELO thor.apache.org) (140.211.11.22)
    by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 04 Jun 2010 21:53:25 +0000
Received: from thor (localhost [127.0.0.1])
	by thor.apache.org (8.13.8+Sun/8.13.8) with ESMTP id o54Lr3vt017263
	for <common-issues@hadoop.apache.org>; Fri, 4 Jun 2010 21:53:04 GMT
Message-ID: <11010584.190441275688383694.JavaMail.jira@thor>
Date: Fri, 4 Jun 2010 17:53:03 -0400 (EDT)
From: "Konstantin Shvachko (JIRA)" <jira@apache.org>
To: common-issues@hadoop.apache.org
Subject: [jira] Commented: (HADOOP-6756) Clean up and add documentation for
 configuration keys in CommonConfigurationKeys.java
In-Reply-To: <23380183.20521273191468124.JavaMail.jira@thor>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394
X-Virus-Checked: Checked by ClamAV on apache.org


    [ https://issues.apache.org/jira/browse/HADOOP-6756?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12875770#action_12875770 ] 

Konstantin Shvachko commented on HADOOP-6756:
---------------------------------------------

# In core-default.xml some new fields have been introduce without default values.
The default values should be there in order to define the default behavior and also as an example.
# Some fields new fields in core-default.xml are commented out. What does that mean?
If they are hidden (undocumented) variables, then they should not be core-default.xml,
if they are public, then they should not be commented out and have a reasonable default value.
# {{hadoop.security.group.mapping}} is listed twice in core-default.xml. 
Remove the one with empty value, and merge the descriptions.
# I think it makes sense to introduce the security section in core-default.xml and group all security fields under it:
{code}
 <!--- security properties -->
<property>
  <name>hadoop.security.group.mapping</name>
...
{code}
# I did not understand the description of {{io.map.index.interval}}.
# In CommonConfigurationKeysPublic I am not sure where "See src/core/core-default.xml" should lead to.
I'd propose to use something like this:
{code}
/** See  <a href="{@docRoot}/common-default.xml">common-default.xml</a> */
{code}
# The comment in CommonConfigurationKeys
{code}
//TBD: Code is not updated to use following keys.
//These keys will be used in later versions
{code}
should be investigated in terms of which variables it is referred to.
In the least it is misplaced, because {{FS_AUTOMATIC_CLOSE_KEY}} and {{FS_FTP_HOST_KEY}} are definitely used.
If it is a legacy artifact, then let's remove it.


> Clean up and add documentation for configuration keys in CommonConfigurationKeys.java
> -------------------------------------------------------------------------------------
>
>                 Key: HADOOP-6756
>                 URL: https://issues.apache.org/jira/browse/HADOOP-6756
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: fs
>    Affects Versions: 0.20.3, 0.22.0
>            Reporter: Erik Steffl
>             Fix For: 0.20.3, 0.22.0
>
>         Attachments: HADOOP-6756-0.22.0.patch, jira.HADOOP-6756-0.20-1-FS_DEFAULT_NAME_KEY.patch, jira.HADOOP-6756-0.20-1.patch, jira.HADOOP-6756-0.20.patch
>
>
> Configuration keys in CommonConfigurationKeys.java should be cleaned up and documented (javadoc comments, appropriate *-default.xml descriptions).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.