Update of /cvsroot/clirr/clirr/xdocs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2365/xdocs
Modified Files:
anttask.xml changes.xml index.xml
Log Message:
allow differentiating between src and binary compatibility problems
Index: anttask.xml
===================================================================
RCS file: /cvsroot/clirr/clirr/xdocs/anttask.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- anttask.xml 2 Jun 2004 07:53:31 -0000 1.6
+++ anttask.xml 27 Jun 2004 14:21:43 -0000 1.7
@@ -61,14 +61,30 @@
<td>Default</td>
</tr>
<tr>
- <td>failOnWarning</td>
- <td>Whether task execution should fail (break the build) on warnings</td>
+ <td>failOnBinWarning</td>
+ <td>Whether task execution should fail (break the build) on warnings
+ about binary compatibility issues</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
- <td>failOnError</td>
- <td>Whether task execution should fail (break the build) on errors</td>
+ <td>failOnBinError</td>
+ <td>Whether task execution should fail (break the build) on binary
+ compatibility errors</td>
+ <td>No</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>failOnSrcWarning</td>
+ <td>Whether task execution should fail (break the build) on warnings
+ about source code compatibility issues</td>
+ <td>No</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>failOnSrcError</td>
+ <td>Whether task execution should fail (break the build) on source
+ compatibility errors</td>
<td>No</td>
<td>Yes</td>
</tr>
Index: changes.xml
===================================================================
RCS file: /cvsroot/clirr/clirr/xdocs/changes.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- changes.xml 21 Jun 2004 10:07:10 -0000 1.13
+++ changes.xml 27 Jun 2004 14:21:43 -0000 1.14
@@ -42,6 +42,11 @@
which has no public or protected constructors, as it was always
impossible to derive subclasses from it anyway.
</action>
+ <action dev="lkuehne" type="add">
+ Clirr now analyses code changes for source code compatibility problems as well.
+ Note: Ant task attribute names and the output format of the XML formatter
+ have changed to support this feature.
+ </action>
</release>
<release version="0.3" date="2004-05-23">
Index: index.xml
===================================================================
RCS file: /cvsroot/clirr/clirr/xdocs/index.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- index.xml 20 May 2004 13:28:02 -0000 1.5
+++ index.xml 27 Jun 2004 14:21:43 -0000 1.6
@@ -9,12 +9,12 @@
<body>
<section name="What is it?">
<p>
-Clirr is a tool that checks Java libraries for binary compatibility
+Clirr is a tool that checks Java libraries for binary and source compatibility
with older releases. Basically you give it two
sets of jar files and Clirr dumps out a list of changes in the public api.
The Clirr Ant task can be configured to break the build if it detects
incompatible api changes. In a continuous integration process Clirr can
-automatically prevent accidental introduction of binary compatibility
+automatically prevent accidental introduction of binary or source compatibility
problems.
</p>
</section>
@@ -40,7 +40,8 @@
<section name="Features">
<ul>
- <li>Report all binary API changes (currently only partially implemented)</li>
+ <li>Report all API changes (currently only partially implemented)</li>
+ <li>Evaluate each change wrt. binary and source compatibility</li>
<li>support plain text and XML reports</li>
<li>Flexible failure handling (warnings vs. errors, break the build or set error property)</li>
</ul>
|
