diff options
| author | clubby789 <jamie@hill-daniel.co.uk> | 2023-02-15 18:46:19 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-15 15:46:19 -0300 |
| commit | 3e7c37b69f0cee4de3cdbd2d075fbed3c9d5f226 (patch) | |
| tree | da176410c0f039f0cdf62946437567663311903d /src/doc/rustc-dev-guide | |
| parent | 8ede68ae70f80fd24a5bde3d48fd24caddcbb524 (diff) | |
| download | rust-3e7c37b69f0cee4de3cdbd2d075fbed3c9d5f226.tar.gz rust-3e7c37b69f0cee4de3cdbd2d075fbed3c9d5f226.zip | |
Add link to vscode settings in Rust repo (#1591)
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/building/suggested.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/suggested.md b/src/doc/rustc-dev-guide/src/building/suggested.md index 5a18915037a..2e25920945a 100644 --- a/src/doc/rustc-dev-guide/src/building/suggested.md +++ b/src/doc/rustc-dev-guide/src/building/suggested.md @@ -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. This will ask `rust-analyzer` to use `./x.py check` to check the sources, and the 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 rust-analyzer runs in the background, you can also add `--build-dir build-rust-analyzer` to the `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 Task] instead: |