]> git.proxmox.com Git - rustc.git/blame - config.toml.example
bump version to 1.61.0+dfsg1-1~exp1
[rustc.git] / config.toml.example
CommitLineData
ea8adc8c
XL
1# Sample TOML configuration file for building Rust.
2#
3# To configure rustbuild, copy this file to the directory from which you will be
4# running the build, and name it config.toml.
5#
6# All options are commented out by default in this file, and they're commented
7# out with their default values. The build system by default looks for
8# `config.toml` in the current directory of a build for build configuration, but
9# a custom configuration file can also be specified with `--config` to the build
10# system.
11
1b1a35ee
XL
12# Keeps track of the last version of `x.py` used.
13# If it does not match the version that is currently running,
14# `x.py` will prompt you to update it and read the changelog.
15# See `src/bootstrap/CHANGELOG.md` for more information.
29967ef6 16changelog-seen = 2
1b1a35ee
XL
17
18# =============================================================================
19# Global Settings
20# =============================================================================
21
22# Use different pre-set defaults than the global defaults.
23#
24# See `src/bootstrap/defaults` for more information.
25# Note that this has no default value (x.py uses the defaults in `config.toml.example`).
26#profile = <none>
27
ea8adc8c
XL
28# =============================================================================
29# Tweaking how LLVM is compiled
30# =============================================================================
31[llvm]
32
1b1a35ee
XL
33# Whether to use Rust CI built LLVM instead of locally building it.
34#
35# Unless you're developing for a target where Rust CI doesn't build a compiler
36# toolchain or changing LLVM locally, you probably want to set this to true.
37#
5869c6ff
XL
38# This is false by default so that distributions don't unexpectedly download
39# LLVM from the internet.
40#
136023e0 41# All tier 1 targets are currently supported; set this to `"if-available"` if
5869c6ff 42# you are not sure whether you're on a tier 1 target.
1b1a35ee
XL
43#
44# We also currently only support this when building LLVM for the build triple.
45#
46# Note that many of the LLVM options are not currently supported for
47# downloading. Currently only the "assertions" option can be toggled.
48#download-ci-llvm = false
49
dfeec247
XL
50# Indicates whether LLVM rebuild should be skipped when running bootstrap. If
51# this is `false` then the compiler's LLVM will be rebuilt whenever the built
52# version doesn't have the correct hash. If it is `true` then LLVM will never
53# be rebuilt. The default value is `false`.
54#skip-rebuild = false
55
ea8adc8c
XL
56# Indicates whether the LLVM build is a Release or Debug build
57#optimize = true
58
b7449926
XL
59# Indicates whether LLVM should be built with ThinLTO. Note that this will
60# only succeed if you use clang, lld, llvm-ar, and llvm-ranlib in your C/C++
61# toolchain (see the `cc`, `cxx`, `linker`, `ar`, and `ranlib` options below).
62# More info at: https://clang.llvm.org/docs/ThinLTO.html#clang-bootstrap
63#thin-lto = false
64
ea8adc8c
XL
65# Indicates whether an LLVM Release build should include debug info
66#release-debuginfo = false
67
68# Indicates whether the LLVM assertions are enabled or not
69#assertions = false
70
3c0e092e
XL
71# Indicates whether the LLVM testsuite is enabled in the build or not. Does
72# not execute the tests as part of the build as part of x.py build et al,
73# just makes it possible to do `ninja check-llvm` in the staged LLVM build
74# directory when doing LLVM development as part of Rust development.
75#tests = false
76
94222f64
XL
77# Indicates whether the LLVM plugin is enabled or not
78#plugins = false
79
ea8adc8c
XL
80# Indicates whether ccache is used when building LLVM
81#ccache = false
82# or alternatively ...
83#ccache = "/path/to/ccache"
84
85# If an external LLVM root is specified, we automatically check the version by
86# default to make sure it's within the range that we're expecting, but setting
87# this flag will indicate that this version check should not be done.
abe05a73 88#version-check = true
ea8adc8c 89
1b1a35ee 90# Link libstdc++ statically into the rustc_llvm instead of relying on a
ea8adc8c 91# dynamic version to be available.
ee023bcb 92#static-libstdcpp = true
ea8adc8c 93
1b1a35ee
XL
94# Whether to use Ninja to build LLVM. This runs much faster than make.
95#ninja = true
ea8adc8c
XL
96
97# LLVM targets to build support for.
98# Note: this is NOT related to Rust compilation targets. However, as Rust is
99# dependent on LLVM for code generation, turning targets off here WILL lead to
100# the resulting rustc being unable to compile for the disabled architectures.
101# Also worth pointing out is that, in case support for new targets are added to
102# LLVM, enabling them here doesn't mean Rust is automatically gaining said
103# support. You'll need to write a target specification at least, and most
104# likely, teach rustc about the C ABI of the target. Get in touch with the
105# Rust team and file an issue if you need assistance in porting!
17df50a5 106#targets = "AArch64;ARM;BPF;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;Sparc;SystemZ;WebAssembly;X86"
ea8adc8c
XL
107
108# LLVM experimental targets to build support for. These targets are specified in
109# the same format as above, but since these targets are experimental, they are
110# not built by default and the experimental Rust compilation targets that depend
416331ca 111# on them will not work unless the user opts in to building them.
c295e0f8 112#experimental-targets = "AVR;M68k"
ea8adc8c
XL
113
114# Cap the number of parallel linker invocations when compiling LLVM.
115# This can be useful when building LLVM with debug info, which significantly
116# increases the size of binaries and consequently the memory required by
117# each linker process.
118# If absent or 0, linker invocations are treated like any other job and
119# controlled by rustbuild's -j parameter.
120#link-jobs = 0
121
122# When invoking `llvm-config` this configures whether the `--shared` argument is
123# passed to prefer linking to shared libraries.
cdc7bbd5 124# NOTE: `thin-lto = true` requires this to be `true` and will give an error otherwise.
ea8adc8c
XL
125#link-shared = false
126
b7449926 127# When building llvm, this configures what is being appended to the version.
ba9703b0
XL
128# The default is "-rust-$version-$channel", except for dev channel where rustc
129# version number is omitted. To use LLVM version as is, provide an empty string.
130#version-suffix = "-rust-dev"
b7449926 131
94b46f34 132# On MSVC you can compile LLVM with clang-cl, but the test suite doesn't pass
cdc7bbd5
XL
133# with clang-cl, so this is special in that it only compiles LLVM with clang-cl.
134# Note that this takes a /path/to/clang-cl, not a boolean.
135#clang-cl = cc
94b46f34 136
9fa01778 137# Pass extra compiler and linker flags to the LLVM CMake build.
cdc7bbd5
XL
138#cflags = ""
139#cxxflags = ""
140#ldflags = ""
9fa01778 141
0731742a
XL
142# Use libc++ when building LLVM instead of libstdc++. This is the default on
143# platforms already use libc++ as the default C++ library, but this option
144# allows you to use libc++ even on platforms when it's not. You need to ensure
145# that your host compiler ships with libc++.
cdc7bbd5 146#use-libcxx = false
0731742a 147
9fa01778 148# The value specified here will be passed as `-DLLVM_USE_LINKER` to CMake.
cdc7bbd5 149#use-linker = <none> (path)
9fa01778 150
532ac7d7
XL
151# Whether or not to specify `-DLLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN=YES`
152#allow-old-toolchain = false
9fa01778 153
29967ef6
XL
154# Whether to include the Polly optimizer.
155#polly = false
156
94222f64
XL
157# Whether to build the clang compiler.
158#clang = false
159
5099ac24
FG
160# Custom CMake defines to set when building LLVM.
161#build-config = {}
162
ea8adc8c
XL
163# =============================================================================
164# General build configuration options
165# =============================================================================
166[build]
cdc7bbd5
XL
167# The default stage to use for the `check` subcommand
168#check-stage = 0
169
1b1a35ee
XL
170# The default stage to use for the `doc` subcommand
171#doc-stage = 0
172
173# The default stage to use for the `build` subcommand
174#build-stage = 1
175
176# The default stage to use for the `test` subcommand
177#test-stage = 1
178
179# The default stage to use for the `dist` subcommand
180#dist-stage = 2
181
182# The default stage to use for the `install` subcommand
183#install-stage = 2
184
185# The default stage to use for the `bench` subcommand
186#bench-stage = 2
ea8adc8c
XL
187
188# Build triple for the original snapshot compiler. This must be a compiler that
189# nightlies are already produced for. The current platform must be able to run
190# binaries of this build triple and the nightly will be used to bootstrap the
191# first compiler.
f035d41b 192#
cdc7bbd5
XL
193# Defaults to platform where `x.py` is run.
194#build = "x86_64-unknown-linux-gnu" (as an example)
ea8adc8c 195
1b1a35ee
XL
196# Which triples to produce a compiler toolchain for. Each of these triples will
197# be bootstrapped from the build triple themselves.
f035d41b 198#
cdc7bbd5
XL
199# Defaults to just the build triple.
200#host = ["x86_64-unknown-linux-gnu"] (as an example)
ea8adc8c 201
1b1a35ee
XL
202# Which triples to build libraries (core/alloc/std/test/proc_macro) for. Each of
203# these triples will be bootstrapped from the build triple themselves.
f035d41b 204#
1b1a35ee
XL
205# Defaults to `host`. If you set this explicitly, you likely want to add all
206# host triples to this list as well in order for those host toolchains to be
207# able to compile programs for their native target.
cdc7bbd5 208#target = ["x86_64-unknown-linux-gnu"] (as an example)
ea8adc8c 209
f9f354fc
XL
210# Use this directory to store build artifacts.
211# You can use "$ROOT" to indicate the root of the git repository.
212#build-dir = "build"
213
c295e0f8 214# Instead of downloading the src/stage0.json version of Cargo specified, use
ea8adc8c 215# this Cargo binary instead to build all Rust code
cdc7bbd5 216#cargo = "/path/to/cargo"
ea8adc8c 217
c295e0f8 218# Instead of downloading the src/stage0.json version of the compiler
ea8adc8c 219# specified, use this rustc binary instead as the stage0 snapshot compiler.
cdc7bbd5 220#rustc = "/path/to/rustc"
ea8adc8c 221
c295e0f8 222# Instead of download the src/stage0.json version of rustfmt specified,
dfeec247 223# use this rustfmt binary instead as the stage0 snapshot rustfmt.
cdc7bbd5 224#rustfmt = "/path/to/rustfmt"
dfeec247 225
ea8adc8c
XL
226# Flag to specify whether any documentation is built. If false, rustdoc and
227# friends will still be compiled but they will not be used to generate any
228# documentation.
229#docs = true
230
6a06907d
XL
231# Flag to specify whether CSS, JavaScript, and HTML are minified when
232# docs are generated. JSON is always minified, because it's enormous,
233# and generated in already-minified form from the beginning.
234#docs-minification = true
235
ea8adc8c
XL
236# Indicate whether the compiler should be documented in addition to the standard
237# library and facade crates.
238#compiler-docs = false
239
e1599b0c 240# Indicate whether git submodules are managed and updated automatically.
ea8adc8c
XL
241#submodules = true
242
e1599b0c 243# Update git submodules only when the checked out commit in the submodules differs
0531ce1d
XL
244# from what is committed in the main rustc repo.
245#fast-submodules = true
246
ea8adc8c
XL
247# The path to (or name of) the GDB executable to use. This is only used for
248# executing the debuginfo test suite.
249#gdb = "gdb"
250
251# The node.js executable to use. Note that this is only used for the emscripten
252# target when running tests, otherwise this can be omitted.
253#nodejs = "node"
254
255# Python interpreter to use for various tasks throughout the build, notably
256# rustdoc tests, the lldb python interpreter, and some dist bits and pieces.
532ac7d7 257#
f035d41b 258# Defaults to the Python interpreter used to execute x.py
ba9703b0 259#python = "python"
ea8adc8c
XL
260
261# Force Cargo to check that Cargo.lock describes the precise dependency
262# set that all the Cargo.toml files create, instead of updating it.
263#locked-deps = false
264
265# Indicate whether the vendored sources are used for Rust dependencies or not
266#vendor = false
267
dfeec247 268# Typically the build system will build the Rust compiler twice. The second
ea8adc8c
XL
269# compiler, however, will simply use its own libraries to link against. If you
270# would rather to perform a full bootstrap, compiling the compiler three times,
271# then you can set this option to true. You shouldn't ever need to set this
272# option to true.
273#full-bootstrap = false
274
dfeec247 275# Enable a build of the extended Rust tool set which is not only the compiler
ea8adc8c
XL
276# but also tools such as Cargo. This will also produce "combined installers"
277# which are used to install Rust and Cargo together. This is disabled by
dfeec247
XL
278# default. The `tools` option (immediately below) specifies which tools should
279# be built if `extended = true`.
ea8adc8c
XL
280#extended = false
281
cdc7bbd5
XL
282# Installs chosen set of extended tools if `extended = true`. By default builds
283# all extended tools except `rust-demangler`, unless the target is also being
284# built with `profiler = true`. If chosen tool failed to build the installation
285# fails. If `extended = false`, this option is ignored.
286#tools = ["cargo", "rls", "clippy", "rustfmt", "analysis", "src"] # + "rust-demangler" if `profiler`
2c00a5a8 287
ea8adc8c
XL
288# Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose
289#verbose = 0
290
291# Build the sanitizer runtimes
292#sanitizers = false
293
f035d41b 294# Build the profiler runtime (required when compiling with options that depend
5099ac24 295# on this runtime, such as `-C profile-generate` or `-C instrument-coverage`).
ea8adc8c
XL
296#profiler = false
297
0bf4aa26
XL
298# Indicates whether the native libraries linked into Cargo will be statically
299# linked or not.
300#cargo-native-static = false
ea8adc8c
XL
301
302# Run the build with low priority, by setting the process group's "nice" value
303# to +10 on Unix platforms, and by using a "low priority" job object on Windows.
304#low-priority = false
305
306# Arguments passed to the `./configure` script, used during distcheck. You
307# probably won't fill this in but rather it's filled in by the `./configure`
308# script.
309#configure-args = []
310
311# Indicates that a local rebuild is occurring instead of a full bootstrap,
312# essentially skipping stage0 as the local compiler is recompiling itself again.
313#local-rebuild = false
314
0531ce1d
XL
315# Print out how long each rustbuild step took (mostly intended for CI and
316# tracking over time)
317#print-step-timings = false
318
6a06907d
XL
319# Print out resource usage data for each rustbuild step, as defined by the Unix
320# struct rusage. (Note that this setting is completely unstable: the data it
321# captures, what platforms it supports, the format of its associated output, and
322# this setting's very existence, are all subject to change.)
323#print-step-rusage = false
324
c295e0f8
XL
325# Always patch binaries for usage with Nix toolchains. If `true` then binaries
326# will be patched unconditionally. If `false` or unset, binaries will be patched
327# only if the current distribution is NixOS. This option is useful when using
328# a Nix toolchain on non-NixOS distributions.
329#patch-binaries-for-nix = false
330
ea8adc8c
XL
331# =============================================================================
332# General install configuration options
333# =============================================================================
334[install]
335
336# Instead of installing to /usr/local, install to this path instead.
337#prefix = "/usr/local"
338
339# Where to install system configuration files
340# If this is a relative path, it will get installed in `prefix` above
341#sysconfdir = "/etc"
342
343# Where to install documentation in `prefix` above
344#docdir = "share/doc/rust"
345
346# Where to install binaries in `prefix` above
347#bindir = "bin"
348
349# Where to install libraries in `prefix` above
350#libdir = "lib"
351
352# Where to install man pages in `prefix` above
353#mandir = "share/man"
354
cdc7bbd5 355# Where to install data in `prefix` above
abe05a73
XL
356#datadir = "share"
357
ea8adc8c
XL
358# =============================================================================
359# Options for compiling Rust code itself
360# =============================================================================
361[rust]
362
0bf4aa26 363# Whether or not to optimize the compiler and standard library.
e74abb32
XL
364# WARNING: Building with optimize = false is NOT SUPPORTED. Due to bootstrapping,
365# building without optimizations takes much longer than optimizing. Further, some platforms
366# fail to build without this optimization (c.f. #65352).
ea8adc8c
XL
367#optimize = true
368
0bf4aa26
XL
369# Indicates that the build should be configured for debugging Rust. A
370# `debug`-enabled compiler and standard library will be somewhat
371# slower (due to e.g. checking of debug assertions) but should remain
372# usable.
373#
374# Note: If this value is set to `true`, it will affect a number of
375# configuration options below as well, if they have been left
376# unconfigured in this file.
377#
378# Note: changes to the `debug` setting do *not* affect `optimize`
379# above. In theory, a "maximally debuggable" environment would
380# set `optimize` to `false` above to assist the introspection
381# facilities of debuggers like lldb and gdb. To recreate such an
382# environment, explicitly set `optimize` to `false` and `debug`
383# to `true`. In practice, everyone leaves `optimize` set to
384# `true`, because an unoptimized rustc with debugging
385# enabled becomes *unusably slow* (e.g. rust-lang/rust#24840
386# reported a 25x slowdown) and bootstrapping the supposed
387# "maximally debuggable" environment (notably libstd) takes
388# hours to build.
389#
390#debug = false
391
6a06907d
XL
392# Whether to download the stage 1 and 2 compilers from CI.
393# This is mostly useful for tools; if you have changes to `compiler/` they will be ignored.
394#
cdc7bbd5 395# You can set this to "if-unchanged" to only download if `compiler/` has not been modified.
6a06907d
XL
396#download-rustc = false
397
ea8adc8c
XL
398# Number of codegen units to use for each compiler invocation. A value of 0
399# means "the number of cores on this machine", and 1+ is passed through to the
400# compiler.
1b1a35ee
XL
401#
402# Uses the rustc defaults: https://doc.rust-lang.org/rustc/codegen-options/index.html#codegen-units
403#codegen-units = if incremental { 256 } else { 16 }
ea8adc8c 404
a1dfa0c6
XL
405# Sets the number of codegen units to build the standard library with,
406# regardless of what the codegen-unit setting for the rest of the compiler is.
cdc7bbd5
XL
407# NOTE: building with anything other than 1 is known to occasionally have bugs.
408# See https://github.com/rust-lang/rust/issues/83600.
409#codegen-units-std = codegen-units
a1dfa0c6 410
ea8adc8c 411# Whether or not debug assertions are enabled for the compiler and standard
f035d41b
XL
412# library. Debug assertions control the maximum log level used by rustc. When
413# enabled calls to `trace!` and `debug!` macros are preserved in the compiled
414# binary, otherwise they are omitted.
415#
416# Defaults to rust.debug value
29967ef6 417#debug-assertions = rust.debug (boolean)
f9f354fc
XL
418
419# Whether or not debug assertions are enabled for the standard library.
420# Overrides the `debug-assertions` option, if defined.
f035d41b
XL
421#
422# Defaults to rust.debug-assertions value
29967ef6 423#debug-assertions-std = rust.debug-assertions (boolean)
1b1a35ee
XL
424
425# Whether or not to leave debug! and trace! calls in the rust binary.
426# Overrides the `debug-assertions` option, if defined.
427#
428# Defaults to rust.debug-assertions value
29967ef6
XL
429#
430# If you see a message from `tracing` saying
431# `max_level_info` is enabled and means logging won't be shown,
432# set this value to `true`.
433#debug-logging = rust.debug-assertions (boolean)
ea8adc8c 434
c295e0f8
XL
435# Whether or not overflow checks are enabled for the compiler and standard
436# library.
437#
438# Defaults to rust.debug value
439#overflow-checks = rust.debug (boolean)
440
441# Whether or not overflow checks are enabled for the standard library.
442# Overrides the `overflow-checks` option, if defined.
443#
444# Defaults to rust.overflow-checks value
445#overflow-checks-std = rust.overflow-checks (boolean)
446
dc9dc135
XL
447# Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
448# `0` - no debug info
f035d41b
XL
449# `1` - line tables only - sufficient to generate backtraces that include line
450# information and inlined functions, set breakpoints at source code
451# locations, and step through execution in a debugger.
dc9dc135 452# `2` - full debug info with variable and type information
74b04a01 453# Can be overridden for specific subsets of Rust code (rustc, std or tools).
dc9dc135
XL
454# Debuginfo for tests run with compiletest is not controlled by this option
455# and needs to be enabled separately with `debuginfo-level-tests`.
f035d41b 456#
3dfed10e
XL
457# Note that debuginfo-level = 2 generates several gigabytes of debuginfo
458# and will slow down the linking process significantly.
459#
460# Defaults to 1 if debug is true
f035d41b 461#debuginfo-level = 0
ea8adc8c 462
dc9dc135 463# Debuginfo level for the compiler.
cdc7bbd5 464#debuginfo-level-rustc = debuginfo-level
ea8adc8c 465
dc9dc135 466# Debuginfo level for the standard library.
cdc7bbd5 467#debuginfo-level-std = debuginfo-level
ea8adc8c 468
dc9dc135 469# Debuginfo level for the tools.
cdc7bbd5 470#debuginfo-level-tools = debuginfo-level
dc9dc135
XL
471
472# Debuginfo level for the test suites run with compiletest.
473# FIXME(#61117): Some tests fail when this option is enabled.
474#debuginfo-level-tests = 0
83c7162d 475
fc512014
XL
476# Whether to run `dsymutil` on Apple platforms to gather debug info into .dSYM
477# bundles. `dsymutil` adds time to builds for no clear benefit, and also makes
478# it more difficult for debuggers to find debug info. The compiler currently
479# defaults to running `dsymutil` to preserve its historical default, but when
480# compiling the compiler itself, we skip it by default since we know it's safe
481# to do so in that case.
482#run-dsymutil = false
483
ea8adc8c
XL
484# Whether or not `panic!`s generate backtraces (RUST_BACKTRACE)
485#backtrace = true
486
94b46f34
XL
487# Whether to always use incremental compilation when building rustc
488#incremental = false
489
9fa01778 490# Build a multi-threaded rustc
1b1a35ee 491# FIXME(#75760): Some UI tests fail when this option is enabled.
9fa01778 492#parallel-compiler = false
0531ce1d 493
a2a8927a
XL
494# The default linker that will be hard-coded into the generated
495# compiler for targets that don't specify a default linker explicitly
496# in their target specifications. Note that this is not the linker
497# used to link said compiler. It can also be set per-target (via the
498# `[target.<triple>]` block), which may be useful in a cross-compilation
499# setting.
cdc7bbd5
XL
500#
501# See https://doc.rust-lang.org/rustc/codegen-options/index.html#linker for more information.
502#default-linker = <none> (path)
ea8adc8c 503
ea8adc8c
XL
504# The "channel" for the Rust build to produce. The stable/beta channels only
505# allow using stable features, whereas the nightly and dev channels allow using
506# nightly features
507#channel = "dev"
508
fc512014
XL
509# A descriptive string to be appended to `rustc --version` output, which is
510# also used in places like debuginfo `DW_AT_producer`. This may be useful for
511# supplementary build information, like distro-specific package versions.
cdc7bbd5 512#description = <none> (string)
fc512014 513
cdc7bbd5
XL
514# The root location of the musl installation directory. The library directory
515# will also need to contain libunwind.a for an unwinding implementation. Note
516# that this option only makes sense for musl targets that produce statically
517# linked binaries.
518#
519# Defaults to /usr on musl hosts. Has no default otherwise.
520#musl-root = <platform specific> (path)
e74abb32 521
ea8adc8c
XL
522# By default the `rustc` executable is built with `-Wl,-rpath` flags on Unix
523# platforms to ensure that the compiler is usable by default from the build
524# directory (as it links to a number of dynamic libraries). This may not be
525# desired in distributions, for example.
526#rpath = true
527
1b1a35ee 528# Prints each test name as it is executed, to help debug issues in the test harness itself.
94b46f34 529#verbose-tests = false
ea8adc8c 530
dc9dc135 531# Flag indicating whether tests are compiled with optimizations (the -O flag).
ea8adc8c 532#optimize-tests = true
ea8adc8c
XL
533
534# Flag indicating whether codegen tests will be run or not. If you get an error
535# saying that the FileCheck executable is missing, you may want to disable this.
0bf4aa26 536# Also see the target's llvm-filecheck option.
ea8adc8c
XL
537#codegen-tests = true
538
539# Flag indicating whether git info will be retrieved from .git automatically.
540# Having the git information can cause a lot of rebuilds during development.
2c00a5a8 541# Note: If this attribute is not explicitly set (e.g. if left commented out) it
ea8adc8c 542# will default to true if channel = "dev", but will default to false otherwise.
cdc7bbd5 543#ignore-git = if channel == "dev" { true } else { false }
ea8adc8c
XL
544
545# When creating source tarballs whether or not to create a source tarball.
cdc7bbd5 546#dist-src = true
ea8adc8c 547
ff7c6d11
XL
548# After building or testing extended tools (e.g. clippy and rustfmt), append the
549# result (broken, compiling, testing) into this JSON file.
cdc7bbd5 550#save-toolstates = <none> (path)
ff7c6d11 551
2c00a5a8
XL
552# This is an array of the codegen backends that will be compiled for the rustc
553# that's being compiled. The default is to only build the LLVM codegen backend,
ee023bcb
FG
554# and currently the only standard options supported are `"llvm"`, `"cranelift"`
555# and `"gcc"`. The first backend in this list will be used as default by rustc
556# when no explicit backend is specified.
2c00a5a8
XL
557#codegen-backends = ["llvm"]
558
0531ce1d
XL
559# Indicates whether LLD will be compiled and made available in the sysroot for
560# rustc to execute.
561#lld = false
562
74b04a01
XL
563# Indicates whether LLD will be used to link Rust crates during bootstrap on
564# supported platforms. The LLD from the bootstrap distribution will be used
565# and not the LLD compiled during the bootstrap.
566#
1b1a35ee 567# LLD will not be used if we're cross linking.
74b04a01 568#
3dfed10e 569# Explicitly setting the linker for a target will override this option when targeting MSVC.
74b04a01
XL
570#use-lld = false
571
8faf50e0
XL
572# Indicates whether some LLVM tools, like llvm-objdump, will be made available in the
573# sysroot.
574#llvm-tools = false
575
83c7162d
XL
576# Whether to deny warnings in crates
577#deny-warnings = true
578
579# Print backtrace on internal compiler errors during bootstrap
580#backtrace-on-ice = false
581
8faf50e0
XL
582# Whether to verify generated LLVM IR
583#verify-llvm-ir = false
584
dfeec247
XL
585# Compile the compiler with a non-default ThinLTO import limit. This import
586# limit controls the maximum size of functions imported by ThinLTO. Decreasing
587# will make code compile faster at the expense of lower runtime performance.
cdc7bbd5 588#thin-lto-import-instr-limit = if incremental { 10 } else { LLVM default (currently 100) }
dfeec247 589
3dfed10e 590# Map debuginfo paths to `/rust/$sha/...`, generally only set for releases
b7449926
XL
591#remap-debuginfo = false
592
a1dfa0c6
XL
593# Link the compiler against `jemalloc`, where on Linux and OSX it should
594# override the default allocator for rustc and LLVM.
595#jemalloc = false
596
597# Run tests in various test suites with the "nll compare mode" in addition to
598# running the tests in normal mode. Largely only used on CI and during local
599# development of NLL
600#test-compare-mode = false
601
532ac7d7 602# Use LLVM libunwind as the implementation for Rust's unwinder.
29967ef6 603# Accepted values are 'in-tree' (formerly true), 'system' or 'no' (formerly false).
17df50a5
XL
604# This option only applies for Linux and Fuchsia targets.
605# On Linux target, if crt-static is not enabled, 'no' means dynamic link to
606# `libgcc_s.so`, 'in-tree' means static link to the in-tree build of llvm libunwind
607# and 'system' means dynamic link to `libunwind.so`. If crt-static is enabled,
136023e0
XL
608# the behavior is depend on the libc. On musl target, 'no' and 'in-tree' both
609# means static link to the in-tree build of llvm libunwind, and 'system' means
17df50a5
XL
610# static link to `libunwind.a` provided by system. Due to the limitation of glibc,
611# it must link to `libgcc_eh.a` to get a working output, and this option have no effect.
29967ef6 612#llvm-libunwind = 'no'
532ac7d7 613
74b04a01
XL
614# Enable Windows Control Flow Guard checks in the standard library.
615# This only applies from stage 1 onwards, and only for Windows targets.
616#control-flow-guard = false
617
3dfed10e
XL
618# Enable symbol-mangling-version v0. This can be helpful when profiling rustc,
619# as generics will be preserved in symbols (rather than erased into opaque T).
3c0e092e
XL
620# When no setting is given, the new scheme will be used when compiling the
621# compiler and its tools and the legacy scheme will be used when compiling the
622# standard library.
623# If an explicit setting is given, it will be used for all parts of the codebase.
624#new-symbol-mangling = true|false (see comment)
3dfed10e 625
ea8adc8c
XL
626# =============================================================================
627# Options for specific targets
628#
629# Each of the following options is scoped to the specific target triple in
630# question and is used for determining how to compile each target.
631# =============================================================================
632[target.x86_64-unknown-linux-gnu]
633
cdc7bbd5 634# C compiler to be used to compile C code. Note that the
ea8adc8c
XL
635# default value is platform specific, and if not specified it may also depend on
636# what platform is crossing to what platform.
cdc7bbd5
XL
637# See `src/bootstrap/cc_detect.rs` for details.
638#cc = "cc" (path)
ea8adc8c 639
cdc7bbd5 640# C++ compiler to be used to compile C++ code (e.g. LLVM and our LLVM shims).
ea8adc8c 641# This is only used for host targets.
cdc7bbd5
XL
642# See `src/bootstrap/cc_detect.rs` for details.
643#cxx = "c++" (path)
ea8adc8c 644
abe05a73
XL
645# Archiver to be used to assemble static libraries compiled from C/C++ code.
646# Note: an absolute path should be used, otherwise LLVM build will break.
cdc7bbd5 647#ar = "ar" (path)
abe05a73 648
b7449926
XL
649# Ranlib to be used to assemble static libraries compiled from C/C++ code.
650# Note: an absolute path should be used, otherwise LLVM build will break.
cdc7bbd5 651#ranlib = "ranlib" (path)
b7449926 652
cdc7bbd5 653# Linker to be used to bootstrap Rust code. Note that the
abe05a73
XL
654# default value is platform specific, and if not specified it may also depend on
655# what platform is crossing to what platform.
3dfed10e 656# Setting this will override the `use-lld` option for Rust code when targeting MSVC.
cdc7bbd5 657#linker = "cc" (path)
abe05a73 658
ea8adc8c 659# Path to the `llvm-config` binary of the installation of a custom LLVM to link
2c00a5a8 660# against. Note that if this is specified we don't compile LLVM at all for this
ea8adc8c 661# target.
cdc7bbd5 662#llvm-config = <none> (path)
ea8adc8c 663
0bf4aa26
XL
664# Normally the build system can find LLVM's FileCheck utility, but if
665# not, you can specify an explicit file name for it.
cdc7bbd5 666#llvm-filecheck = "/path/to/llvm-version/bin/FileCheck"
0bf4aa26 667
ea8adc8c
XL
668# If this target is for Android, this option will be required to specify where
669# the NDK for the target lives. This is used to find the C compiler to link and
670# build native code.
cdc7bbd5
XL
671# See `src/bootstrap/cc_detect.rs` for details.
672#android-ndk = <none> (path)
ea8adc8c 673
29967ef6
XL
674# Build the sanitizer runtimes for this target.
675# This option will override the same option under [build] section.
cdc7bbd5 676#sanitizers = build.sanitizers (bool)
29967ef6
XL
677
678# Build the profiler runtime for this target(required when compiling with options that depend
5099ac24 679# on this runtime, such as `-C profile-generate` or `-C instrument-coverage`).
29967ef6 680# This option will override the same option under [build] section.
cdc7bbd5 681#profiler = build.profiler (bool)
29967ef6 682
ea8adc8c
XL
683# Force static or dynamic linkage of the standard library for this target. If
684# this target is a host for rustc, this will also affect the linkage of the
685# compiler itself. This is useful for building rustc on targets that normally
686# only use static libraries. If unset, the target's default linkage is used.
cdc7bbd5 687#crt-static = <platform-specific> (bool)
ea8adc8c 688
f035d41b 689# The root location of the musl installation directory. The library directory
ea8adc8c 690# will also need to contain libunwind.a for an unwinding implementation. Note
f035d41b 691# that this option only makes sense for musl targets that produce statically
cdc7bbd5
XL
692# linked binaries.
693#musl-root = build.musl-root (path)
ea8adc8c 694
f035d41b
XL
695# The full path to the musl libdir.
696#musl-libdir = musl-root/lib
697
6a06907d
XL
698# The root location of the `wasm32-wasi` sysroot. Only used for the
699# `wasm32-wasi` target. If you are building wasm32-wasi target, make sure to
700# create a `[target.wasm32-wasi]` section and move this field there.
cdc7bbd5 701#wasi-root = <none> (path)
532ac7d7 702
ea8adc8c
XL
703# Used in testing for configuring where the QEMU images are located, you
704# probably don't want to use this.
cdc7bbd5 705#qemu-rootfs = <none> (path)
ea8adc8c
XL
706
707# =============================================================================
708# Distribution options
709#
710# These options are related to distribution, mostly for the Rust project itself.
711# You probably won't need to concern yourself with any of these options
712# =============================================================================
713[dist]
714
715# This is the folder of artifacts that the build system will sign. All files in
716# this directory will be signed with the default gpg key using the system `gpg`
717# binary. The `asc` and `sha256` files will all be output into the standard dist
718# output folder (currently `build/dist`)
719#
720# This folder should be populated ahead of time before the build system is
721# invoked.
cdc7bbd5 722#sign-folder = <none> (path)
ea8adc8c
XL
723
724# The remote address that all artifacts will eventually be uploaded to. The
725# build system generates manifests which will point to these urls, and for the
726# manifests to be correct they'll have to have the right URLs encoded.
727#
728# Note that this address should not contain a trailing slash as file names will
729# be appended to it.
cdc7bbd5 730#upload-addr = <none> (URL)
ea8adc8c
XL
731
732# Whether to build a plain source tarball to upload
733# We disable that on Windows not to override the one already uploaded on S3
734# as the one built on Windows will contain backslashes in paths causing problems
735# on linux
736#src-tarball = true
0bf4aa26
XL
737
738# Whether to allow failures when building tools
739#missing-tools = false
5869c6ff
XL
740
741# List of compression formats to use when generating dist tarballs. The list of
742# formats is provided to rust-installer, which must support all of them.
cdc7bbd5
XL
743#
744# This list must be non-empty.
5869c6ff 745#compression-formats = ["gz", "xz"]