From 8f8fd15c9ea55bd75afe2f1d8d9509cfcdfbd2b7 Mon Sep 17 00:00:00 2001 From: Michael Vorburger Date: Thu, 25 Sep 2025 19:12:05 +0200 Subject: [PATCH 1/2] docs: Update README with a bit more details about available flags (fixes #1285) --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index ab55679ab..14173d689 100644 --- a/README.md +++ b/README.md @@ -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 `@` 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). From 65730127f1386179ebdc20154bafdbfd6df2eb59 Mon Sep 17 00:00:00 2001 From: Michael Vorburger Date: Mon, 29 Sep 2025 15:19:50 +0200 Subject: [PATCH 2/2] Fix typo in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 14173d689..4981d19c8 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ 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 +Option `--help` will print full usage details; including 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`.