Mike Kienenberger schrieb:
On Fri, Oct 24, 2008 at 5:27 AM, Simon Kitching [EMAIL PROTECTED] wrote:
The latest maven-clirr-report plugin unfortunately crashes on orchestra, but
I have created a report using clirr trunk; please see here:
http://people.apache.org/~skitching/orchestra-core-1.3/clirr-orchestra-1.2-to-1.3.txt
I took a look at this since I wasn't sure what it was. I'm guessing
it's some kind of api changelog report. Unfortunately, it's in
German (at least, that's my guess).
Yes it is German. I've been here in Austria too long :-)
Clirr (clirr.sourceforge.net) is a wonderful tool that compares two
jarfiles and displays the API differences between them. This report
therefore shows what API changes have occurred between orchestra 1.2 and
the 1.3 release candidate. This report can then be used to
(a) look for accidental binary incompatibilities
(b) ensure documentation exists for deliberate incompatibilities
(c) ensure that classes or methods added since the previous release are
all marked with @since
Normally running the report is easy; just configure it as a maven
report. However as I mentioned, the maven plugin crashes; there is
something in orchestra that triggers a bug which is fixed in trunk but
not in a plugin release. So I ran this manually (in a german locale).
Rather than run the report again, here's a quick translation guide:
wurde hinzugefügt == was added
wurde als deprecated markiert == marked as deprecated
wurde entfernt == was removed
Sichtbarkeit der Methode == visibility of method
Anything marked as ERROR is a binary incompatibility. Actually there is one
case that *is* an incompatibility that clirr has only
rated as INFO: a method was promoted from protected to public. This technically
can break subclasses that override the method
and declare the overriding version as protected.
So if you feel enthusiastic, and want to check that the two binary
incompatibilities are documented in the release notes,
and that all the added methods have an appropriate @since annotation that would
be great. But I have already done that..
I included the report in the release info just to point out that this task has
been done.
Regards,
Simon
--
-- Emails in mixed posting style will be ignored
-- (http://en.wikipedia.org/wiki/Posting_style)