doc: updated cmdline docs to be more specific on launching checkstyle JAR #14710

MANISH-K-07 · 2024-03-23T10:23:27Z

Response to @romani 's comment at discussion

Old docs : https://checkstyle.org/cmdline.html#Command_line_usage

We have been receiving many queries on our matrix forum from new contributors struggling to use our jar through CLI.
The problem here almost in every case was the download path and cli launch path being different (or) the test file/config not located at the same directory as jar.

The docs have been updated with a new example to be more specific.

romani

item:

src/main/java/com/puppycrawl/tools/checkstyle/Main.java

MANISH-K-07 · 2024-03-23T14:27:12Z

Github, generate site

github-actions · 2024-03-23T15:05:22Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/2c33e47_2024150248/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/2c33e47_2024150248/cmdline.html#CLI_Options

MANISH-K-07 · 2024-03-24T00:42:47Z

Github, generate site for @romani to review :)

github-actions · 2024-03-24T00:45:55Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/1c6395c_2024004424/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/1c6395c_2024004424/cmdline.html#CLI_Options

romani

Items

src/main/java/com/puppycrawl/tools/checkstyle/Main.java

romani

Items

src/xdocs/cmdline.xml.vm

romani

please fix CI.

romani

CI must be green

src/main/java/com/puppycrawl/tools/checkstyle/Main.java

MANISH-K-07 · 2024-04-03T18:28:14Z

Github, generate website for @rnveach to review :)

src/xdocs/cmdline.xml.vm

github-actions · 2024-04-03T18:43:18Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/0011391_2024184202/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/0011391_2024184202/cmdline.html#CLI_Options

src/xdocs/cmdline.xml.vm

MANISH-K-07 · 2024-04-11T08:35:56Z

Github, generate site

github-actions · 2024-04-11T08:50:14Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/60d14cf_2024083835/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/60d14cf_2024083835/cmdline.html#CLI_Options

rnveach

Last changes.

rnveach · 2024-04-13T23:26:53Z

src/xdocs/cmdline.xml.vm

+          <code>-J, --treeWithJavadoc</code> - This option is used to display the Abstract Syntax
+          Tree (AST) <b>with Javadoc nodes</b> of the specified file. It can only be used on a
+          single file and cannot be combined with other options. Note that the column numbers
+          between the 2 will not be in sync with the file's numbering due to the fact that each


Is this related to #14780 ? If so remove it since it was approved as a bug. When it is fixed and merged, then this will no longer apply.

Removed.. but I was considering removing it as part of the fix for #14780 itself

I wouldn't legitimatize this as being written in official documentation, especially if it is a bug. It is sometimes ok to add some things are not unsupported till another issue, but you'll be here a while if you have to write out everything that is a bug in open tickets. The issue itself is documentation and confirms it is supported wrong.

Got it :)

Now that this is merged, let's try #14759

rnveach · 2024-04-13T23:28:25Z

src/xdocs/cmdline.xml.vm

-          cannot be used other options and requires exactly one file to run on to be specified.
+          <code>-j, --javadocTree</code> - This option is used to print the Parse Tree of the
+          Javadoc comment. The file has to contain <b>only Javadoc comment content</b> without
+          including '/**' and '*/' at the beginning and at the end respectively. It can only be


without including => excluding

MANISH-K-07 · 2024-04-16T09:47:57Z

@romani , @rnveach , do the docs usually get published during release cycle?

rnveach · 2024-04-16T13:35:56Z

Yes, website is based on release.

MANISH-K-07 force-pushed the docs1 branch from 8c73455 to 00b826c Compare March 23, 2024 10:37

MANISH-K-07 marked this pull request as draft March 23, 2024 11:00

MANISH-K-07 force-pushed the docs1 branch 3 times, most recently from c469ae2 to 4cf9525 Compare March 23, 2024 12:31

MANISH-K-07 marked this pull request as ready for review March 23, 2024 12:46

romani requested changes Mar 23, 2024

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/Main.java Outdated Show resolved Hide resolved

MANISH-K-07 force-pushed the docs1 branch 3 times, most recently from 40ffaa1 to 2c33e47 Compare March 23, 2024 14:13

This comment was marked as outdated.

Sign in to view

MANISH-K-07 requested a review from romani March 23, 2024 16:48

MANISH-K-07 force-pushed the docs1 branch 2 times, most recently from 859548a to 1c6395c Compare March 24, 2024 00:27

rnveach self-requested a review March 24, 2024 01:57

romani requested changes Mar 24, 2024

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/Main.java Outdated Show resolved Hide resolved

MANISH-K-07 requested a review from romani March 24, 2024 05:16

MANISH-K-07 force-pushed the docs1 branch from 1c6395c to b76907d Compare March 25, 2024 06:26

MANISH-K-07 commented Mar 25, 2024

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/Main.java Outdated Show resolved Hide resolved

MANISH-K-07 force-pushed the docs1 branch from b76907d to b2fa64b Compare March 25, 2024 14:05

MANISH-K-07 changed the title ~~doc: updated cmdline option -t docs to be more specific~~ doc: updated cmdline docs to be more specific on launching checkstyle JAR Mar 25, 2024

romani requested changes Mar 25, 2024

View reviewed changes

src/xdocs/cmdline.xml.vm Outdated Show resolved Hide resolved

MANISH-K-07 force-pushed the docs1 branch from b2fa64b to 2967dbe Compare March 26, 2024 13:15

