Skip to content

Commit b65ea1b

Browse files
committed
place non-obvious defaults on a separate line
See #73538 (comment) for the motivation
1 parent e84552e commit b65ea1b

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

config.toml.example

+30-10
Original file line numberDiff line numberDiff line change
@@ -118,18 +118,24 @@
118118
# nightlies are already produced for. The current platform must be able to run
119119
# binaries of this build triple and the nightly will be used to bootstrap the
120120
# first compiler.
121-
#build = "x86_64-unknown-linux-gnu" # defaults to your host platform
121+
#
122+
# Defaults to host platform
123+
#build = "x86_64-unknown-linux-gnu"
122124

123125
# In addition to the build triple, other triples to produce full compiler
124126
# toolchains for. Each of these triples will be bootstrapped from the build
125127
# triple and then will continue to bootstrap themselves. This platform must
126128
# currently be able to run all of the triples provided here.
127-
#host = ["x86_64-unknown-linux-gnu"] # defaults to just the build triple
129+
#
130+
# Defaults to just the build triple
131+
#host = ["x86_64-unknown-linux-gnu"]
128132

129133
# In addition to all host triples, other triples to produce the standard library
130134
# for. Each host triple will be used to produce a copy of the standard library
131135
# for each target triple.
132-
#target = ["x86_64-unknown-linux-gnu"] # defaults to just the build triple
136+
#
137+
# Defaults to just the build triple
138+
#target = ["x86_64-unknown-linux-gnu"]
133139

134140
# Use this directory to store build artifacts.
135141
# You can use "$ROOT" to indicate the root of the git repository.
@@ -173,7 +179,9 @@
173179

174180
# Python interpreter to use for various tasks throughout the build, notably
175181
# rustdoc tests, the lldb python interpreter, and some dist bits and pieces.
176-
#python = "python" # defaults to the Python interpreter used to execute x.py
182+
#
183+
# Defaults to the Python interpreter used to execute x.py
184+
#python = "python"
177185

178186
# Force Cargo to check that Cargo.lock describes the precise dependency
179187
# set that all the Cargo.toml files create, instead of updating it.
@@ -311,11 +319,15 @@
311319

312320
# Whether or not debug assertions are enabled for the compiler and standard
313321
# library.
314-
#debug-assertions = false # defaults to rust.debug value
322+
#
323+
# Defaults to rust.debug value
324+
#debug-assertions = false
315325

316326
# Whether or not debug assertions are enabled for the standard library.
317327
# Overrides the `debug-assertions` option, if defined.
318-
#debug-assertions-std = false # defaults to rust.debug value
328+
#
329+
# Defaults to rust.debug value
330+
#debug-assertions-std = false
319331

320332
# Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
321333
# `0` - no debug info
@@ -324,16 +336,24 @@
324336
# Can be overridden for specific subsets of Rust code (rustc, std or tools).
325337
# Debuginfo for tests run with compiletest is not controlled by this option
326338
# and needs to be enabled separately with `debuginfo-level-tests`.
327-
#debuginfo-level = 0 # defaults to 2 if debug is true
339+
#
340+
# Defaults to 2 if debug is true
341+
#debuginfo-level = 0
328342

329343
# Debuginfo level for the compiler.
330-
#debuginfo-level-rustc = 0 # defaults to rust.debuginfo-level value
344+
#
345+
# Defaults to rust.debuginfo-level value
346+
#debuginfo-level-rustc = 0
331347

332348
# Debuginfo level for the standard library.
333-
#debuginfo-level-std = 0 # defaults to rust.debuginfo-level value
349+
#
350+
# Defaults to rust.debuginfo-level value
351+
#debuginfo-level-std = 0
334352

335353
# Debuginfo level for the tools.
336-
#debuginfo-level-tools = 0 # defaults to rust.debuginfo-level value
354+
#
355+
# Defaults to rust.debuginfo-level value
356+
#debuginfo-level-tools = 0
337357

338358
# Debuginfo level for the test suites run with compiletest.
339359
# FIXME(#61117): Some tests fail when this option is enabled.

0 commit comments

Comments
 (0)