Skip to content

Potential Typo in Running > Command Line > Usage by Classpath Update #15292

@mattxwang

Description

@mattxwang

Hi folks, new-to-checkstyle user here. Apologies for not using the bug report template, but that seems like overkill for this issue.

I was looking at Running > Command Line > Usage by Classpath Update, and the last example under "Run checkstyle with custom module(s) (Root module, Checks, etc) in configuration file:" has the following command:

java -classpath MyCustom.jar;checkstyle-10.17.0-all.jar \
    com.puppycrawl.tools.checkstyle.Main -c config.xml Check.java

The semicolon here seems to be a typo (unless I'm missing something); I believe this should be

java -classpath MyCustom.jar:checkstyle-10.17.0-all.jar \
    com.puppycrawl.tools.checkstyle.Main -c config.xml Check.java

Usually not a big deal, but I noticed that this was also picked up by a 2018 SO post.

Am I missing something? If not, happy to submit a one-line PR to fix this here:

java -classpath MyCustom.jar;checkstyle-${projectVersion}-all.jar \

(or, have an existing contributor do it if that'd be faster!)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions