diff options
| author | Laurențiu Nicola <lnicola@dend.ro> | 2022-10-11 10:37:35 +0300 |
|---|---|---|
| committer | Laurențiu Nicola <lnicola@dend.ro> | 2022-10-11 10:37:35 +0300 |
| commit | 4f55ebbd4fb2aaf6ac97e484c07504e5124422e7 (patch) | |
| tree | 935f14e6b9bc2f1c1592e27c32e63d452ec9db4f /docs | |
| parent | 3a57388d136518c063ffdad09e27394cfe66ecb3 (diff) | |
| download | rust-4f55ebbd4fb2aaf6ac97e484c07504e5124422e7.tar.gz rust-4f55ebbd4fb2aaf6ac97e484c07504e5124422e7.zip | |
:arrow_up: rust-analyzer
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/README.md | 2 | ||||
| -rw-r--r-- | docs/dev/guide.md | 4 | ||||
| -rw-r--r-- | docs/user/generated_config.adoc | 10 |
3 files changed, 11 insertions, 5 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index c7f152acc26..4ac75b4bbfd 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -98,7 +98,7 @@ After I am done with the fix, I use `cargo xtask install --client` to try the ne If I need to fix something in the `rust-analyzer` crate, I feel sad because it's on the boundary between the two processes, and working there is slow. I usually just `cargo xtask install --server` and poke changes from my live environment. Note that this uses `--release`, which is usually faster overall, because loading stdlib into debug version of rust-analyzer takes a lot of time. -To speed things up, sometimes I open a temporary hello-world project which has `"rust-analyzer.cargo.noSysroot": true` in `.code/settings.json`. +To speed things up, sometimes I open a temporary hello-world project which has `"rust-analyzer.cargo.sysroot": null` in `.code/settings.json`. This flag causes rust-analyzer to skip loading the sysroot, which greatly reduces the amount of things rust-analyzer needs to do, and makes printf's more useful. Note that you should only use the `eprint!` family of macros for debugging: stdout is used for LSP communication, and `print!` would break it. diff --git a/docs/dev/guide.md b/docs/dev/guide.md index 808eb5d10bf..c9ff0b6c29e 100644 --- a/docs/dev/guide.md +++ b/docs/dev/guide.md @@ -40,8 +40,8 @@ terms of files and offsets, and **not** in terms of Rust concepts like structs, traits, etc. The "typed" API with Rust specific types is slightly lower in the stack, we'll talk about it later. -[`AnalysisHost`]: https://github.com/rust-lang/rust-analyzer/blob/guide-2019-01/crates/ide_api/src/lib.rs#L265-L284 -[`Analysis`]: https://github.com/rust-lang/rust-analyzer/blob/guide-2019-01/crates/ide_api/src/lib.rs#L291-L478 +[`AnalysisHost`]: https://github.com/rust-lang/rust-analyzer/blob/guide-2019-01/crates/ra_ide_api/src/lib.rs#L265-L284 +[`Analysis`]: https://github.com/rust-lang/rust-analyzer/blob/guide-2019-01/crates/ra_ide_api/src/lib.rs#L291-L478 The reason for this separation of `Analysis` and `AnalysisHost` is that we want to apply changes "uniquely", but we might also want to fork an `Analysis` and send it to diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 996d4c023d7..acf0aaea859 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc @@ -64,10 +64,15 @@ Set this to `"all"` to pass `--all-features` to cargo. -- Whether to pass `--no-default-features` to cargo. -- -[[rust-analyzer.cargo.noSysroot]]rust-analyzer.cargo.noSysroot (default: `false`):: +[[rust-analyzer.cargo.sysroot]]rust-analyzer.cargo.sysroot (default: `"discover"`):: + -- -Internal config for debugging, disables loading of sysroot crates. +Relative path to the sysroot, or "discover" to try to automatically find it via +"rustc --print sysroot". + +Unsetting this disables sysroot loading. + +This option does not take effect until rust-analyzer is restarted. -- [[rust-analyzer.cargo.target]]rust-analyzer.cargo.target (default: `null`):: + @@ -103,6 +108,7 @@ Extra arguments for `cargo check`. + -- Extra environment variables that will be set when running `cargo check`. +Extends `#rust-analyzer.cargo.extraEnv#`. -- [[rust-analyzer.checkOnSave.features]]rust-analyzer.checkOnSave.features (default: `null`):: + |
