diff options
| author | Joshua Nelson <jyn514@gmail.com> | 2021-03-08 16:56:42 -0500 |
|---|---|---|
| committer | Joshua Nelson <jyn514@gmail.com> | 2021-03-08 16:56:42 -0500 |
| commit | c7b0914b3fffc9fd648003c950cfff596c75edbf (patch) | |
| tree | e1334a1311a552d820fc485e8340910e9866cf02 | |
| parent | c48478621fe9b50cb19bfd0ea4a5c2ff0de5d6ac (diff) | |
| download | rust-c7b0914b3fffc9fd648003c950cfff596c75edbf.tar.gz rust-c7b0914b3fffc9fd648003c950cfff596c75edbf.zip | |
Add more documentation for rustc_private
| -rw-r--r-- | crates/rust-analyzer/src/config.rs | 10 | ||||
| -rw-r--r-- | docs/user/generated_config.adoc | 2 | ||||
| -rw-r--r-- | editors/code/package.json | 2 |
3 files changed, 9 insertions, 5 deletions
diff --git a/crates/rust-analyzer/src/config.rs b/crates/rust-analyzer/src/config.rs index 078c83f75cd..28e2212714c 100644 --- a/crates/rust-analyzer/src/config.rs +++ b/crates/rust-analyzer/src/config.rs @@ -180,10 +180,14 @@ config_data! { /// tests or binaries.\nFor example, it may be `--release`. runnables_cargoExtraArgs: Vec<String> = "[]", - /// Path to the rust compiler sources, for usage in rustc_private projects, or "discover" - /// to try to automatically find it. Any project which uses rust-analyzer with the rustcPrivate + /// Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private + /// projects, or "discover" to try to automatically find it. + /// + /// Any project which uses rust-analyzer with the rustcPrivate /// crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it. - rustcSource : Option<String> = "null", + /// + /// This option is not reloaded automatically; you must restart rust-analyzer for it to take effect. + rustcSource: Option<String> = "null", /// Additional arguments to `rustfmt`. rustfmt_extraArgs: Vec<String> = "[]", diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 5243bcbf6a6..e0ffcc4843c 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc @@ -107,7 +107,7 @@ [[rust-analyzer.runnables.cargoExtraArgs]]rust-analyzer.runnables.cargoExtraArgs (default: `[]`):: Additional arguments to be passed to cargo for runnables such as tests or binaries.\nFor example, it may be `--release`. [[rust-analyzer.rustcSource]]rust-analyzer.rustcSource (default: `null`):: - Path to the rust compiler sources, for usage in rustc_private projects, or "discover" to try to automatically find it. Any project which uses rust-analyzer with the rustcPrivate crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it. + Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private projects, or "discover" to try to automatically find it. 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. [[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`):: Additional arguments to `rustfmt`. [[rust-analyzer.rustfmt.overrideCommand]]rust-analyzer.rustfmt.overrideCommand (default: `null`):: diff --git a/editors/code/package.json b/editors/code/package.json index 856f1c94e5a..e15e7875be5 100644 --- a/editors/code/package.json +++ b/editors/code/package.json @@ -713,7 +713,7 @@ } }, "rust-analyzer.rustcSource": { - "markdownDescription": "Path to the rust compiler sources, for usage in rustc_private projects, or \"discover\" to try to automatically find it. Any project which uses rust-analyzer with the rustcPrivate crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.", + "markdownDescription": "Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private projects, or \"discover\" to try to automatically find it. 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.", "default": null, "type": [ "null", |