diff options
| author | Daniel McNab <36049421+DJMcNab@users.noreply.github.com> | 2021-03-08 16:47:40 +0000 |
|---|---|---|
| committer | Daniel McNab <36049421+DJMcNab@users.noreply.github.com> | 2021-03-08 16:47:40 +0000 |
| commit | 20007fd3a8aa16bec0c4f9ebc1489c157f846df4 (patch) | |
| tree | 9bfd0d92b9b1174a93a0595f303a5b7193d1a50b | |
| parent | d0a51d710edf5893d1f8ffe58647fd4aa795096c (diff) | |
| download | rust-20007fd3a8aa16bec0c4f9ebc1489c157f846df4.tar.gz rust-20007fd3a8aa16bec0c4f9ebc1489c157f846df4.zip | |
Document rustc_private in metadata
| -rw-r--r-- | crates/rust-analyzer/src/config.rs | 3 | ||||
| -rw-r--r-- | docs/user/generated_config.adoc | 2 | ||||
| -rw-r--r-- | editors/code/package.json | 2 |
3 files changed, 4 insertions, 3 deletions
diff --git a/crates/rust-analyzer/src/config.rs b/crates/rust-analyzer/src/config.rs index 36713670250..4417c8d13dc 100644 --- a/crates/rust-analyzer/src/config.rs +++ b/crates/rust-analyzer/src/config.rs @@ -180,7 +180,8 @@ config_data! { runnables_cargoExtraArgs: Vec<String> = "[]", /// Path to the rust compiler sources, for usage in rustc_private projects, or "discover" - /// to try to automatically find it. + /// 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", /// Additional arguments to `rustfmt`. diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 1dbf2a611d6..504133070be 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc @@ -105,7 +105,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. + 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. [[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 1987364bc02..b39e8fbe39c 100644 --- a/editors/code/package.json +++ b/editors/code/package.json @@ -707,7 +707,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.", + "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.", "default": null, "type": [ "null", |