Skip to content

Commit

Permalink
Issue checkstyle#15089: note for windows users on system property syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
romani committed Sep 8, 2024
1 parent e3d5e59 commit bf31b64
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/xdocs/cmdline.xml.vm
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,10 @@ java -D<property>=<value> \
option has been dropped for Checkstyle 5.0, because of significant changes regarding
package name file handling. See <a href="config.html#Packages">this link</a> for details.
</p>

<p>
To define system property for execution look at
<a href="config_system_properties.html#Properties">system properties</a>.
</p>
<p>
Set the properties for <a href="config.html#Properties">expanded
property values</a> by either by assigning system properties using the
Expand Down
15 changes: 15 additions & 0 deletions src/xdocs/config_system_properties.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,17 @@
</macro>
</section>

<section name="How to set system property for CLI">
<p>
System properties should be provided to <code>java</code> command.
Example: <code>java -D&lt;property&gt;=&lt;value&gt; -jar ... </code>
</p>
<p>
Attention to Windows users: system properties should be wrapped with <code>"</code>.
Example: <code>-D"&lt;property&gt;=&lt;value&gt;"</code>
</p>
</section>

<section name="Enable External DTD load">
<p>
The property <code>checkstyle.enableExternalDtdLoad</code>
Expand Down Expand Up @@ -119,6 +130,10 @@ Audit done.
Checkstyle ends with 2 errors.
</source>
</p>
<p>
Attention to Windows users: system properties should be wrapped with <code>"</code>.
Example: <code>-D"&lt;property&gt;=&lt;value&gt;"</code>
</p>
</subsection>
</section>

Expand Down

0 comments on commit bf31b64

Please sign in to comment.