[LUCENE-1083] JDiff report of changes between different versions of Lucene

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 2.2
• Component/s: general/javadocs
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Matt Doar
• Created: 06/Dec/07 20:16
• Updated: 28/Aug/22 11:43

Description

I think that a helpful addition to the release process for Lucene would be JDiff reports of the API changes between different versions. I am attaching reports of the differences between 1.9.1 and 2.2.0 and also between 2.1.0 and 2.2.0. The reports could be changed to only show the public methods. The start page is changes.html.

This is the Ant target I added to the top-level build.xml file in the JDiff directory to produce a report:

<target name="lucene" depends="dist">
  <taskdef name="jdiff" 
           classname="jdiff.JDiffAntTask" 
           classpath="${dist.dir}/antjdiff.jar" />
  <jdiff destdir="${reports.dir}/lucene" 
         verbose="on"
         stats="on"
         docchanges="on">
    <old name="1.9.1">
      <dirset dir="${examples.dir}/lucene-1.9.1/src/java" includes="org/**" />
    </old>
    <new name="2.2.0">
      <dirset dir="${examples.dir}/lucene-2.2.0/src/java" includes="org/**" />
    </new>
  </jdiff>
</target>

Disclaimer: I'm the author of JDiff