Document rustc source auto-discovery

This commit is contained in:
Laurențiu Nicola 2021-10-14 08:49:22 +03:00
parent 5e8f4dc30d
commit e43e1240a7
3 changed files with 7 additions and 5 deletions

View file

@ -263,12 +263,13 @@ config_data! {
runnables_cargoExtraArgs: Vec<String> = "[]", runnables_cargoExtraArgs: Vec<String> = "[]",
/// Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private /// 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 /// Any project which uses rust-analyzer with the rustcPrivate
/// crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it. /// 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", rustcSource: Option<String> = "null",
/// Additional arguments to `rustfmt`. /// Additional arguments to `rustfmt`.

View file

@ -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 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 Any project which uses rust-analyzer with the rustcPrivate
crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it. 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: `[]`):: [[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`)::
+ +

View file

@ -867,7 +867,7 @@
} }
}, },
"rust-analyzer.rustcSource": { "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, "default": null,
"type": [ "type": [
"null", "null",