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

Add link to vscode settings in Rust repo (#1591)

This commit is contained in:
clubby789 2023-02-15 18:46:19 +00:00 committed by GitHub
parent 03dd097bb0
commit 41680031f8
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/building/suggested.md
View File

@ -28,11 +28,17 @@ of these tools when hacking on `rustc`. For example, `x.py setup` will prompt
you to create a `.vscode/settings.json` file which will configure Visual Studio code. you to create a `.vscode/settings.json` file which will configure Visual Studio code.
This will ask `rust-analyzer` to use `./x.py check` to check the sources, and the This will ask `rust-analyzer` to use `./x.py check` to check the sources, and the
stage 0 rustfmt to format them. stage 0 rustfmt to format them.
The recommended `rust-analyzer` settings live at [`src/etc/vscode_settings.json`].
If you have enough free disk space and you would like to be able to run `x.py` commands while If you have enough free disk space and you would like to be able to run `x.py` commands while
rust-analyzer runs in the background, you can also add `--build-dir build-rust-analyzer` to the rust-analyzer runs in the background, you can also add `--build-dir build-rust-analyzer` to the
`overrideCommand` to avoid x.py locking. `overrideCommand` to avoid x.py locking.
If you're running `coc.nvim`, you can use `:CocLocalConfig` to create a
`.vim/coc-settings.json` and copy the settings from [`src/etc/vscode_settings.json`].
[`src/etc/vscode_settings.json`]: https://github.com/rust-lang/rust/blob/master/src/etc/vscode_settings.json
If running `./x.py check` on save is inconvenient, in VS Code you can use a [Build If running `./x.py check` on save is inconvenient, in VS Code you can use a [Build
Task] instead: Task] instead: