Skip to content

Commit 34cb29a

Browse files
authored
Merge pull request #2060 from tamird/doc-dump-default-config
Document `--dump-default-config` in README.md
2 parents 96c9a90 + f00c556 commit 34cb29a

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,8 @@ options covering different styles. File an issue, or even better, submit a PR.
208208
```
209209
* When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
210210
target file directory or its parents to override the default settings of
211-
rustfmt.
211+
rustfmt. You can generate a file containing the default configuration with
212+
`rustfm --dump-default-config rustfmt.toml` and customize as needed.
212213
* After successful compilation, a `rustfmt` executable can be found in the
213214
target directory.
214215
* If you're having issues compiling Rustfmt (or compile errors when trying to

src/bin/rustfmt.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,7 @@ fn make_opts() -> Options {
128128
opts.opt(
129129
"",
130130
"dump-default-config",
131-
"Dumps the default configuration to a file and exits. PATH defaults to rustfmt.toml if \
132-
omitted.",
131+
"Dumps default configuration to PATH. PATH defaults to stdout, if omitted."
133132
"PATH",
134133
HasArg::Maybe,
135134
Occur::Optional,

0 commit comments

Comments
 (0)