Skip to content

Commit 7da1dcc

Browse files
authored
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 #61194.
2 parents 974b699 + 9ef4fd7 commit 7da1dcc

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

config.toml.example

+7-5
Original file line numberDiff line numberDiff line change
@@ -181,21 +181,23 @@
181181
# Indicate whether the vendored sources are used for Rust dependencies or not
182182
#vendor = false
183183

184-
# Typically the build system will build the rust compiler twice. The second
184+
# Typically the build system will build the Rust compiler twice. The second
185185
# compiler, however, will simply use its own libraries to link against. If you
186186
# would rather to perform a full bootstrap, compiling the compiler three times,
187187
# then you can set this option to true. You shouldn't ever need to set this
188188
# option to true.
189189
#full-bootstrap = false
190190

191-
# Enable a build of the extended rust tool set which is not only the compiler
191+
# Enable a build of the extended Rust tool set which is not only the compiler
192192
# but also tools such as Cargo. This will also produce "combined installers"
193193
# which are used to install Rust and Cargo together. This is disabled by
194-
# default.
194+
# default. The `tools` option (immediately below) specifies which tools should
195+
# be built if `extended = true`.
195196
#extended = false
196197

197-
# Installs chosen set of extended tools if enabled. By default builds all.
198-
# If chosen tool failed to build the installation fails.
198+
# Installs chosen set of extended tools if `extended = true`. By default builds all.
199+
# If chosen tool failed to build the installation fails. If `extended = false`, this
200+
# option is ignored.
199201
#tools = ["cargo", "rls", "clippy", "rustfmt", "analysis", "src"]
200202

201203
# Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose

0 commit comments

Comments
 (0)