From c6d39a22590d7ad3a77a0332c039a498cbda1312 Mon Sep 17 00:00:00 2001 From: xxchan Date: Wed, 19 Jul 2023 20:22:24 +0200 Subject: [PATCH] doc: fix instruction about running Rustfmt from source code (#5838) Update docs to include an example of running `rustfmt` built from src, and show how users can set the `RUSTFMT` environment variable to test `cargo-fmt` using the `rustfmt` they built from src. --- Contributing.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/Contributing.md b/Contributing.md index b986a887c92..69a2c76369f 100644 --- a/Contributing.md +++ b/Contributing.md @@ -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