Skip to content

Commit ebcc97c

Browse files
vorburgergoogle-java-format Team
authored andcommitted
docs: Update README with a bit more details about available flags
Fixes #1285. @cushon Fixes #1288 FUTURE_COPYBARA_INTEGRATE_REVIEW=#1288 from vorburger:patch-8 6573012 PiperOrigin-RevId: 811850820
1 parent 2186b2e commit ebcc97c

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ The formatter can act on whole files, on limited lines (`--lines`), on specific
2626
offsets (`--offset`), passing through to standard-out (default) or altered
2727
in-place (`--replace`).
2828

29+
Option `--help` will print full usage details; including built-in documentation
30+
about other flags, such as `--aosp`, `--fix-imports-only`,
31+
`--skip-sorting-imports`, `--skip-removing-unused-import`,
32+
`--skip-reflowing-long-strings`, `--skip-javadoc-formatting`, or the `--dry-run`
33+
and `--set-exit-if-changed`.
34+
35+
Using `@<filename>` reads options and filenames from a file, instead of
36+
arguments.
37+
2938
To reformat changed lines in a specific patch, use
3039
[`google-java-format-diff.py`](https://github.com/google/google-java-format/blob/master/scripts/google-java-format-diff.py).
3140

0 commit comments

Comments
 (0)