The absolutely last refactoring change with the properties config stuff. I am
sick it. Absolutely sick of it! Completely and utterly sick of it!! Still, the change is better for the future.
This commit is contained in:
parent
49eb0e934e
commit
98c8a0db55
|
|
@ -49,8 +49,10 @@ This task is included in the checkstyle distribution.</p>
|
|||
<td valign="top">
|
||||
Specifies a properties file that contains the configuration options.
|
||||
<a href="config.html">See here</a> for all available configuration
|
||||
options. Can override properties in the file using the nested
|
||||
<span class="default"><property></span> elements.
|
||||
options. Use the nested <span class="default"><property></span>
|
||||
element to override properties in the file. This is very useful with
|
||||
project specific properties like
|
||||
<a href="config_reporting.html">reporting configuration</a>.
|
||||
</td>
|
||||
<td align="center" valign="top">No</td>
|
||||
</tr>
|
||||
|
|
|
|||
|
|
@ -27,7 +27,8 @@ This command line tool is included in the checkstyle distribution.</p>
|
|||
<h2>Usage</h2>
|
||||
<p>The command line usage is:</p>
|
||||
<pre>
|
||||
java com.puppycrawl.tools.checkstyle.Main \
|
||||
java -D<property>=<value> \
|
||||
com.puppycrawl.tools.checkstyle.Main \
|
||||
[-f <format>] [-p <propertiesFile>] [-o <file>] [-r <dir>] file...
|
||||
</pre>
|
||||
|
||||
|
|
@ -35,11 +36,19 @@ This command line tool is included in the checkstyle distribution.</p>
|
|||
|
||||
<ul>
|
||||
<li><span class="default">-f format</span> - specify the output format. Options are <span class="default">"plain"</span> for the <a href="api/com/puppycrawl/tools/checkstyle/DefaultLogger.html">DefaultLogger</a> and <span class="default">"xml"</span> for the <a href="api/com/puppycrawl/tools/checkstyle/XMLLogger.html">XMLLogger</a>. Defaults to <span class="default">"plain"</span>.</li>
|
||||
<li><span class="default">-p propertiesFile</span> - specify a properties file to use. <a href="config.html">See here</a> for all available configuration options.</li>
|
||||
<li><span class="default">-p propertiesFile</span> - specify a properties file to use.
|
||||
<li><span class="default">-o file</span> - specify the file to output to.</li>
|
||||
<li><span class="default">-r dir</span> - specify the directory to traverse for Java source files.</li>
|
||||
</ul>
|
||||
|
||||
<p>The default behaviour of checkstyle can be changed either by setting system
|
||||
properties using the <code>-D<property>=<value></code> arguments
|
||||
to java or by specifying a property file using the <code>-p</code> option.
|
||||
<a href="config.html">See here</a> for all available configuration options.</li>
|
||||
If a property file is specified the system properties are ignored. The
|
||||
following table describes what properties can be set:</p>
|
||||
|
||||
|
||||
|
||||
<h2>Examples</h2>
|
||||
<p><b>Run checkstyle on a file</b></p>
|
||||
|
|
@ -58,12 +67,24 @@ This command line tool is included in the checkstyle distribution.</p>
|
|||
-p myCheckstyle.properties Check.java
|
||||
</pre>
|
||||
|
||||
<p><b>Run checkstyle on a file and output to a file in XML format</b></p>
|
||||
<p><b>Run checkstyle on a file and output to a file in XML format with Australian localisation</b></p>
|
||||
<pre>
|
||||
java com.puppycrawl.tools.checkstyle.Main \
|
||||
java -Dcheckstyle.allow.tabs=yes \
|
||||
-Dcheckstyle.locale.language=en \
|
||||
-Dcheckstyle.locale.language=au \
|
||||
com.puppycrawl.tools.checkstyle.Main \
|
||||
-f xml -o build/checkstyle_errors.xml Check.java
|
||||
</pre>
|
||||
|
||||
<p><b>Run checkstyle on a file and disable pattern matching</b></p>
|
||||
<pre>
|
||||
java -Dcheckstyle.pattern.parameter=. \
|
||||
-Dcheckstyle.pattern.static=. \
|
||||
-Dcheckstyle.pattern.const=. \
|
||||
-Dcheckstyle.pattern.member=. \
|
||||
com.puppycrawl.tools.checkstyle.Main Check.java
|
||||
</pre>
|
||||
|
||||
<div class="tip">
|
||||
<h4 class="tip">Tip</h4>
|
||||
<p>It is possible to run Checkstyle directly from the JAR file using the <span class="code">-jar</span> option. Example would be: </p>
|
||||
|
|
|
|||
Loading…
Reference in New Issue