mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Suggests `--edition=2018` argument when using stage0/bin/rustfmt directly

This commit is contained in:
Frank Steffahn 2021-09-17 21:48:36 +02:00 committed by Joshua Nelson
parent 212a89205b
commit ee4b32b958
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/building/suggested.md
View File

@ -22,7 +22,7 @@ You can also install the hook as a step of running `x.py setup`!
a file. By default, `rust-analyzer` runs the `cargo check` and `rustfmt` a file. By default, `rust-analyzer` runs the `cargo check` and `rustfmt`
commands, but you can override these commands to use more adapted versions commands, but you can override these commands to use more adapted versions
of these tools when hacking on `rustc`. For example, for Visual Studio Code, of these tools when hacking on `rustc`. For example, for Visual Studio Code,
you can write: you can write: <!-- date: 2021-09 --><!-- the date comment is for the edition below -->
```JSON ```JSON
{ {
@ -32,7 +32,8 @@ you can write:
"--json-output" "--json-output"
], ],
"rust-analyzer.rustfmt.overrideCommand": [ "rust-analyzer.rustfmt.overrideCommand": [
"./build/TARGET_TRIPLE/stage0/bin/rustfmt" "./build/TARGET_TRIPLE/stage0/bin/rustfmt",
"--edition=2018"
], ],
"editor.formatOnSave": true, "editor.formatOnSave": true,
"rust-analyzer.cargo.runBuildScripts": false, "rust-analyzer.cargo.runBuildScripts": false,

2
src/getting-started.md
View File

@ -293,6 +293,8 @@ format-on-save turned on. It's a good habit to run `./x.py fmt` before every
commit, as this reduces conflicts later. The pinned version is built under commit, as this reduces conflicts later. The pinned version is built under
`build/<target>/stage0/bin/rustfmt`, so if you want, you can use it for a `build/<target>/stage0/bin/rustfmt`, so if you want, you can use it for a
single file or for format-on-save in your editor, which can be faster than `./x.py fmt`. single file or for format-on-save in your editor, which can be faster than `./x.py fmt`.
You'll have to pass the <!-- date: 2021-09 --> `--edition=2018` argument
yourself when calling `rustfmt` directly.
One last thing: you can use `RUSTC_LOG=XXX` to get debug logging. [Read more One last thing: you can use `RUSTC_LOG=XXX` to get debug logging. [Read more
here][logging]. Notice the `C` in `RUSTC_LOG`. Other than that, it uses normal here][logging]. Notice the `C` in `RUSTC_LOG`. Other than that, it uses normal