romani approved these changes Mar 26, 2024

View reviewed changes

romani self-requested a review March 26, 2024 13:33

romani requested changes Mar 26, 2024

View reviewed changes

rnveach assigned nrmancuso and unassigned romani and nrmancuso Apr 3, 2024

rnveach requested changes Apr 3, 2024

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/Main.java Outdated Show resolved Hide resolved

MANISH-K-07 mentioned this pull request Apr 3, 2024

Enhance Command Line documentation by organizing options in Tabular format #14759

Open

MANISH-K-07 force-pushed the docs1 branch 3 times, most recently from 4938463 to 0011391 Compare April 3, 2024 18:27

MANISH-K-07 commented Apr 3, 2024

View reviewed changes

src/xdocs/cmdline.xml.vm Outdated Show resolved Hide resolved

MANISH-K-07 requested a review from rnveach April 3, 2024 18:32

rnveach requested changes Apr 8, 2024

View reviewed changes

src/xdocs/cmdline.xml.vm Outdated Show resolved Hide resolved

src/xdocs/cmdline.xml.vm Outdated Show resolved Hide resolved

src/xdocs/cmdline.xml.vm Show resolved Hide resolved

MANISH-K-07 requested a review from rnveach April 8, 2024 04:49

MANISH-K-07 force-pushed the docs1 branch 3 times, most recently from 5db8ace to 60d14cf Compare April 11, 2024 08:04

MANISH-K-07 mentioned this pull request Apr 11, 2024

Column number in DetailNode should start with 1 #14780

Open

rnveach requested changes Apr 13, 2024

View reviewed changes

MANISH-K-07 force-pushed the docs1 branch from 60d14cf to 48d9cc4 Compare April 14, 2024 05:33

doc: updated cmdline docs to be more specific

045bf35

MANISH-K-07 force-pushed the docs1 branch from 48d9cc4 to 045bf35 Compare April 14, 2024 05:35

MANISH-K-07 requested a review from rnveach April 14, 2024 06:32

rnveach approved these changes Apr 16, 2024

View reviewed changes

rnveach merged commit b1498c3 into checkstyle:master Apr 16, 2024
113 checks passed

MANISH-K-07 deleted the docs1 branch April 16, 2024 00:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: updated cmdline docs to be more specific on launching checkstyle JAR #14710

doc: updated cmdline docs to be more specific on launching checkstyle JAR #14710

MANISH-K-07 commented Mar 23, 2024 •

edited

romani left a comment

MANISH-K-07 commented Mar 23, 2024

github-actions bot commented Mar 23, 2024

This comment was marked as outdated.

MANISH-K-07 commented Mar 24, 2024 •

edited

github-actions bot commented Mar 24, 2024

romani left a comment

romani left a comment

romani left a comment •

edited

romani left a comment

MANISH-K-07 commented Apr 3, 2024 •

edited

github-actions bot commented Apr 3, 2024

MANISH-K-07 commented Apr 11, 2024

github-actions bot commented Apr 11, 2024

rnveach left a comment

rnveach Apr 13, 2024 •

edited

MANISH-K-07 Apr 14, 2024

rnveach Apr 15, 2024 •

edited

MANISH-K-07 Apr 16, 2024

rnveach Apr 13, 2024

MANISH-K-07 Apr 14, 2024

MANISH-K-07 commented Apr 16, 2024 •

edited

rnveach commented Apr 16, 2024

doc: updated cmdline docs to be more specific on launching checkstyle JAR #14710

doc: updated cmdline docs to be more specific on launching checkstyle JAR #14710

Conversation

MANISH-K-07 commented Mar 23, 2024 • edited

romani left a comment

Choose a reason for hiding this comment

MANISH-K-07 commented Mar 23, 2024

github-actions bot commented Mar 23, 2024

This comment was marked as outdated.

MANISH-K-07 commented Mar 24, 2024 • edited

github-actions bot commented Mar 24, 2024

romani left a comment

Choose a reason for hiding this comment

romani left a comment

Choose a reason for hiding this comment

romani left a comment • edited

Choose a reason for hiding this comment

romani left a comment

Choose a reason for hiding this comment

MANISH-K-07 commented Apr 3, 2024 • edited

github-actions bot commented Apr 3, 2024

MANISH-K-07 commented Apr 11, 2024

github-actions bot commented Apr 11, 2024

rnveach left a comment

Choose a reason for hiding this comment

rnveach Apr 13, 2024 • edited

Choose a reason for hiding this comment

MANISH-K-07 Apr 14, 2024

Choose a reason for hiding this comment

rnveach Apr 15, 2024 • edited

Choose a reason for hiding this comment

MANISH-K-07 Apr 16, 2024

Choose a reason for hiding this comment

rnveach Apr 13, 2024

Choose a reason for hiding this comment

MANISH-K-07 Apr 14, 2024

Choose a reason for hiding this comment

MANISH-K-07 commented Apr 16, 2024 • edited

rnveach commented Apr 16, 2024

MANISH-K-07 commented Mar 23, 2024 •

edited

MANISH-K-07 commented Mar 24, 2024 •

edited

romani left a comment •

edited

MANISH-K-07 commented Apr 3, 2024 •

edited

rnveach Apr 13, 2024 •

edited

rnveach Apr 15, 2024 •

edited

MANISH-K-07 commented Apr 16, 2024 •

edited