diff --git a/checkstyle/xdocs/index.xml b/checkstyle/xdocs/index.xml index 75ef8e70..6bd6cac8 100644 --- a/checkstyle/xdocs/index.xml +++ b/checkstyle/xdocs/index.xml @@ -20,6 +20,13 @@ Date Description + + 31 May 2003 + + New migration guide to help migrate from + version 1.x to 2.x. + + 30 May 2003 diff --git a/checkstyle/xdocs/migrating.xml b/checkstyle/xdocs/migrating.xml new file mode 100644 index 00000000..b3ce8ccb --- /dev/null +++ b/checkstyle/xdocs/migrating.xml @@ -0,0 +1,34 @@ + + + + + Migration guide + Vincent Massol + + + +
+

+ 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 + maven checkstyle or maven checkstyle:report. +

+

+ Some properties have changed. The most + important change is probably the addition of a + maven.checkstyle.header.file one to point to your + License file. +

+

+ 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 + Checkstyle + config page. An example is provided + here. +

+
+ + diff --git a/checkstyle/xdocs/navigation.xml b/checkstyle/xdocs/navigation.xml index 5b56d143..eeeaaafa 100644 --- a/checkstyle/xdocs/navigation.xml +++ b/checkstyle/xdocs/navigation.xml @@ -11,6 +11,7 @@ +