c38bee24ca
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113457 13f79535-47bb-0310-9956-ffa450edef68
38 lines
1.5 KiB
XML
38 lines
1.5 KiB
XML
<?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>.
|
|
Once you have finished migrating your Checkstyle configuration, modify
|
|
the <code>maven.checkstyle.properties</code> property point to the
|
|
new XML file.
|
|
</p>
|
|
</section>
|
|
</body>
|
|
</document>
|