Skip to content

Document --dump-default-config in README.md #2060

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

Merged
merged 2 commits into from
Oct 16, 2017
Merged

Document --dump-default-config in README.md #2060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50a138a
Document `--dump-default-config` in README.md
ssilva Sep 19, 2017
f00c556
correct --dump-default-config usage string
tamird Oct 14, 2017
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,8 @@ options covering different styles. File an issue, or even better, submit a PR.
```
* When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
target file directory or its parents to override the default settings of
rustfmt.
rustfmt. You can generate a file containing the default configuration with
`rustfm --dump-default-config rustfmt.toml` and customize as needed.
* After successful compilation, a `rustfmt` executable can be found in the
target directory.
* If you're having issues compiling Rustfmt (or compile errors when trying to
Expand Down
3 changes: 1 addition & 2 deletions src/bin/rustfmt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,7 @@ fn make_opts() -> Options {
opts.opt(
"",
"dump-default-config",
"Dumps the default configuration to a file and exits. PATH defaults to rustfmt.toml if \
omitted.",
"Dumps default configuration to PATH. PATH defaults to stdout, if omitted."
"PATH",
HasArg::Maybe,
Occur::Optional,
Expand Down