Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added migration guide.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113456 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
vmassol
2003-05-31 07:00:35 +00:00
parent 5789f85688
commit cec025549b
3 changed files with 42 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
checkstyle/xdocs/index.xml
View File

@@ -20,6 +20,13 @@
<th>Date</th>
<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>

34
checkstyle/xdocs/migrating.xml Normal file
View File

@@ -0,0 +1,34 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Migration guide</title>
<author email="vmassol@apache.org">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>

1
checkstyle/xdocs/navigation.xml
View File

@@ -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>