Skip to content

docs: Update README with a bit more details about available flags #1288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vorburger wants to merge 2 commits into from
Closed

docs: Update README with a bit more details about available flags #1288

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f8fd15
docs: Update README with a bit more details about available flags (fi…
vorburger Sep 25, 2025
6573012
Fix typo in README.md
vorburger Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ The formatter can act on whole files, on limited lines (`--lines`), on specific
offsets (`--offset`), passing through to standard-out (default) or altered
in-place (`--replace`).

Option `--help` will print full usage details; incl. built-in documentation about
other flags, such as `--aosp`, `--fix-imports-only`, `--skip-sorting-imports`,
`--skip-removing-unused-import`, `--skip-reflowing-long-strings`,
`--skip-javadoc-formatting`, or the `--dry-run` and `--set-exit-if-changed`.

Using `@<filename>` reads options and filenames from a file, instead of arguments.

To reformat changed lines in a specific patch, use
[`google-java-format-diff.py`](https://github.com/google/google-java-format/blob/master/scripts/google-java-format-diff.py).

Expand Down
Loading