[
https://issues.apache.org/jira/browse/TEZ-2294?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14717792#comment-14717792
]
Hitesh Shah commented on TEZ-2294:
----------------------------------
bq. Will this be published on the website along with the release.
The files would be generated as part of mvn site so they can published as part
of the release process. No need to commit any generated files into the source
repo though. template file also part of javadocs and linked in next patch.
bq. It looks like this is analyzing all classes for an annotation
Fixed to add reporting sections only for tez-api and tez-runtime-library
bq. Double/float, int/long - differentiate between these ?
Fixed in next patch.
bq. Can the type be inferred from the default value, when it exists.
It can be somewhat. Added some code for it but not used for now. Will file a
follow-up jira.
bq. Documentation on how to generate these files would be useful (outside of
mvn site)
Not yet documented - may publish steps to wiki. General gist is below.
{code}
$export CLASSPATH ... // needs tez-* jars as well as hadoop-annotations.jar
$javadoc -docletpath
/Library/Java/JavaVirtualMachines/jdk1.7.0_55.jdk/Contents/Home/lib/tools.jar
-doclet org.apache.tez.tools.javadoc.doclet.ConfigStandardDoclet
tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/*.java
{code}
bq. An empty index.html ends up getting generated in apidocs/config, which can
be confusing.
Generated by the doclet. Haven't figured out how to get rid of it yet.
bq. @see <a href="../../../../../..
This creates a correct link from the original TezConfiguration class javadoc to
the generated html version.
bq. TEZ_AM_RESOURCE_CPU_VCORES
Fixed in next patch.
bq. TezRuntimeConfiguration
Fixed in next patch.
bq. Nits: Space between lines on the generated XML template.
Assuming this means a line between each property section then fixed. If not,
then please clarify.
bq. Has references like TEZ_SITE_XML, ENDS_WITH
Required for handling _DEFAULT mostly. Will file a follow up to clean it up if
it is an issue.
bq. Some commented out code
Removed.
bq. The XML generator likely needs some escaping.
Fixed in latest patch.
> Add tez-site-template.xml with description of config properties
> ---------------------------------------------------------------
>
> Key: TEZ-2294
> URL: https://issues.apache.org/jira/browse/TEZ-2294
> Project: Apache Tez
> Issue Type: Improvement
> Reporter: Rajesh Balamohan
> Assignee: Hitesh Shah
> Attachments: TEZ-2294.4.patch, TEZ-2294.5.patch, TEZ-2294.6.patch,
> TEZ-2294.7.patch, TEZ-2294.wip.2.patch, TEZ-2294.wip.3.patch,
> TEZ-2294.wip.patch, TezConfiguration.html, TezRuntimeConfiguration.html,
> tez-default-template.xml, tez-runtime-default-template.xml
>
>
> Document all tez configs with descriptions and default values.
> Also, document MR configs that can be easily translated to Tez configs via
> Tez helpers.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
