Skip to content

Commit

Permalink
Update Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xxchan authored Jul 17, 2023
1 parent 8f92d1b commit 3c01099
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions Contributing.md
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:

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

### Version-gate formatting changes
Expand Down

0 comments on commit 3c01099

Please sign in to comment.