vmassol 2003/05/31 00:00:35
Modified: src/plugins-build/checkstyle/xdocs navigation.xml index.xml
Added: src/plugins-build/checkstyle/xdocs migrating.xml
Log:
Added migration guide.
Revision Changes Path
1.3 +1 -0 maven/src/plugins-build/checkstyle/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/checkstyle/xdocs/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 19 Mar 2003 05:54:19 -0000 1.2
+++ navigation.xml 31 May 2003 07:00:35 -0000 1.3
@@ -11,6 +11,7 @@
<menu name="Overview">
<item name="Goals" href="/goals.html" />
<item name="Properties" href="/properties.html" />
+ <item name="Migrating" href="/migrating.html" />
</menu>
</body>
</project>
1.3 +7 -0 maven/src/plugins-build/checkstyle/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/checkstyle/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 30 May 2003 13:13:26 -0000 1.2
+++ index.xml 31 May 2003 07:00:35 -0000 1.3
@@ -21,6 +21,13 @@
<th>Description</th>
</tr>
<tr>
+ <td>31 May 2003</td>
+ <td>
+ New <a href="migrating.html">migration guide</a> to help migrate from
+ version 1.x to 2.x.
+ </td>
+ </tr>
+ <tr>
<td>30 May 2003</td>
<td>
New development version 2.0 created. First cut at supporting
1.1 maven/src/plugins-build/checkstyle/xdocs/migrating.xml
Index: migrating.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Migration guide</title>
<author email="[EMAIL PROTECTED]">Vincent Massol</author>
</properties>
<body>
<section name="Migrating from version 1.x to version 2.x">
<p>
The Checkstyle plugin version 1.x was using Checkstyle 2.x and the new
2.x versions uses Checkstyle 3.x. The Maven goals for the Checkstyle
plugins have not changed and the way to invoke it can either be
<code>maven checkstyle</code> or <code>maven checkstyle:report</code>.
</p>
<p>
Some <a href="properties.html">properties</a> have changed. The most
important change is probably the addition of a
<code>maven.checkstyle.header.file</code> one to point to your
License file.
</p>
<p>
The major migration step is to migrate your previous Checkstyle
properties (located in a properties file) to the new XML configuration
file introduced by Checkstyle 3.x. The new configuration is described
on the
<a href="http://checkstyle.sourceforge.net/config.html";>Checkstyle
config page</a>. An example is provided
<a href="http://checkstyle.sourceforge.net/sun_checks.xml";>here</a>.
</p>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
