Skip to content

Commit

Permalink
tweak the hint
Browse files Browse the repository at this point in the history
  • Loading branch information
RalfJung committed Oct 6, 2024
1 parent 35eb2da commit 6f84740
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions src/tools/miri/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,19 +195,14 @@ installed (`cargo install hyperfine`).

## Configuring `rust-analyzer`

To configure `rust-analyzer` and the IDE for working on Miri, use one of the provided
configuration files according to the instructions below.

To configure `rust-analyzer` and the IDE for working on Miri, copy one of the provided
configuration files according to the instructions below. You can also set up a symbolic
link to keep the configuration in sync with our recommendations.

### Visual Studio Code

Copy [`etc/rust_analyzer_vscode.json`] to `.vscode/settings.json` in the project root directory.

> #### Hint
>
> To keep the `rust-analyzer` configuration up-to-date, make a symbolic link to one
> of the provided files depending on the IDE you use.
[`etc/rust_analyzer_vscode.json`]: https://github.com/rust-lang/miri/blob/master/etc/rust_analyzer_vscode.json

### Helix
Expand Down

0 comments on commit 6f84740

Please sign in to comment.