Update of /cvsroot/clirr/clirr/maven/xdocs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2426/maven/xdocs
Added Files:
installing.xml properties.xml using.xml changes.xml index.xml
navigation.xml goals.xml
Log Message:
First cut of a Maven plugin for Clirr
--- NEW FILE ---
<?xml version="1.0"?>
<document>
<properties>
<title>Installing the Maven Clirr plugin</title>
<author>Vincent Massol</author>
</properties>
<body>
<section name="Installing the Clirr plugin">
<p>
There are 2 options to install the Clirr plugin in an existing Maven
installation:
</p>
<ul>
<li>
<strong>Automatic install</strong>: Call
<code>maven plugin:download -DgroupId=clirr -DartifactId=clirr-maven -Dversion={version}</code>
where <code>{version}</code> is the version to use. Maven will
automatically download the plugin and install it, uninstalling any
other version you may already have.
</li>
<li>
<strong>Manual install</strong>:
<a href="http://www.ibiblio.org/maven/clirr/plugins/">Download</a>
the Clirr plugin jar and copy it in
<code>{MAVEN_HOME}/plugins</code> where <code>{MAVEN_HOME}</code> is
the location where you have installed Maven. Make sure you also
remove any previous Clirr plugin from
<code>{MAVEN_HOME}/plugins</code> and delete your
<code>{USER_HOME}/.maven/plugins</code> directory.
</li>
</ul>
</section>
</body>
</document>
--- NEW FILE ---
<?xml version="1.0" encoding="UTF-8"?>
<document>
<properties>
<title>Maven Clirr properties</title>
<author>Vincent Massol</author>
</properties>
<body>
<section name="Clirr plugin settings">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>xxx</td>
<td>xxx</td>
<td>
xxxx
</td>
</tr>
</table>
</section>
</body>
</document>
--- NEW FILE ---
<?xml version="1.0"?>
<document>
<properties>
<title>Using the Maven Clirr plugin</title>
<author>Vincent Massol</author>
</properties>
<body>
<section name="Using the Clirr plugin">
<ol>
<li>
xxx
</li>
</ol>
</section>
</body>
</document>
--- NEW FILE ---
<?xml version="1.0"?>
<document>
<properties>
<title>Plugin changes</title>
<author>Vincent Massol</author>
</properties>
<body>
<release version="0.4-SNAPSHOT" date="in CVS">
<action dev="vmassol" type="add">
Initial release. See the plugin's web page for the features
list.
</action>
</release>
</body>
</document>
--- NEW FILE ---
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Maven plugin for Clirr</title>
<author>Vincent Massol</author>
</properties>
<body>
<section name="What is it?">
<p>
The Maven plugin for Clirr allows easily running the Clirr
framework on Maven projects. It supports the following
features:
</p>
<ul>
<li>
Execution of Clirr framework on the current project.
</li>
<li>
Automatic download of project baseline jars with which the
current development source are compared with.
</li>
<li>
Automatically try to guess the latest release version of the
current project by looking at the POM's <code><version></code>
tag.
</li>
</ul>
</section>
</body>
</document>
--- NEW FILE ---
<?xml version="1.0"?>
<project name="Clirr Maven plugin">
<title>Clirr Maven plugin</title>
<body>
<links>
<item name="Clirr Framework"
href="http://clirr.sourceforge.net"/>
<item name="SourceForge Project Page"
href="http://sourceforge.net/projects/clirr"/>
<item name="Hosted by SourceForge"
href="http://sourceforge.net/"/>
</links>
<menu name="Clirr Maven plugin">
<item name="Overview" href="/index.html"/>
<item name="Installing" href="/installing.html"/>
<item name="Using" href="/using.html"/>
<item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
</menu>
<!-- footer will be placed above the (c) -->
<footer>
Hosted by <a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=89627&type=1" border="0" alt="sourceforge"/>
</a>
</footer>
</body>
</project>
--- NEW FILE ---
<?xml version="1.0" encoding="UTF-8"?>
<document>
<properties>
<title>Maven Clirr plugin goals</title>
<author>Vincent Massol</author>
</properties>
<body>
<goals>
<goal>
<name>clirr</name>
<description>
Default goal (does the same as <code>clirr:check</code>).
</description>
</goal>
<goal>
<name>clirr:check</name>
<description>
Run binary compatibility checks.
</description>
</goal>
</goals>
</body>
</document>
|
