[
https://issues.apache.org/jira/browse/HADOOP-6756?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12876461#action_12876461
]
Erik Steffl commented on HADOOP-6756:
-------------------------------------
Re
https://issues.apache.org/jira/browse/HADOOP-6756?focusedCommentId=12875770&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#action_12875770
1, 2: some fields do not have reasonable defaults therefore are commented out
and are without default values (I was told that empty values are not handled
well by Configuration), if you can think of reasonable defaults for these
please let me know
3: will fix
4: reasonable, will do
5: Let's discuss off-line and come up with something that makes sense, it's my
best guess from looking at code
6: This is a bit tricky, there's core-default.html which is built by ant docs
(not ant javadocs) and resulting core-default.html is outside of javadoc
docRoot. It can be referred to using "{...@docroot}/../core-default.html" (note
the parent directory of docRoot). This makes the end result ok for now but it's
dangerous because it makes javadoc docs rely on docs built outside of javadoc.
7: This comment was there before, thought it's out of scope for this bug, i.e.
I am trying to document existing variables, not decide which ones are used or
not etc.
> 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.
