diff --git a/checkstyle/xdocs/changes.xml b/checkstyle/xdocs/changes.xml index 2b6a3193..5cddf712 100644 --- a/checkstyle/xdocs/changes.xml +++ b/checkstyle/xdocs/changes.xml @@ -8,7 +8,7 @@ - + Added ignoreLines 1, 6 update to use maven.docs.*/maven.gen.docs diff --git a/checkstyle/xdocs/current/changes.xml b/checkstyle/xdocs/current/changes.xml new file mode 100644 index 00000000..5cddf712 --- /dev/null +++ b/checkstyle/xdocs/current/changes.xml @@ -0,0 +1,51 @@ + + + + Changes + Vincent Massol + Emmanuel Venisse + + + + + + + Added ignoreLines 1, 6 + update to use maven.docs.*/maven.gen.docs + + Add maven dependency and classes directory to classpath. This stops + 'Unable to get class information for '<classname>' errors. + + + Add xml declaration to generated report. Fixed for character encoding. + + + Fixed MAVEN-493. I register reports only if source, test,... exists. + So, corresponding entrys in menu will appear only if reports are registered. + + + Fixed Maven-489. + + + Upgraded to Checkstyle 3.1. + + + Updated documentation. + + + Complete clean of the existing plugin. + + + + + + Added a new maven.checkstyle.useFile property. + If false, the checkstyle task will display violations on stdout. + If true, a text file will be created with the violations. Note: + this is in addition to the XML result file (containing the + violations in XML format) which is always created. + + + + + diff --git a/checkstyle/xdocs/current/goals.xml b/checkstyle/xdocs/current/goals.xml new file mode 100644 index 00000000..7bc1b393 --- /dev/null +++ b/checkstyle/xdocs/current/goals.xml @@ -0,0 +1,32 @@ + + + + + Maven Checkstyle Plug-in Goals + dIon Gillard + + + +
+ + + + + + + + + + +
GoalDescription
checkstyle + This is the default goal of the plugin. It simply calls the + checkstyle:report goal. +
checkstyle:report + Generates an xml report from the source code showing how well the + code conforms to the + Checkstyle + definitions defined by the project. +
+
+ + diff --git a/checkstyle/xdocs/current/index.xml b/checkstyle/xdocs/current/index.xml new file mode 100644 index 00000000..6bd6cac8 --- /dev/null +++ b/checkstyle/xdocs/current/index.xml @@ -0,0 +1,46 @@ + + + + + Maven CheckStyle Plug-in + Jason van Zyl + + + +
+

+ This plugin generates a nicely formatted + Checkstyle report so + code violations can be easily found and corrected. +

+
+
+ + + + + + + + + + + + + + + + + +
DateDescription
31 May 2003 + New migration guide to help migrate from + version 1.x to 2.x. +
30 May 2003 + New development version 2.0 created. First cut at supporting + Checkstyle 3.1. +
30 May 2003 + Release of version 1.1 (compatible with Checkstyle 2.4). +
+
+ + diff --git a/checkstyle/xdocs/current/migrating.xml b/checkstyle/xdocs/current/migrating.xml new file mode 100644 index 00000000..914628a0 --- /dev/null +++ b/checkstyle/xdocs/current/migrating.xml @@ -0,0 +1,37 @@ + + + + + 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. + Once you have finished migrating your Checkstyle configuration, modify + the maven.checkstyle.properties property point to the + new XML file. +

