You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by di...@apache.org on 2003/09/01 09:20:55 UTC
cvs commit: maven/src/plugins-build/checkstyle/xdocs/releases/v2.0 changes.xml goals.xml index.xml properties.xml migrating.xml
dion 2003/09/01 00:20:55
Modified: src/plugins-build/checkstyle/xdocs navigation.xml
changes.xml
Added: src/plugins-build/checkstyle/xdocs/current goals.xml
migrating.xml changes.xml properties.xml index.xml
src/plugins-build/checkstyle/xdocs/releases/v2.0 changes.xml
goals.xml index.xml properties.xml migrating.xml
Log:
Prep for release
Revision Changes Path
1.1 maven/src/plugins-build/checkstyle/xdocs/current/goals.xml
Index: goals.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Maven Checkstyle Plug-in Goals</title>
<author email="dion@multitask.com.au">dIon Gillard</author>
</properties>
<body>
<section name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
<td>checkstyle</td>
<td>
This is the default goal of the plugin. It simply calls the
<code>checkstyle:report</code> goal.
</td>
</tr>
<tr>
<td>checkstyle:report</td>
<td>
Generates an xml report from the source code showing how well the
code conforms to the
<a href="http://checkstyle.sourceforge.net">Checkstyle</a>
definitions defined by the project.
</td>
</tr>
</table>
</section>
</body>
</document>
1.1 maven/src/plugins-build/checkstyle/xdocs/current/migrating.xml
Index: migrating.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>
1.1 maven/src/plugins-build/checkstyle/xdocs/current/changes.xml
Index: changes.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Changes</title>
<author email="vmassol@octo.com">Vincent Massol</author>
<author email="evenisse@ifrance.com">Emmanuel Venisse</author>
</properties>
<body>
<release version="2.0" date="2003-09-01">
<action dev="dion" type="fix">Added ignoreLines 1, 6</action>
<action dev="dion" type="update">update to use maven.docs.*/maven.gen.docs</action>
<action dev="dion" type="fix">
Add maven dependency and classes directory to classpath. This stops
'Unable to get class information for '<classname>' errors.
</action>
<action dev="evenisse" type="fix">
Add xml declaration to generated report. Fixed for character encoding.
</action>
<action dev="evenisse" type="fix">
Fixed MAVEN-493. I register reports only if source, test,... exists.
So, corresponding entrys in menu will appear only if reports are registered.
</action>
<action dev="evenisse" type="fix">
Fixed Maven-489.
</action>
<action dev="vmassol" type="update">
Upgraded to Checkstyle 3.1.
</action>
<action dev="vmassol" type="update">
Updated documentation.
</action>
<action dev="vmassol" type="update">
Complete clean of the existing plugin.
</action>
</release>
<release version="1.1" date="2003-05-30">
<action dev="vmassol" type="add">
Added a new <code>maven.checkstyle.useFile</code> 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.
</action>
</release>
</body>
</document>
1.1 maven/src/plugins-build/checkstyle/xdocs/current/properties.xml
Index: properties.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Checkstyle Properties</title>
<author email="smor@apache.org">St�phane MOR</author>
</properties>
<body>
<section name="Checkstyle Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.checkstyle.includes</td>
<td>Yes</td>
<td>
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
<code>${maven.src.dir}</code>. The default value is
<code>**/*.java</code>, which matches all Java source files
in the source tree (specified by the <code>${maven.src.dir}</code>
property.
</td>
</tr>
<tr>
<td>maven.checkstyle.excludes</td>
<td>Yes</td>
<td>
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
<code>${maven.src.dir}</code>. The default value is to not
exclude any files.
</td>
</tr>
<tr>
<td>maven.checkstyle.format</td>
<td>Yes</td>
<td>
Specifies what predefined check set to use. Available sets are
"sun" (for the Sun coding conventions), "turbine" and "avalon".
Default value is <code>sun</code>.
</td>
</tr>
<tr>
<td>maven.checkstyle.properties</td>
<td>Yes</td>
<td>
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 <code>maven.checkstyle.format</code>).
</td>
</tr>
<tr>
<td>maven.checkstyle.header.file</td>
<td>Yes</td>
<td>
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
<code>${basedir}/LICENSE.txt</code>
</td>
</tr>
<tr>
<td>maven.checkstyle.fail.on.violation</td>
<td>Yes</td>
<td>
Specifies if the <code>maven:check-source</code> task
should fail upon a violation. This will stop the build
process. The default value is <code>false</code>.
</td>
</tr>
<tr>
<td>maven.checkstyle.cache.file</td>
<td>Yes</td>
<td>
Specifies the cache file used to speed up Checkstyle on
successive runs. The default value is
<code>${maven.build.dest}/checkstyle-cachefile</code>.
</td>
</tr>
<tr>
<td>maven.checkstyle.usefile</td>
<td>Yes</td>
<td>
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.
</td>
</tr>
</table>
</section>
</body>
</document>
1.1 maven/src/plugins-build/checkstyle/xdocs/current/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Maven CheckStyle Plug-in</title>
<author email="jason@zenplex.com">Jason van Zyl</author>
</properties>
<body>
<section name="Maven CheckStyle Plugin">
<p>
This plugin generates a nicely formatted
<a href="http://checkstyle.sourceforge.net">Checkstyle</a> report so
code violations can be easily found and corrected.
</p>
</section>
<section name="News">
<table>
<tr>
<th>Date</th>
<th>Description</th>
</tr>
<tr>
<td>31 May 2003</td>
<td>
New <a href="migrating.html">migration guide</a> to help migrate from
version 1.x to 2.x.
</td>
</tr>
<tr>
<td>30 May 2003</td>
<td>
New development version 2.0 created. First cut at supporting
Checkstyle 3.1.
</td>
</tr>
<tr>
<td>30 May 2003</td>
<td>
Release of version 1.1 (compatible with Checkstyle 2.4).
</td>
</tr>
</table>
</section>
</body>
</document>
1.4 +16 -0 maven/src/plugins-build/checkstyle/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/checkstyle/xdocs/navigation.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- navigation.xml 31 May 2003 07:00:35 -0000 1.3
+++ navigation.xml 1 Sep 2003 07:20:54 -0000 1.4
@@ -13,5 +13,21 @@
<item name="Properties" href="/properties.html" />
<item name="Migrating" href="/migrating.html" />
</menu>
+ <menu name="Versions">
+ <item name="Current" href="current/index.html">
+ <item name="Goals" href="current/goals.html" />
+ <item name="Properties" href="current/properties.html" />
+ <item name="Migrating" href="current/migrating.html" />
+ </item>
+ <item name="Release 2.0" href="releases/v2.0/index.html">
+ <item name="Goals" href="releases/v2.0/goals.html" />
+ <item name="Properties" href="releases/v2.0/properties.html" />
+ <item name="Migrating" href="releases/v2.0/migrating.html" />
+ </item>
+ </menu>
+ <menu name="Downloads">
+ <item name="Checkstyle Plugin 2.0"
+ href="http://www.ibiblio.org/maven/maven/plugins/maven-checkstyle-plugin-2.0.jar"/>
+ </menu>
</body>
</project>
1.10 +1 -1 maven/src/plugins-build/checkstyle/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/checkstyle/xdocs/changes.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- changes.xml 1 Sep 2003 07:01:20 -0000 1.9
+++ changes.xml 1 Sep 2003 07:20:54 -0000 1.10
@@ -8,7 +8,7 @@
<body>
- <release version="2.0" date="in CVS">
+ <release version="2.0" date="2003-09-01">
<action dev="dion" type="fix">Added ignoreLines 1, 6</action>
<action dev="dion" type="update">update to use maven.docs.*/maven.gen.docs</action>
1.1 maven/src/plugins-build/checkstyle/xdocs/releases/v2.0/changes.xml
Index: changes.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Changes</title>
<author email="vmassol@octo.com">Vincent Massol</author>
<author email="evenisse@ifrance.com">Emmanuel Venisse</author>
</properties>
<body>
<release version="2.0" date="2003-09-01">
<action dev="dion" type="fix">Added ignoreLines 1, 6</action>
<action dev="dion" type="update">update to use maven.docs.*/maven.gen.docs</action>
<action dev="dion" type="fix">
Add maven dependency and classes directory to classpath. This stops
'Unable to get class information for '<classname>' errors.
</action>
<action dev="evenisse" type="fix">
Add xml declaration to generated report. Fixed for character encoding.
</action>
<action dev="evenisse" type="fix">
Fixed MAVEN-493. I register reports only if source, test,... exists.
So, corresponding entrys in menu will appear only if reports are registered.
</action>
<action dev="evenisse" type="fix">
Fixed Maven-489.
</action>
<action dev="vmassol" type="update">
Upgraded to Checkstyle 3.1.
</action>
<action dev="vmassol" type="update">
Updated documentation.
</action>
<action dev="vmassol" type="update">
Complete clean of the existing plugin.
</action>
</release>
<release version="1.1" date="2003-05-30">
<action dev="vmassol" type="add">
Added a new <code>maven.checkstyle.useFile</code> 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.
</action>
</release>
</body>
</document>
1.1 maven/src/plugins-build/checkstyle/xdocs/releases/v2.0/goals.xml
Index: goals.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Maven Checkstyle Plug-in Goals</title>
<author email="dion@multitask.com.au">dIon Gillard</author>
</properties>
<body>
<section name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
<td>checkstyle</td>
<td>
This is the default goal of the plugin. It simply calls the
<code>checkstyle:report</code> goal.
</td>
</tr>
<tr>
<td>checkstyle:report</td>
<td>
Generates an xml report from the source code showing how well the
code conforms to the
<a href="http://checkstyle.sourceforge.net">Checkstyle</a>
definitions defined by the project.
</td>
</tr>
</table>
</section>
</body>
</document>
1.1 maven/src/plugins-build/checkstyle/xdocs/releases/v2.0/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Maven CheckStyle Plug-in</title>
<author email="jason@zenplex.com">Jason van Zyl</author>
</properties>
<body>
<section name="Maven CheckStyle Plugin">
<p>
This plugin generates a nicely formatted
<a href="http://checkstyle.sourceforge.net">Checkstyle</a> report so
code violations can be easily found and corrected.
</p>
</section>
<section name="News">
<table>
<tr>
<th>Date</th>
<th>Description</th>
</tr>
<tr>
<td>31 May 2003</td>
<td>
New <a href="migrating.html">migration guide</a> to help migrate from
version 1.x to 2.x.
</td>
</tr>
<tr>
<td>30 May 2003</td>
<td>
New development version 2.0 created. First cut at supporting
Checkstyle 3.1.
</td>
</tr>
<tr>
<td>30 May 2003</td>
<td>
Release of version 1.1 (compatible with Checkstyle 2.4).
</td>
</tr>
</table>
</section>
</body>
</document>
1.1 maven/src/plugins-build/checkstyle/xdocs/releases/v2.0/properties.xml
Index: properties.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Checkstyle Properties</title>
<author email="smor@apache.org">St�phane MOR</author>
</properties>
<body>
<section name="Checkstyle Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.checkstyle.includes</td>
<td>Yes</td>
<td>
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
<code>${maven.src.dir}</code>. The default value is
<code>**/*.java</code>, which matches all Java source files
in the source tree (specified by the <code>${maven.src.dir}</code>
property.
</td>
</tr>
<tr>
<td>maven.checkstyle.excludes</td>
<td>Yes</td>
<td>
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
<code>${maven.src.dir}</code>. The default value is to not
exclude any files.
</td>
</tr>
<tr>
<td>maven.checkstyle.format</td>
<td>Yes</td>
<td>
Specifies what predefined check set to use. Available sets are
"sun" (for the Sun coding conventions), "turbine" and "avalon".
Default value is <code>sun</code>.
</td>
</tr>
<tr>
<td>maven.checkstyle.properties</td>
<td>Yes</td>
<td>
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 <code>maven.checkstyle.format</code>).
</td>
</tr>
<tr>
<td>maven.checkstyle.header.file</td>
<td>Yes</td>
<td>
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
<code>${basedir}/LICENSE.txt</code>
</td>
</tr>
<tr>
<td>maven.checkstyle.fail.on.violation</td>
<td>Yes</td>
<td>
Specifies if the <code>maven:check-source</code> task
should fail upon a violation. This will stop the build
process. The default value is <code>false</code>.
</td>
</tr>
<tr>
<td>maven.checkstyle.cache.file</td>
<td>Yes</td>
<td>
Specifies the cache file used to speed up Checkstyle on
successive runs. The default value is
<code>${maven.build.dest}/checkstyle-cachefile</code>.
</td>
</tr>
<tr>
<td>maven.checkstyle.usefile</td>
<td>Yes</td>
<td>
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.
</td>
</tr>
</table>
</section>
</body>
</document>
1.1 maven/src/plugins-build/checkstyle/xdocs/releases/v2.0/migrating.xml
Index: migrating.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>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org