hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Konstantin Shvachko (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HADOOP-6756) Clean up and add documentation for configuration keys in CommonConfigurationKeys.java
Date Fri, 04 Jun 2010 21:53:03 GMT

    [ 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.


Mime
View raw message