[Clirr-devel] CVS: clirr/maven/xdocs using.xml,1.1,1.2
Status: Alpha
Brought to you by:
lkuehne
From: <lk...@us...> - 2004-08-22 11:51:00
|
Update of /cvsroot/clirr/clirr/maven/xdocs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv28685/maven/xdocs Modified Files: using.xml Log Message: real content Index: using.xml =================================================================== RCS file: /cvsroot/clirr/clirr/maven/xdocs/using.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- using.xml 15 Jul 2004 13:34:22 -0000 1.1 +++ using.xml 22 Aug 2004 11:50:43 -0000 1.2 @@ -10,7 +10,20 @@ <section name="Using the Clirr plugin"> <ol> <li> - xxx + Make sure you have the Clirr plugin <a href="installing.html">installed</a>. + </li> + <li> + Make sure you have the old versions of your project + <a href="http://maven.apache.org/reference/project-descriptor.html#versions">declared</a> + in your POM. The versions should be declared from oldest to youngest. + Clirr will check the current code against the latest released version, ingnoring + the current development version (version control tag 'HEAD'). + <!-- TODO: docs for checking against a specific version --> + </li> + <li> + Type "maven clirr". This will create an XML file that contains all changes + in your public API. For each change, the file includes Clirr's compatibility + analysis. </li> </ol> </section> |