[
https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12604264#action_12604264
]
Owen O'Malley commented on HADOOP-3532:
---------------------------------------
Jdiff, which unfortunately is LGPL, is a JavaDoc doclet that compares two
versions of a software package and generates an html report of the differences.
This is very useful for finding accidental API changes that have slipped in
between versions. It works in two passes, first you generate an xml summary of
each version and then you run the compare. I plan to generate and check in
versions of the api summary for hadoop into:
{code}
$HADOOP_HOME/doc/jdiff/Hadoop_${version}.xml
{code}
Originally, I'd put in 0.17.0 (and 0.17.1 and 0.18.0, if they are released). To
generate a report, the user would:
{code}
ant api-report
{code}
to compare the current working directory against the latest stable release. To
pick a different stable version, they would do:
{code}
ant -Djdiff.stable=0.17.0 api-report
{code}
to compare to 0.17.0. Building and checking in the api summary for the new
release should become part of the release procedure. We should probably also
generate the report and include it in the documentation for each release.
> Create build targets to create api change reports using jdiff
> -------------------------------------------------------------
>
> Key: HADOOP-3532
> URL: https://issues.apache.org/jira/browse/HADOOP-3532
> Project: Hadoop Core
> Issue Type: Improvement
> Components: build
> Reporter: Owen O'Malley
> Assignee: Owen O'Malley
> Fix For: 0.18.0
>
>
> I'd like to add support for jdiff to our build scripts, to enable generating
> api difference reports between versions.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
