[ 
https://issues.apache.org/jira/browse/HADOOP-1307?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12492772
 ] 

Doug Cutting commented on HADOOP-1307:
--------------------------------------

We already auto-generate HTML documenting all parameters.

http://lucene.apache.org/hadoop/hadoop-default.html

This is linked to from the javadoc.  E.g.:

http://lucene.apache.org/hadoop/api/overview-summary.html#overview_description

This could be more attractively formatted, and we could perhaps divide things 
into different categories (client, server, user, expert, etc.), but I'd rather 
keep generating such documentation from XML source if possible, so that it 
stays in sync.

The stylesheet that generates this table is in conf/configuration.xsl.


> Documentation & classification of various configuration knobs
> -------------------------------------------------------------
>
>                 Key: HADOOP-1307
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1307
>             Project: Hadoop
>          Issue Type: Wish
>          Components: documentation
>            Reporter: Arun C Murthy
>
> Given the ever-increasing number of configuration knobs for both dfs and 
> mapred, it would be very useful in the long run to start and maintain 
> up-to-date information (on the hadoop-wiki?) for these. While we are at it, 
> it could be well worth the time to classify each as USER (must be overridden 
> by user e.g. mapred.input/output.dir), BEGINNER, INTERMEDIATE, EXPERT (see 
> HADOOP-1304) so as to clearly demarcate them.
> Thoughts?

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

Reply via email to