Skip to content

Commit

Permalink
Add notes on tweak rust-analyzer.check.overrideCommand
Browse files Browse the repository at this point in the history
  • Loading branch information
chenyukang committed Feb 16, 2024
1 parent 91332ec commit 70da080
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/building/suggested.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ This will ask `rust-analyzer` to use `./x check` to check the sources, and the
stage 0 rustfmt to format them.
The recommended `rust-analyzer` settings live at [`src/etc/rust_analyzer_settings.json`].

The default `rust-analyzer.check.overrideCommand` command line will check all the crates and tools
in the repository. If you are working on a specific part, you can override the command to only
check the part you are working on to save checking time. For example, if you are working on
the compiler, you can override the command to `x check compiler --json-output` to only
check the compiler part. You can run `x check --help --verbose` to see the available parts.

If you have enough free disk space and you would like to be able to run `x` commands while
rust-analyzer runs in the background, you can also add `--build-dir build-rust-analyzer` to the
`overrideCommand` to avoid x locking.
Expand Down

0 comments on commit 70da080

Please sign in to comment.