Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Publish an API change report as part of the documentation

Description

These reports can be generated via JDiff or clirr. See also HV-417.

Environment

None

Activity

Show:

Hardy FerentschikApril 4, 2012 at 4:10 PM

Hardy FerentschikJanuary 19, 2011 at 12:57 PM

I think my main concern is that the report is very verbose and creates the impression that more has changed as actually did. For example we pushed some methods which where basically duplicates in all subclasses into the base class. In the report all these methods are reported removed (which they technically are), but this is not really important for the end user.

Matt DoarJanuary 18, 2011 at 6:51 PM

What does a compatibility centered report look like? JDiff takes two sets of source, generates one XML file for each set and then uses the two XML files to generate the report. Version control is only used to check out the source. I guess there is a maven plugin that does this for svn?

Hardy FerentschikJanuary 18, 2011 at 2:11 PM

There seems hardly any activity around the JDiff maven plugin and it supports afaics only svn.
Personally I would prefer a compatibility centered report. Let's investigate how a clirr report would look like in our case.

Won't Fix

Details

Assignee

Reporter

Participants

Hardy Ferentschik
Matt Doar

Components

Affects versions

Priority

Created January 18, 2011 at 2:02 PM
Updated April 4, 2012 at 4:10 PM
Resolved April 4, 2012 at 4:10 PM

Flag notifications