You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-dev@hadoop.apache.org by "Arun C Murthy (JIRA)" <ji...@apache.org> on 2007/10/30 06:28:50 UTC

[jira] Created: (HADOOP-2122) Document config parameters for each Map-Reduce class/interface

Document config parameters for each Map-Reduce class/interface
--------------------------------------------------------------

                 Key: HADOOP-2122
                 URL: https://issues.apache.org/jira/browse/HADOOP-2122
             Project: Hadoop
          Issue Type: Improvement
          Components: documentation
            Reporter: Arun C Murthy


I propose we add a table in the javadoc for each user-facing Map-Reduce interface/class which lists, and provides details, of each and every config parameter which has any bearing on that interface/class. Clearly some parameters affect more than one place and they should be put in more than one table.

For e.g. 
Mapper -> io.sort.mb, io.sort.factor
Reducer -> fs.inmemory.size.mb
...
etc.

It would very nice to explain how it interacts with the framework and rest of config params etc.

Thoughts?

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

[jira] Commented: (HADOOP-2122) Document config parameters for each Map-Reduce class/interface

Posted by "Arun C Murthy (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-2122?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12538680 ] 

Arun C Murthy commented on HADOOP-2122:
---------------------------------------

Good point!

We should use this jira to add a {{ConfiguredBy}} attribute in any case, even if we can't generate the table for the javadoc.

> Document config parameters for each Map-Reduce class/interface
> --------------------------------------------------------------
>
>                 Key: HADOOP-2122
>                 URL: https://issues.apache.org/jira/browse/HADOOP-2122
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Arun C Murthy
>
> I propose we add a table in the javadoc for each user-facing Map-Reduce interface/class which lists, and provides details, of each and every config parameter which has any bearing on that interface/class. Clearly some parameters affect more than one place and they should be put in more than one table.
> For e.g. 
> Mapper -> io.sort.mb, io.sort.factor
> Reducer -> fs.inmemory.size.mb
> ...
> etc.
> It would very nice to explain how it interacts with the framework and rest of config params etc.
> Thoughts?

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

[jira] Commented: (HADOOP-2122) Document config parameters for each Map-Reduce class/interface

Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-2122?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12538679 ] 

Owen O'Malley commented on HADOOP-2122:
---------------------------------------

I'd suggest figuring out if we could use attributes like @ConfiguredBy(...) to generate the table for javadoc.

> Document config parameters for each Map-Reduce class/interface
> --------------------------------------------------------------
>
>                 Key: HADOOP-2122
>                 URL: https://issues.apache.org/jira/browse/HADOOP-2122
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Arun C Murthy
>
> I propose we add a table in the javadoc for each user-facing Map-Reduce interface/class which lists, and provides details, of each and every config parameter which has any bearing on that interface/class. Clearly some parameters affect more than one place and they should be put in more than one table.
> For e.g. 
> Mapper -> io.sort.mb, io.sort.factor
> Reducer -> fs.inmemory.size.mb
> ...
> etc.
> It would very nice to explain how it interacts with the framework and rest of config params etc.
> Thoughts?

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

[jira] Commented: (HADOOP-2122) Document config parameters for each Map-Reduce class/interface

Posted by "Nigel Daley (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-2122?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12538804 ] 

Nigel Daley commented on HADOOP-2122:
-------------------------------------

+1 to this Jira.  It would be good to include these attributes as well for each parameter:
* the legal values
* the default value if it's unset
* the behaviour if the value is illegal (is the default taken or an exception thrown or ?)

> Document config parameters for each Map-Reduce class/interface
> --------------------------------------------------------------
>
>                 Key: HADOOP-2122
>                 URL: https://issues.apache.org/jira/browse/HADOOP-2122
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Arun C Murthy
>
> I propose we add a table in the javadoc for each user-facing Map-Reduce interface/class which lists, and provides details, of each and every config parameter which has any bearing on that interface/class. Clearly some parameters affect more than one place and they should be put in more than one table.
> For e.g. 
> Mapper -> io.sort.mb, io.sort.factor
> Reducer -> fs.inmemory.size.mb
> ...
> etc.
> It would very nice to explain how it interacts with the framework and rest of config params etc.
> Thoughts?

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