Skip to content

Document RUSTFMT environment variable #4464

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 5 commits into from
Oct 11, 2020
Merged

Document RUSTFMT environment variable #4464

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1aeb61b
Document RUSTFMT env var
MonliH Oct 10, 2020
428f7f7
Move documentation up
MonliH Oct 11, 2020
66b7fcf
Apply suggestions from code review
MonliH Oct 11, 2020
91aa1d3
Fix accedental removal
MonliH Oct 11, 2020
fae9aeb
Merge branch 'master' of github.com:MonliH/rustfmt
MonliH Oct 11, 2020
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: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@ The easiest way to run rustfmt against a project is with `cargo fmt`. `cargo fmt
single-crate projects and [cargo workspaces](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html).
Please see `cargo fmt --help` for usage information.

You can specify the path to your own `rustfmt` binary for cargo to use by setting the`RUSTFMT`
environment variable. This was added in v1.4.22, so you must have this version or newer to leverage this feature (`cargo fmt --version`)

### Running `rustfmt` directly

To format individual files or arbitrary codes from stdin, the `rustfmt` binary should be used. Some
Expand Down