483dddf00b
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@116012 13f79535-47bb-0310-9956-ffa450edef68
138 lines
5.0 KiB
XML
138 lines
5.0 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!--
|
|
/*
|
|
* Copyright 2001-2004 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
-->
|
|
|
|
<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.propertiesURL</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the URL 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>
|
|
<tr>
|
|
<td>maven.checkstyle.suppressions.file</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the location of the suppressions file to use. The plugin
|
|
defines a Checkstyle property named
|
|
<code>checkstyle.suppressions.file</code> with the value of this
|
|
property. This allows using the Checkstyle property your own
|
|
custom checkstyle configuration file when specifying a
|
|
suppressions file.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
</body>
|
|
</document>
|
|
|