Skip to content

doc: fix instruction about running Rustfmt from source code #5838

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 3 commits into from
Jul 19, 2023
Merged

doc: fix instruction about running Rustfmt from source code #5838

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a050bdc
doc: fix instruction about running Rustfmt from source code
xxchan Jul 17, 2023
9235a2d
Update Contributing.md
xxchan Jul 17, 2023
fa73bbb
update
xxchan Jul 19, 2023
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
12 changes: 10 additions & 2 deletions Contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,18 @@ wish there weren't. You can leave `FIXME`s, preferably with an issue number.

You may want to run a version of rustfmt from source code as part of a test or
hacking on the rustfmt codebase. It's strongly discouraged to install a version
of rustfmt from source. Instead, run it using `cargo run`, and `--manifest-path`.
of rustfmt from source.

To run `rustfmt` on a file:

```
cargo run --bin rustfmt -- path/to/file.rs
```

If you want to test modified `cargo-fmt`, or run `rustfmt` on the whole project (You may need to build rustfmt first):

```
cargo run --bin cargo-fmt -- --manifest-path path/to/project/you/want2test/Cargo.toml
RUSTFMT="./target/debug/rustfmt" cargo run --bin cargo-fmt -- --manifest-path path/to/project/you/want2test/Cargo.toml
```

### Version-gate formatting changes
Expand Down