+
+ + diff --git a/checkstyle/xdocs/current/properties.xml b/checkstyle/xdocs/current/properties.xml new file mode 100644 index 00000000..b4ba283e --- /dev/null +++ b/checkstyle/xdocs/current/properties.xml @@ -0,0 +1,97 @@ + + + + Checkstyle Properties + Stéphane MOR + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyOptional?Description
maven.checkstyle.includesYes + Specifies a comma-separated list of Ant patterns to use + when matching files in the source tree to be included in the + Checkstyle report. The pattern specified is relative to + ${maven.src.dir}. The default value is + **/*.java, which matches all Java source files + in the source tree (specified by the ${maven.src.dir} + property. +
maven.checkstyle.excludesYes + Specifies a comma-separated list of Ant patterns to use when + matching files in the source tree to be excluded from the + Checkstyle report. The pattern specified is relative to + ${maven.src.dir}. The default value is to not + exclude any files. +
maven.checkstyle.formatYes + Specifies what predefined check set to use. Available sets are + "sun" (for the Sun coding conventions), "turbine" and "avalon". + Default value is sun. +
maven.checkstyle.propertiesYes + Specifies the location of the checkstyle properties that will be + used to check the source. Note that you will need to use this + property only if you don't want to use any of the predefined + formats (see maven.checkstyle.format). +
maven.checkstyle.header.fileYes + Specifies the location of the License file (a.k.a the header file) + that is used by Checkstyle to verify that source code has the + correct copyright. Default value is + ${basedir}/LICENSE.txt +
maven.checkstyle.fail.on.violationYes + Specifies if the maven:check-source task + should fail upon a violation. This will stop the build + process. The default value is false. +
maven.checkstyle.cache.fileYes + Specifies the cache file used to speed up Checkstyle on + successive runs. The default value is + ${maven.build.dest}/checkstyle-cachefile. +
maven.checkstyle.usefileYes + If false, the checkstyle task will display violations on stdout. + If true, a text file will be created with the violations. Note: + this is in addition to the XML result file (containing the + violations in XML format) which is always created. +
+
+ + + diff --git a/checkstyle/xdocs/navigation.xml b/checkstyle/xdocs/navigation.xml index eeeaaafa..75f8e4d6 100644 --- a/checkstyle/xdocs/navigation.xml +++ b/checkstyle/xdocs/navigation.xml @@ -13,5 +13,21 @@ + + + + + + + + + + + + + + + diff --git a/checkstyle/xdocs/releases/v2.0/changes.xml b/checkstyle/xdocs/releases/v2.0/changes.xml new file mode 100644 index 00000000..5cddf712 --- /dev/null +++ b/checkstyle/xdocs/releases/v2.0/changes.xml @@ -0,0 +1,51 @@ + + + + Changes + Vincent Massol + Emmanuel Venisse + + + + + + + Added ignoreLines 1, 6 + update to use maven.docs.*/maven.gen.docs + + Add maven dependency and classes directory to classpath. This stops + 'Unable to get class information for '<classname>' errors. + + + Add xml declaration to generated report. Fixed for character encoding. + + + Fixed MAVEN-493. I register reports only if source, test,... exists. + So, corresponding entrys in menu will appear only if reports are registered. + + + Fixed Maven-489. + + + Upgraded to Checkstyle 3.1. + + + Updated documentation. + + + Complete clean of the existing plugin. + + + + + + Added a new maven.checkstyle.useFile property. + If false, the checkstyle task will display violations on stdout. + If true, a text file will be created with the violations. Note: + this is in addition to the XML result file (containing the + violations in XML format) which is always created. + + + + + diff --git a/checkstyle/xdocs/releases/v2.0/goals.xml b/checkstyle/xdocs/releases/v2.0/goals.xml new file mode 100644 index 00000000..7bc1b393 --- /dev/null +++ b/checkstyle/xdocs/releases/v2.0/goals.xml @@ -0,0 +1,32 @@ + + + + + Maven Checkstyle Plug-in Goals + dIon Gillard + + + +
+ + + + + + + + + + +
GoalDescription
checkstyle + This is the default goal of the plugin. It simply calls the + checkstyle:report goal. +
checkstyle:report + Generates an xml report from the source code showing how well the + code conforms to the + Checkstyle + definitions defined by the project. +
+
+ + diff --git a/checkstyle/xdocs/releases/v2.0/index.xml b/checkstyle/xdocs/releases/v2.0/index.xml new file mode 100644 index 00000000..6bd6cac8 --- /dev/null +++ b/checkstyle/xdocs/releases/v2.0/index.xml @@ -0,0 +1,46 @@ + + + + + Maven CheckStyle Plug-in + Jason van Zyl + + + +
+

+ This plugin generates a nicely formatted + Checkstyle report so + code violations can be easily found and corrected. +

+
+
+ + + + + + + + + + + + + + + + + +
DateDescription
31 May 2003 + New migration guide to help migrate from + version 1.x to 2.x. +
30 May 2003 + New development version 2.0 created. First cut at supporting + Checkstyle 3.1. +
30 May 2003 + Release of version 1.1 (compatible with Checkstyle 2.4). +
+
+ + diff --git a/checkstyle/xdocs/releases/v2.0/migrating.xml b/checkstyle/xdocs/releases/v2.0/migrating.xml new file mode 100644 index 00000000..914628a0 --- /dev/null +++ b/checkstyle/xdocs/releases/v2.0/migrating.xml @@ -0,0 +1,37 @@ + + + + + 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. + Once you have finished migrating your Checkstyle configuration, modify + the maven.checkstyle.properties property point to the + new XML file. +

+
+ + diff --git a/checkstyle/xdocs/releases/v2.0/properties.xml b/checkstyle/xdocs/releases/v2.0/properties.xml new file mode 100644 index 00000000..b4ba283e --- /dev/null +++ b/checkstyle/xdocs/releases/v2.0/properties.xml @@ -0,0 +1,97 @@ + + + + Checkstyle Properties + Stéphane MOR + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyOptional?Description
maven.checkstyle.includesYes + Specifies a comma-separated list of Ant patterns to use + when matching files in the source tree to be included in the + Checkstyle report. The pattern specified is relative to + ${maven.src.dir}. The default value is + **/*.java, which matches all Java source files + in the source tree (specified by the ${maven.src.dir} + property. +
maven.checkstyle.excludesYes + Specifies a comma-separated list of Ant patterns to use when + matching files in the source tree to be excluded from the + Checkstyle report. The pattern specified is relative to + ${maven.src.dir}. The default value is to not + exclude any files. +
maven.checkstyle.formatYes + Specifies what predefined check set to use. Available sets are + "sun" (for the Sun coding conventions), "turbine" and "avalon". + Default value is sun. +
maven.checkstyle.propertiesYes + Specifies the location of the checkstyle properties that will be + used to check the source. Note that you will need to use this + property only if you don't want to use any of the predefined + formats (see maven.checkstyle.format). +
maven.checkstyle.header.fileYes + Specifies the location of the License file (a.k.a the header file) + that is used by Checkstyle to verify that source code has the + correct copyright. Default value is + ${basedir}/LICENSE.txt +
maven.checkstyle.fail.on.violationYes + Specifies if the maven:check-source task + should fail upon a violation. This will stop the build + process. The default value is false. +
maven.checkstyle.cache.fileYes + Specifies the cache file used to speed up Checkstyle on + successive runs. The default value is + ${maven.build.dest}/checkstyle-cachefile. +
maven.checkstyle.usefileYes + If false, the checkstyle task will display violations on stdout. + If true, a text file will be created with the violations. Note: + this is in addition to the XML result file (containing the + violations in XML format) which is always created. +
+
+ + +