Skip to content

Commit a29bab8

Browse files
authored
Add notes on tweak rust-analyzer.check.overrideCommand (rust-lang#1890)
1 parent bafd382 commit a29bab8

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/building/suggested.md

+6
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ This will ask `rust-analyzer` to use `./x check` to check the sources, and the
3232
stage 0 rustfmt to format them.
3333
The recommended `rust-analyzer` settings live at [`src/etc/rust_analyzer_settings.json`].
3434

35+
The default `rust-analyzer.check.overrideCommand` command line will check all the crates and tools
36+
in the repository. If you are working on a specific part, you can override the command to only
37+
check the part you are working on to save checking time. For example, if you are working on
38+
the compiler, you can override the command to `x check compiler --json-output` to only
39+
check the compiler part. You can run `x check --help --verbose` to see the available parts.
40+
3541
If you have enough free disk space and you would like to be able to run `x` commands while
3642
rust-analyzer runs in the background, you can also add `--build-dir build-rust-analyzer` to the
3743
`overrideCommand` to avoid x locking.

0 commit comments

Comments
 (0)