[
https://issues.apache.org/jira/browse/TEZ-2294?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14701821#comment-14701821
]
Siddharth Seth commented on TEZ-2294:
-------------------------------------
Couple of general questions.
- Will this be published on the website along with the release. Should the
template file be generated and checked into the repository ?
- It looks like this is analyzing all classes for an annotation, and then
generating appropriate files. It may be simpler to generate the annotations for
specific files (TezConfiguration and TezRuntimeConfiguration) for now. Another
side affect of scanning all files is the creation of the apidocs/config
directory in all modules - even though no config files exist.
- Double/float, int/long - differentiate between these ?
- Can the type be inferred from the default value, when it exists.
- Documentation on how to generate these files would be useful (outside of mvn
site)
Specifics
- An empty index.html ends up getting generated in apidocs/config, which can be
confusing.
- {code} * @see <a
href="../../../../../../configs/TezRuntimeConfiguration.html">Detailed
Configuration Information</a>{code} Not sure what this will end up referring
to, and where.
- TEZ_AM_RESOURCE_CPU_VCORES - type is string instead of integer.
- TezRuntimeConfiguration has no type information.
- Nits: Space between lines on the generated XML template.
- The XML generator likely needs some escaping. It generated invalid XML at the
moment for TezConfiguration (&&)
ConfigStandardDoclet - Has references like TEZ_SITE_XML, ENDS_WITH,
TEZ_AM_STAGING_DIR. If using the ConfigurationProperty annotation, can all of
these special cases be skipped ? Alternately, skip using ConfigurationProperty
altogether.
- Some commented out code in HtmlWriter and XmlWriter
> 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)
