Skip to content

Commit 8f8fd15

Browse files
authored
docs: Update README with a bit more details about available flags (fixes #1285)
1 parent 7e72422 commit 8f8fd15

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ 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; incl. built-in documentation about
30+
other flags, such as `--aosp`, `--fix-imports-only`, `--skip-sorting-imports`,
31+
`--skip-removing-unused-import`, `--skip-reflowing-long-strings`,
32+
`--skip-javadoc-formatting`, or the `--dry-run` and `--set-exit-if-changed`.
33+
34+
Using `@<filename>` reads options and filenames from a file, instead of arguments.
35+
2936
To reformat changed lines in a specific patch, use
3037
[`google-java-format-diff.py`](https://github.com/google/google-java-format/blob/master/scripts/google-java-format-diff.py).
3138

0 commit comments

Comments
 (0)