mirror of
https://github.com/spring-projects/spring-framework.git
synced 2026-05-03 04:19:47 +01:00
Chris Beams
631f24bb32
The new jdiff task generates a report of API differences between the current version (i.e. the value of `version` in gradle.properties) and any older version of the framework, as specified by -DOLD_VERSION at the command line, or defaulting to `previousVersion` in gradle.properties. Running the command requires a separate clone directory pinned to the desired old version, as specified by -DOLD_VERSION_ROOT at the command line. This creates challenges from a build automation perspective, largely because Gradle doesn't (yet) have APIs for working with Git. This task may be further automated and included in nightly CI runs, but in the meantime, a number of reports back to 3.1.3.RELEASE have been generated manually and uploaded to [1], where one can now find the following entries in the directory listing: - 3.1.3.RELEASE_to_3.2.0.RC1 - 3.2.0.M1_to_3.2.0.M2 - 3.2.0.M2_to_3.2.0.RC1 - 3.2.0.RC1_to_3.2.0.BUILD-SNAPSHOT Ideally, the final entry there would be kept up-to-date on a daily basis - again we may revisit doing so in the future. Going forward, reports will be generated and uploaded manually on an as needed basis and as part of the release process. The goal of these reports are as follows: - to ease the process of ensuring backward compatibility - to aid in code reviews, particularly when reviewing large pull requests - to ease the process of creating migration guides for project maintainers, i.e. to help us remember what's changed - to allow ambitious end-users to discover what's been changing at the API level without without needing to wait for detailed "what's new in version X" and/or migration guide documentation See documentation in jdiff.gradle for usage details. Note that the jdiff-1.1.1 distribution as downloaded from [2] has been added wholesale to the source tree under gradle/jdiff instead of uploading JDiff jars to repo.springsource.org as we would normally do. This is due to some unfortunate limitations in the implementation of the jdiff ant task that require a phisical JDIFF_HOME directory. Checking in the jars and various resources represents the simplest and most pragmatic solution to this problem, though ambitious contributors are free to do what's necessary to arrive at a more elegant arrangement. [1]: http://static.springframework.org/spring-framework/docs [2]: http://sourceforge.net/projects/javadiff/files/latest/download Issue: SPR-9957
60 lines
1.9 KiB
Plaintext
60 lines
1.9 KiB
Plaintext
|
|
JDiff Doclet
|
|
------------
|
|
|
|
Matthew Doar
|
|
mdoar@pobox.com
|
|
|
|
|
|
The JDiff doclet is used to generate a report describing the
|
|
difference between two public Java APIs.
|
|
|
|
The file jdiff.html contains the reference page for JDiff. The latest
|
|
version of JDiff can be downloaded at:
|
|
http://sourceforge.net/projects/javadiff
|
|
|
|
To use the Ant task on your own project, see example.xml. More examples
|
|
of using JDiff to compare the public APIs of J2SE1.3 and J2SE1.4 can
|
|
be seen at http://www.jdiff.org
|
|
|
|
For an example with the source distribution, run "ant" and
|
|
look at the HTML output in ./build/reports/example/changes.html
|
|
The page at ./build/reports/example/changes/com.acme.sp.SPImpl.html
|
|
shows what a typical page of changes looks like.
|
|
|
|
System Requirements
|
|
-------------------
|
|
|
|
JDiff has been tested with all releases of Java since J2SE1.2 but
|
|
releases of JDiff after 1.10.0 focus on JDK1.5.
|
|
|
|
License
|
|
-------
|
|
|
|
JDiff is licensed under the Lesser GNU General Public License (LGPL).
|
|
See the file LICENSE.txt.
|
|
|
|
Acknowledgements
|
|
----------------
|
|
|
|
JDiff uses Stuart D. Gathman's Java translation of Gene Myers' O(ND)
|
|
difference algorithm.
|
|
|
|
JDiff uses Xerces 1.4.2 from http://www.apache.org.
|
|
|
|
JDiff also includes a script to use the classdoc application from
|
|
http://classdoc.sourceforge.net or http://www.jensgulden.de, by Jens
|
|
Gulden, (mail@jensgulden.de), to call a doclet such as jdiff on a .jar
|
|
file rather than on source.
|
|
|
|
Many thanks to the reviewers at Sun and Vitria who gave feedback on early
|
|
versions of JDiff output, and also to the distillers of Laphroaig, and to
|
|
Arturo Fuente for his consistently fine cigars which helped inspire
|
|
much of this work.
|
|
|
|
|
|
Footnote:
|
|
|
|
If you are looking for a generalized diff tool for XML, try diffmk from
|
|
http://wwws.sun.com/software/xml/developers/diffmk/
|