[Clirr-devel] CVS: clirr/core/xdocs anttask.xml,1.2,1.3 changes.xml,1.3,1.4
Status: Alpha
Brought to you by:
lkuehne
Menu
▾
▴
[Clirr-devel] CVS: clirr/core/xdocs anttask.xml,1.2,1.3 changes.xml,1.3,1.4
|
From: <lk...@us...> - 2005-03-06 17:01:48
|
Update of /cvsroot/clirr/clirr/core/xdocs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19003/xdocs Modified Files: anttask.xml changes.xml Log Message: The Ant task now allows to exclude classes from compatibility checks via the 'apiclasses' subelement. Index: anttask.xml =================================================================== RCS file: /cvsroot/clirr/clirr/core/xdocs/anttask.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- anttask.xml 11 Jul 2004 12:19:12 -0000 1.2 +++ anttask.xml 6 Mar 2005 17:01:36 -0000 1.3 @@ -107,7 +107,7 @@ <p> Clirr works with FileSets instead of individual jar files to allow splitting up or combining library distributions. An example is log4j, - presumably the 1.3.0 release will split up the earlier log4j.jar + presumably the 1.3.0 release will split up the earlier log4j.jar into several jar files. </p> </section> @@ -184,5 +184,40 @@ If no formatter is specified, Clirr will write it's findings to stdout in plain format. </p> </section> + + <section name="apiclasses"> + + <p> + A + <a href="http://ant.apache.org/manual/CoreTypes/patternset.html">PatternSet</a> + that defines which classes form the API. By default all classes are included. + </p> + + <p> + The API is often only a subset from the set of public classes in a jar file. For example, + the Eclipse project has + <a href="http://www.eclipse.org/articles/Article-API%20use/eclipse-api-usage-rules.html">package + naming conventions</a> that signal which classes must not + be used outside a module, even though they are technically public. + </p> + + <p> + Example: + </p> + + <source> + <clirr> + <origfiles dir="build/tmp" includes="${jar.baseline}"/> + <newfiles dir="build/lib" includes="${jar.buildresult}"/> + <apiclasses> + <exclude name="**/internal/**"/> + <exclude name="**/examples/**"/> + <exclude name="**/tests/**"/> + </apiclasses> + </clirr> + </source> + + </section> + </body> </document> Index: changes.xml =================================================================== RCS file: /cvsroot/clirr/clirr/core/xdocs/changes.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- changes.xml 5 Sep 2004 13:03:07 -0000 1.3 +++ changes.xml 6 Mar 2005 17:01:36 -0000 1.4 @@ -7,6 +7,13 @@ </properties> <body> + <release version="0.5-dev"> + <action dev="lkuehne" type="add" due-to="lkuehne"> + The Ant task now allows to exclude classes from compatibility checks + via the 'apiclasses' subelement. + </action> + </release> + <release version="0.4" date="2004-09-05"> <action dev="lkuehne" type="add" due-to="skitching"> Improved change messages if field accessibility is weakened/strengthened. @@ -52,7 +59,7 @@ </action> <action dev="s_kitching" type="fix"> Treat all changes in package and private items as being of INFO level - severity only, ie changes which would result in an ERROR being + severity only, ie changes which would result in an ERROR being reported if they were public or protected are reported with a severity of INFO if they are package or private. </action> |
