Unnamed repository; edit this file 'description' to name the repository.
Document rustc source auto-discovery
| -rw-r--r-- | crates/rust-analyzer/src/config.rs | 5 | ||||
| -rw-r--r-- | docs/user/generated_config.adoc | 5 | ||||
| -rw-r--r-- | editors/code/package.json | 2 |
3 files changed, 7 insertions, 5 deletions
diff --git a/crates/rust-analyzer/src/config.rs b/crates/rust-analyzer/src/config.rs index b51234c153..0d6b1bcbfb 100644 --- a/crates/rust-analyzer/src/config.rs +++ b/crates/rust-analyzer/src/config.rs @@ -263,12 +263,13 @@ config_data! { runnables_cargoExtraArgs: Vec<String> = "[]", /// Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private - /// projects, or "discover" to try to automatically find it. + /// projects, or "discover" to try to automatically find it if the `rustc-dev` component + /// is installed. /// /// Any project which uses rust-analyzer with the rustcPrivate /// crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it. /// - /// This option is not reloaded automatically; you must restart rust-analyzer for it to take effect. + /// This option does not take effect until rust-analyzer is restarted. rustcSource: Option<String> = "null", /// Additional arguments to `rustfmt`. diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 7955bcfba9..9a00a0eb66 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc @@ -420,12 +420,13 @@ tests or binaries. For example, it may be `--release`. + -- Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private -projects, or "discover" to try to automatically find it. +projects, or "discover" to try to automatically find it if the `rustc-dev` component +is installed. Any project which uses rust-analyzer with the rustcPrivate crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it. -This option is not reloaded automatically; you must restart rust-analyzer for it to take effect. +This option does not take effect until rust-analyzer is restarted. -- [[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`):: + diff --git a/editors/code/package.json b/editors/code/package.json index b62060c398..5dcdcb2769 100644 --- a/editors/code/package.json +++ b/editors/code/package.json @@ -867,7 +867,7 @@ } }, "rust-analyzer.rustcSource": { - "markdownDescription": "Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private\nprojects, or \"discover\" to try to automatically find it.\n\nAny project which uses rust-analyzer with the rustcPrivate\ncrates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.\n\nThis option is not reloaded automatically; you must restart rust-analyzer for it to take effect.", + "markdownDescription": "Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private\nprojects, or \"discover\" to try to automatically find it if the `rustc-dev` component\nis installed.\n\nAny project which uses rust-analyzer with the rustcPrivate\ncrates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.\n\nThis option does not take effect until rust-analyzer is restarted.", "default": null, "type": [ "null", |