From 310100c2396c64ddf566abbe46207de1f0ca0b79 Mon Sep 17 00:00:00 2001 From: Oliver Burn Date: Sat, 14 Sep 2002 05:07:00 +0000 Subject: [PATCH] Added some advice on upgrading --- docs/index.html | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/index.html b/docs/index.html index 228c6e632..75b4985f1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -29,6 +29,7 @@
  • Overview
  • Features
  • Download
    • +
  • Upgrading
  • License
  • Related Tools
    • @@ -113,6 +114,38 @@ If you want to live on the bleeding edge, you can checkout the current development code from CVS and compile yourself.

    + +

    Upgrading to release 2.4

    + +

    As of release 2.4 Checkstyle can only be configured by + properties. The major impact is to the ANT task as many arguments have + been removed. It is still possible to customise Checkstyle via ANT task, + but the technique has changed. For example the following call with + Checkstyle 2.3:

    + +
    +    <checkstyle cacheFile="target/checkstyle.cache"
+                headerFile="dev/header.txt"
+                properties="dev/checkstyle.config">
+      <fileset dir="src" includes="**/*.java"/>
+    </checkstyle>
+
    + +

    has the equivalent call with Checkstyle 2.4:

    +
    +    <checkstyle properties="dev/checkstyle.config">
+      <fileset dir="src" includes="**/*.java"/>
+      <property key="checkstyle.cache.file"
+                file="target/checkstyle.cache"/>
+      <property key="checkstyle.header.file"
+                file="dev/header.txt"/>
+    </checkstyle>
+
    + +

    See the documentation for the ANT + Task for more examples.

    + +

    Related Tools