diff options
| author | Yuki Okushi <huyuumi.dev@gmail.com> | 2020-01-14 14:02:21 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-14 14:02:21 +0900 |
| commit | 7da1dcc3e0eee606b61ac7f7039b39b3332dfb6f (patch) | |
| tree | ca19f83ede60392594a660a3218988248debdac5 | |
| parent | 974b69927b2ca665a414a477717d40320cc7fbbd (diff) | |
| parent | 9ef4fd7e19c347f9e04b44b3470ebf22ecea71a1 (diff) | |
| download | rust-7da1dcc3e0eee606b61ac7f7039b39b3332dfb6f.tar.gz rust-7da1dcc3e0eee606b61ac7f7039b39b3332dfb6f.zip | |
Rollup merge of #68127 - varkor:clarify-extended-option, r=alexcrichton
Clarify the relationship between `extended` and `tools` in `config.toml` I.e. `tools` is only effective if `extended = true`. Alternatively, we could make `tools = []` by default and remove `extended` (although we'd want to list the possible options), but improving the description seems sufficient to solve the issue. Fixes https://github.com/rust-lang/rust/issues/61194.
| -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 |