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 "Owen O'Malley (JIRA)" <ji...@apache.org> on 2008/06/11 18:08:45 UTC
[jira] Created: (HADOOP-3532) Create build targets to create api
change reports using jdiff
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.
[jira] Commented: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Doug Cutting (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12635015#action_12635015 ]
Doug Cutting commented on HADOOP-3532:
--------------------------------------
Owen submitted the patch, but no release has yet been made containing it:
http://sourceforge.net/tracker/index.php?func=detail&aid=1990278&group_id=37160&atid=419052
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.
[jira] Updated: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Owen O'Malley updated HADOOP-3532:
----------------------------------
Status: Patch Available (was: Open)
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.
[jira] Commented: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
[ 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.
[jira] Updated: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Owen O'Malley updated HADOOP-3532:
----------------------------------
Attachment: jdiff.patch
Here is a patch that contains both the build.xml change and the generated api baseline for 0.17.0. We should create a new baseline for each release as part of the release process. (So once we release 0.17.1, we should generate the baseline, check it in and point jdiff.stable at 0.17.1.)
There are two new targets. The first is api-xml that generates the xml file for the contents of the work directory. The second is api-report that generates the difference bet the api-xml and the stable api xml, which defaults to the last release.
One caveat is that you need a patch that I made to jdiff to correctly process hadoop. I'll also upload the fixed jdiff that I used.
> 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
>
> Attachments: jdiff.patch
>
>
> 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.
[jira] Updated: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Mukund Madhugiri (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mukund Madhugiri updated HADOOP-3532:
-------------------------------------
Hadoop Flags: [Reviewed]
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.
[jira] Updated: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Owen O'Malley updated HADOOP-3532:
----------------------------------
Resolution: Fixed
Status: Resolved (was: Patch Available)
I just committed this.
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.
[jira] Commented: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12635168#action_12635168 ]
Owen O'Malley commented on HADOOP-3532:
---------------------------------------
My patch basically quotes xml special characters in type names. In particular, we get burned by "&" in a generic parameter.
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.
[jira] Commented: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12606653#action_12606653 ]
Hadoop QA commented on HADOOP-3532:
-----------------------------------
-1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12384347/jdiff-1.1.0-oom.zip
against trunk revision 669790.
+1 @author. The patch does not contain any @author tags.
-1 tests included. The patch doesn't appear to include any new or modified tests.
Please justify why no tests are needed for this patch.
-1 patch. The patch command could not apply the patch.
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/2704/console
This message is automatically generated.
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.
[jira] Commented: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Patrick Hunt (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12634990#action_12634990 ]
Patrick Hunt commented on HADOOP-3532:
--------------------------------------
Owen, can you explain the patch that you made to jdiff? If I wanted to used jdiff for ZooKeeper project would the same patch be necessary?
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.
[jira] Updated: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Owen O'Malley updated HADOOP-3532:
----------------------------------
Attachment: jdiff-1.1.0-oom.zip
Jdiff is GPL, so this can't be included in Hadoop, unfortunately...
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.
[jira] Commented: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Doug Cutting (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12604285#action_12604285 ]
Doug Cutting commented on HADOOP-3532:
--------------------------------------
> Hadoop_${version}.xml
Perhaps use "hadoop-${version}" to better match jar and release names?
The updates to http://wiki.apache.org/hadoop/HowToRelease might also be drafted in this issue. My guess is that, after the release vote has passed, the release master should generate a new version of this file, from the new release, and commit it to the release branch, to trunk, and to any higher-numbered release branches. Does that sound right?
> 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.
[jira] Commented: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Hudson (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12609568#action_12609568 ]
Hudson commented on HADOOP-3532:
--------------------------------
Integrated in Hadoop-trunk #535 (See [http://hudson.zones.apache.org/hudson/job/Hadoop-trunk/535/])
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.
[jira] Commented: (HADOOP-3532) Create build targets to create api
change reports using jdiff
Posted by "Mukund Madhugiri (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-3532?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12607693#action_12607693 ]
Mukund Madhugiri commented on HADOOP-3532:
------------------------------------------
+1. Patch looks good
> 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
>
> Attachments: jdiff-1.1.0-oom.zip, jdiff.patch
>
>
> 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.