From e3c72076fddbdbcca7d9f002d2e9cfa245f1430b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20K=C3=BChne?= Date: Sun, 22 Dec 2002 12:08:45 +0000 Subject: [PATCH] added required jars. We should add some version info, but I don't know what exactly is required. --- docs/anttask.html | 8 +++----- docs/cmdline.html | 48 +++++++++++++++++++++-------------------------- 2 files changed, 24 insertions(+), 32 deletions(-) diff --git a/docs/anttask.html b/docs/anttask.html index feeb88ed4..082d35904 100644 --- a/docs/anttask.html +++ b/docs/anttask.html @@ -22,14 +22,12 @@ This task is included in the checkstyle distribution.

  • checkstyle-@CHECKSTYLE_VERSION@.jar
  • ANTLR 2.7.1 classes. antlr.jar is included in the distribution.
  • Jakarta Regexp 1.2 classes. jakarta-regexp-1.2.jar is included in the distribution.
    • +
  • Jakarta Commons Beanutils classes. commons-beanutils.jar is included in the distribution.
    • +
  • Jakarta Commons Collections classes. commons-collections.jar is included in the distribution.
    • +
  • Jakarta Commons Logging classes. commons-logging.jar is included in the distribution.

    • To use the task in a build file, you will need the following taskdef declaration:

    -
    -  <taskdef name="checkstyle"
-           classname="com.puppycrawl.tools.checkstyle.CheckStyleTask"/>
-
    -

    Alternatively, since checkstyle version 2.2 you can use taskdef's resource attribute:

       <taskdef resource="checkstyletask.properties"/>
    diff --git a/docs/cmdline.html b/docs/cmdline.html index 6c92d605a..faa2acce1 100644 --- a/docs/cmdline.html +++ b/docs/cmdline.html @@ -13,31 +13,25 @@

    Description

    -This document describes how to run checkstyle using the command line tool. The -latest version of checkstyle can be found at http://checkstyle.sourceforge.net. +This document describes how to run checkstyle using the command line tool. The +latest version of checkstyle can be found at http://checkstyle.sourceforge.net. This command line tool is included in the checkstyle distribution.

    Installation

    -The easiest way is to include checkstyle-all-@ -CHECKSTYLE_VERSION@.jar in the classpath. This contains all the classes -required to run checkstyle. Alternatively, you must include the following in the -classpath: +The easiest way is to include checkstyle-all-@CHECKSTYLE_VERSION@.jar in the classpath. This contains all the classes +required to run checkstyle. Alternatively, you must include the following in the classpath:

      -
    1. - checkstyle-@CHECKSTYLE_VERSION@.jar -
      2. -
    2. - ANTLR 2.7.1 classes. antlr.jar is included in the - distribution. -
      3. -
    3. - Jakarta Regexp 1.2 classes. jakarta-regexp-1.2.jar - is included in the distribution. -
      4. +
    4. checkstyle-@CHECKSTYLE_VERSION@.jar
      5. +
    5. ANTLR 2.7.1 classes. antlr.jar is included in the distribution.
      6. +
    6. Jakarta Regexp 1.2 classes. jakarta-regexp-1.2.jar is included in the distribution.
      7. +
    7. Jakarta Commons Beanutils classes. commons-beanutils.jar is included in the distribution.
      8. +
    8. Jakarta Commons Collections classes. commons-collections.jar is included in the distribution.
      9. +
    9. Jakarta Commons Logging classes. commons-logging.jar is included in the distribution.
      10. +
    10. Jakarta Commons CLI (command line interface) classes. commons-cli.jar is included in the distribution.
    @@ -53,7 +47,7 @@ The command line usage is:

    -Checkstyle will process the specified files and by default report errors to +Checkstyle will process the specified files and by default report errors to standard out in plain format. Checkstyle requires a configuration XML file that configures the checks to apply. Command line options are:

    @@ -65,28 +59,28 @@ checks to apply. Command line options are: package names file to use.
  • - -f format - specify the output format. Options are - "plain" for the DefaultLogger - and "xml" for the XMLLogger. + -f format - specify the output format. Options are + "plain" for the DefaultLogger + and "xml" for the XMLLogger. Defaults to "plain".
  • - -p propertiesFile - specify a properties file to + -p propertiesFile - specify a properties file to use.
  • -o file - specify the file to output to.
  • - -r dir - specify the directory to traverse for Java + -r dir - specify the directory to traverse for Java source files.

    • Set the properties for expanded property values -by either by assigning system -properties using the -D<property>=<value> arguments to +by either by assigning system +properties using the -D<property>=<value> arguments to java or specifying a property file using the -p option. If a property file is specified, the system properties are ignored.

    @@ -148,8 +142,8 @@ provide a package names file

    Tip

    - It is possible to run Checkstyle directly from the JAR file using the - - jar option. An example would be: + It is possible to run Checkstyle directly from the JAR file using the - + jar option. An example would be: