diff options
| author | varkor <github@varkor.com> | 2020-01-11 13:04:06 +0000 |
|---|---|---|
| committer | varkor <github@varkor.com> | 2020-01-11 13:04:06 +0000 |
| commit | 9ef4fd7e19c347f9e04b44b3470ebf22ecea71a1 (patch) | |
| tree | 55c603b7699bf1324f34a2bdf13fd60856c89c62 | |
| parent | 2d8d559bbecf6272eb41f8a800e319238aa9d621 (diff) | |
| download | rust-9ef4fd7e19c347f9e04b44b3470ebf22ecea71a1.tar.gz rust-9ef4fd7e19c347f9e04b44b3470ebf22ecea71a1.zip | |
Clarify the relationship between `extended` and `tools` in `config.toml`
| -rw-r--r-- | config.toml.example | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/config.toml.example b/config.toml.example index bfd9e18cdd4..c9e17337ee2 100644 --- a/config.toml.example +++ b/config.toml.example @@ -181,21 +181,23 @@ # Indicate whether the vendored sources are used for Rust dependencies or not #vendor = false -# Typically the build system will build the rust compiler twice. The second +# Typically the build system will build the Rust compiler twice. The second # compiler, however, will simply use its own libraries to link against. If you # would rather to perform a full bootstrap, compiling the compiler three times, # then you can set this option to true. You shouldn't ever need to set this # option to true. #full-bootstrap = false -# Enable a build of the extended rust tool set which is not only the compiler +# Enable a build of the extended Rust tool set which is not only the compiler # but also tools such as Cargo. This will also produce "combined installers" # which are used to install Rust and Cargo together. This is disabled by -# default. +# default. The `tools` option (immediately below) specifies which tools should +# be built if `extended = true`. #extended = false -# Installs chosen set of extended tools if enabled. By default builds all. -# If chosen tool failed to build the installation fails. +# Installs chosen set of extended tools if `extended = true`. By default builds all. +# If chosen tool failed to build the installation fails. If `extended = false`, this +# option is ignored. #tools = ["cargo", "rls", "clippy", "rustfmt", "analysis", "src"] # Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose |
