1 # Sample TOML configuration file for building Rust.
3 # To configure rustbuild, copy this file to the directory from which you will be
4 # running the build, and name it config.toml.
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
12 # =============================================================================
13 # Tweaking how LLVM is compiled
14 # =============================================================================
17 # Indicates whether LLVM rebuild should be skipped when running bootstrap. If
18 # this is `false` then the compiler's LLVM will be rebuilt whenever the built
19 # version doesn't have the correct hash. If it is `true` then LLVM will never
20 # be rebuilt. The default value is `false`.
23 # Indicates whether the LLVM build is a Release or Debug build
26 # Indicates whether LLVM should be built with ThinLTO. Note that this will
27 # only succeed if you use clang, lld, llvm-ar, and llvm-ranlib in your C/C++
28 # toolchain (see the `cc`, `cxx`, `linker`, `ar`, and `ranlib` options below).
29 # More info at: https://clang.llvm.org/docs/ThinLTO.html#clang-bootstrap
32 # Indicates whether an LLVM Release build should include debug info
33 #release-debuginfo = false
35 # Indicates whether the LLVM assertions are enabled or not
38 # Indicates whether ccache is used when building LLVM
40 # or alternatively ...
41 #ccache = "/path/to/ccache"
43 # If an external LLVM root is specified, we automatically check the version by
44 # default to make sure it's within the range that we're expecting, but setting
45 # this flag will indicate that this version check should not be done.
48 # Link libstdc++ statically into the librustc_llvm instead of relying on a
49 # dynamic version to be available.
50 #static-libstdcpp = false
52 # Tell the LLVM build system to use Ninja instead of the platform default for
53 # the generated build system. This can sometimes be faster than make, for
57 # LLVM targets to build support for.
58 # Note: this is NOT related to Rust compilation targets. However, as Rust is
59 # dependent on LLVM for code generation, turning targets off here WILL lead to
60 # the resulting rustc being unable to compile for the disabled architectures.
61 # Also worth pointing out is that, in case support for new targets are added to
62 # LLVM, enabling them here doesn't mean Rust is automatically gaining said
63 # support. You'll need to write a target specification at least, and most
64 # likely, teach rustc about the C ABI of the target. Get in touch with the
65 # Rust team and file an issue if you need assistance in porting!
66 #targets = "AArch64;ARM;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;Sparc;SystemZ;WebAssembly;X86"
68 # LLVM experimental targets to build support for. These targets are specified in
69 # the same format as above, but since these targets are experimental, they are
70 # not built by default and the experimental Rust compilation targets that depend
71 # on them will not work unless the user opts in to building them.
72 #experimental-targets = "AVR"
74 # Cap the number of parallel linker invocations when compiling LLVM.
75 # This can be useful when building LLVM with debug info, which significantly
76 # increases the size of binaries and consequently the memory required by
77 # each linker process.
78 # If absent or 0, linker invocations are treated like any other job and
79 # controlled by rustbuild's -j parameter.
82 # When invoking `llvm-config` this configures whether the `--shared` argument is
83 # passed to prefer linking to shared libraries.
86 # When building llvm, this configures what is being appended to the version.
87 # The default is "-rust-$version-$channel", except for dev channel where rustc
88 # version number is omitted. To use LLVM version as is, provide an empty string.
89 #version-suffix = "-rust-dev"
91 # On MSVC you can compile LLVM with clang-cl, but the test suite doesn't pass
92 # with clang-cl, so this is special in that it only compiles LLVM with clang-cl
93 #clang-cl = '/path/to/clang-cl.exe'
95 # Pass extra compiler and linker flags to the LLVM CMake build.
96 #cflags = "-fextra-flag"
97 #cxxflags = "-fextra-flag"
98 #ldflags = "-Wl,extra-flag"
100 # Use libc++ when building LLVM instead of libstdc++. This is the default on
101 # platforms already use libc++ as the default C++ library, but this option
102 # allows you to use libc++ even on platforms when it's not. You need to ensure
103 # that your host compiler ships with libc++.
106 # The value specified here will be passed as `-DLLVM_USE_LINKER` to CMake.
109 # Whether or not to specify `-DLLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN=YES`
110 #allow-old-toolchain = false
112 # =============================================================================
113 # General build configuration options
114 # =============================================================================
117 # Build triple for the original snapshot compiler. This must be a compiler that
118 # nightlies are already produced for. The current platform must be able to run
119 # binaries of this build triple and the nightly will be used to bootstrap the
121 #build = "x86_64-unknown-linux-gnu" # defaults to your host platform
123 # In addition to the build triple, other triples to produce full compiler
124 # toolchains for. Each of these triples will be bootstrapped from the build
125 # triple and then will continue to bootstrap themselves. This platform must
126 # 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 # In addition to all host triples, other triples to produce the standard library
130 # for. Each host triple will be used to produce a copy of the standard library
131 # for each target triple.
132 #target = ["x86_64-unknown-linux-gnu"] # defaults to just the build triple
134 # Use this directory to store build artifacts.
135 # You can use "$ROOT" to indicate the root of the git repository.
138 # Instead of downloading the src/stage0.txt version of Cargo specified, use
139 # this Cargo binary instead to build all Rust code
140 #cargo = "/path/to/bin/cargo"
142 # Instead of downloading the src/stage0.txt version of the compiler
143 # specified, use this rustc binary instead as the stage0 snapshot compiler.
144 #rustc = "/path/to/bin/rustc"
146 # Instead of download the src/stage0.txt version of rustfmt specified,
147 # use this rustfmt binary instead as the stage0 snapshot rustfmt.
148 #rustfmt = "/path/to/bin/rustfmt"
150 # Flag to specify whether any documentation is built. If false, rustdoc and
151 # friends will still be compiled but they will not be used to generate any
155 # Indicate whether the compiler should be documented in addition to the standard
156 # library and facade crates.
157 #compiler-docs = false
159 # Indicate whether git submodules are managed and updated automatically.
162 # Update git submodules only when the checked out commit in the submodules differs
163 # from what is committed in the main rustc repo.
164 #fast-submodules = true
166 # The path to (or name of) the GDB executable to use. This is only used for
167 # executing the debuginfo test suite.
170 # The node.js executable to use. Note that this is only used for the emscripten
171 # target when running tests, otherwise this can be omitted.
174 # Python interpreter to use for various tasks throughout the build, notably
175 # rustdoc tests, the lldb python interpreter, and some dist bits and pieces.
177 # Defaults to the Python interpreter used to execute x.py.
180 # Force Cargo to check that Cargo.lock describes the precise dependency
181 # set that all the Cargo.toml files create, instead of updating it.
184 # Indicate whether the vendored sources are used for Rust dependencies or not
187 # Typically the build system will build the Rust compiler twice. The second
188 # compiler, however, will simply use its own libraries to link against. If you
189 # would rather to perform a full bootstrap, compiling the compiler three times,
190 # then you can set this option to true. You shouldn't ever need to set this
192 #full-bootstrap = false
194 # Enable a build of the extended Rust tool set which is not only the compiler
195 # but also tools such as Cargo. This will also produce "combined installers"
196 # which are used to install Rust and Cargo together. This is disabled by
197 # default. The `tools` option (immediately below) specifies which tools should
198 # be built if `extended = true`.
201 # Installs chosen set of extended tools if `extended = true`. By default builds all.
202 # If chosen tool failed to build the installation fails. If `extended = false`, this
204 #tools = ["cargo", "rls", "clippy", "rustfmt", "analysis", "src"]
206 # Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose
209 # Build the sanitizer runtimes
212 # Build the profiler runtime (required when compiling with options that depend
213 # on this runtime, such as `-C profile-generate` or `-Z instrument-coverage`).
216 # Indicates whether the native libraries linked into Cargo will be statically
218 #cargo-native-static = false
220 # Run the build with low priority, by setting the process group's "nice" value
221 # to +10 on Unix platforms, and by using a "low priority" job object on Windows.
222 #low-priority = false
224 # Arguments passed to the `./configure` script, used during distcheck. You
225 # probably won't fill this in but rather it's filled in by the `./configure`
229 # Indicates that a local rebuild is occurring instead of a full bootstrap,
230 # essentially skipping stage0 as the local compiler is recompiling itself again.
231 #local-rebuild = false
233 # Print out how long each rustbuild step took (mostly intended for CI and
234 # tracking over time)
235 #print-step-timings = false
237 # =============================================================================
238 # General install configuration options
239 # =============================================================================
242 # Instead of installing to /usr/local, install to this path instead.
243 #prefix = "/usr/local"
245 # Where to install system configuration files
246 # If this is a relative path, it will get installed in `prefix` above
249 # Where to install documentation in `prefix` above
250 #docdir = "share/doc/rust"
252 # Where to install binaries in `prefix` above
255 # Where to install libraries in `prefix` above
258 # Where to install man pages in `prefix` above
259 #mandir = "share/man"
261 # Where to install data in `prefix` above (currently unused)
264 # Where to install additional info in `prefix` above (currently unused)
265 #infodir = "share/info"
267 # Where to install local state (currently unused)
268 # If this is a relative path, it will get installed in `prefix` above
269 #localstatedir = "/var/lib"
271 # =============================================================================
272 # Options for compiling Rust code itself
273 # =============================================================================
276 # Whether or not to optimize the compiler and standard library.
277 # WARNING: Building with optimize = false is NOT SUPPORTED. Due to bootstrapping,
278 # building without optimizations takes much longer than optimizing. Further, some platforms
279 # fail to build without this optimization (c.f. #65352).
282 # Indicates that the build should be configured for debugging Rust. A
283 # `debug`-enabled compiler and standard library will be somewhat
284 # slower (due to e.g. checking of debug assertions) but should remain
287 # Note: If this value is set to `true`, it will affect a number of
288 # configuration options below as well, if they have been left
289 # unconfigured in this file.
291 # Note: changes to the `debug` setting do *not* affect `optimize`
292 # above. In theory, a "maximally debuggable" environment would
293 # set `optimize` to `false` above to assist the introspection
294 # facilities of debuggers like lldb and gdb. To recreate such an
295 # environment, explicitly set `optimize` to `false` and `debug`
296 # to `true`. In practice, everyone leaves `optimize` set to
297 # `true`, because an unoptimized rustc with debugging
298 # enabled becomes *unusably slow* (e.g. rust-lang/rust#24840
299 # reported a 25x slowdown) and bootstrapping the supposed
300 # "maximally debuggable" environment (notably libstd) takes
305 # Number of codegen units to use for each compiler invocation. A value of 0
306 # means "the number of cores on this machine", and 1+ is passed through to the
310 # Sets the number of codegen units to build the standard library with,
311 # regardless of what the codegen-unit setting for the rest of the compiler is.
312 #codegen-units-std = 1
314 # Whether or not debug assertions are enabled for the compiler and standard
316 #debug-assertions = debug
318 # Whether or not debug assertions are enabled for the standard library.
319 # Overrides the `debug-assertions` option, if defined.
320 #debug-assertions-std = debug-assertions
322 # Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
323 # `0` - no debug info
324 # `1` - line tables only
325 # `2` - full debug info with variable and type information
326 # Can be overridden for specific subsets of Rust code (rustc, std or tools).
327 # Debuginfo for tests run with compiletest is not controlled by this option
328 # and needs to be enabled separately with `debuginfo-level-tests`.
329 #debuginfo-level = if debug { 2 } else { 0 }
331 # Debuginfo level for the compiler.
332 #debuginfo-level-rustc = debuginfo-level
334 # Debuginfo level for the standard library.
335 #debuginfo-level-std = debuginfo-level
337 # Debuginfo level for the tools.
338 #debuginfo-level-tools = debuginfo-level
340 # Debuginfo level for the test suites run with compiletest.
341 # FIXME(#61117): Some tests fail when this option is enabled.
342 #debuginfo-level-tests = 0
344 # Whether or not `panic!`s generate backtraces (RUST_BACKTRACE)
347 # Whether to always use incremental compilation when building rustc
350 # Build a multi-threaded rustc
351 #parallel-compiler = false
353 # The default linker that will be hard-coded into the generated compiler for
354 # targets that don't specify linker explicitly in their target specifications.
355 # Note that this is not the linker used to link said compiler.
356 #default-linker = "cc"
358 # The "channel" for the Rust build to produce. The stable/beta channels only
359 # allow using stable features, whereas the nightly and dev channels allow using
363 # The root location of the MUSL installation directory.
366 # By default the `rustc` executable is built with `-Wl,-rpath` flags on Unix
367 # platforms to ensure that the compiler is usable by default from the build
368 # directory (as it links to a number of dynamic libraries). This may not be
369 # desired in distributions, for example.
372 # Emits extraneous output from tests to ensure that failures of the test
373 # harness are debuggable just from logfiles.
374 #verbose-tests = false
376 # Flag indicating whether tests are compiled with optimizations (the -O flag).
377 #optimize-tests = true
379 # Flag indicating whether codegen tests will be run or not. If you get an error
380 # saying that the FileCheck executable is missing, you may want to disable this.
381 # Also see the target's llvm-filecheck option.
382 #codegen-tests = true
384 # Flag indicating whether git info will be retrieved from .git automatically.
385 # Having the git information can cause a lot of rebuilds during development.
386 # Note: If this attribute is not explicitly set (e.g. if left commented out) it
387 # will default to true if channel = "dev", but will default to false otherwise.
390 # When creating source tarballs whether or not to create a source tarball.
393 # After building or testing extended tools (e.g. clippy and rustfmt), append the
394 # result (broken, compiling, testing) into this JSON file.
395 #save-toolstates = "/path/to/toolstates.json"
397 # This is an array of the codegen backends that will be compiled for the rustc
398 # that's being compiled. The default is to only build the LLVM codegen backend,
399 # and currently the only standard option supported is `"llvm"`
400 #codegen-backends = ["llvm"]
402 # Indicates whether LLD will be compiled and made available in the sysroot for
406 # Indicates whether LLD will be used to link Rust crates during bootstrap on
407 # supported platforms. The LLD from the bootstrap distribution will be used
408 # and not the LLD compiled during the bootstrap.
410 # LLD will not be used if we're cross linking or running tests.
412 # Explicitly setting the linker for a target will override this option.
415 # Indicates whether some LLVM tools, like llvm-objdump, will be made available in the
419 # Whether to deny warnings in crates
420 #deny-warnings = true
422 # Print backtrace on internal compiler errors during bootstrap
423 #backtrace-on-ice = false
425 # Whether to verify generated LLVM IR
426 #verify-llvm-ir = false
428 # Compile the compiler with a non-default ThinLTO import limit. This import
429 # limit controls the maximum size of functions imported by ThinLTO. Decreasing
430 # will make code compile faster at the expense of lower runtime performance.
431 # If `incremental` is set to true above, the import limit will default to 10
432 # instead of LLVM's default of 100.
433 #thin-lto-import-instr-limit = 100
435 # Map all debuginfo paths for libstd and crates to `/rust/$sha/$crate/...`,
436 # generally only set for releases
437 #remap-debuginfo = false
439 # Link the compiler against `jemalloc`, where on Linux and OSX it should
440 # override the default allocator for rustc and LLVM.
443 # Run tests in various test suites with the "nll compare mode" in addition to
444 # running the tests in normal mode. Largely only used on CI and during local
446 #test-compare-mode = false
448 # Use LLVM libunwind as the implementation for Rust's unwinder.
449 #llvm-libunwind = false
451 # Enable Windows Control Flow Guard checks in the standard library.
452 # This only applies from stage 1 onwards, and only for Windows targets.
453 #control-flow-guard = false
455 # =============================================================================
456 # Options for specific targets
458 # Each of the following options is scoped to the specific target triple in
459 # question and is used for determining how to compile each target.
460 # =============================================================================
461 [target.x86_64-unknown-linux-gnu]
463 # C compiler to be used to compiler C code. Note that the
464 # default value is platform specific, and if not specified it may also depend on
465 # what platform is crossing to what platform.
468 # C++ compiler to be used to compiler C++ code (e.g. LLVM and our LLVM shims).
469 # This is only used for host targets.
472 # Archiver to be used to assemble static libraries compiled from C/C++ code.
473 # Note: an absolute path should be used, otherwise LLVM build will break.
476 # Ranlib to be used to assemble static libraries compiled from C/C++ code.
477 # Note: an absolute path should be used, otherwise LLVM build will break.
480 # Linker to be used to link Rust code. Note that the
481 # default value is platform specific, and if not specified it may also depend on
482 # what platform is crossing to what platform.
483 # Setting this will override the `use-lld` option for Rust code.
486 # Path to the `llvm-config` binary of the installation of a custom LLVM to link
487 # against. Note that if this is specified we don't compile LLVM at all for this
489 #llvm-config = "../path/to/llvm/root/bin/llvm-config"
491 # Normally the build system can find LLVM's FileCheck utility, but if
492 # not, you can specify an explicit file name for it.
493 #llvm-filecheck = "/path/to/FileCheck"
495 # If this target is for Android, this option will be required to specify where
496 # the NDK for the target lives. This is used to find the C compiler to link and
498 #android-ndk = "/path/to/ndk"
500 # Force static or dynamic linkage of the standard library for this target. If
501 # this target is a host for rustc, this will also affect the linkage of the
502 # compiler itself. This is useful for building rustc on targets that normally
503 # only use static libraries. If unset, the target's default linkage is used.
506 # The root location of the MUSL installation directory. The library directory
507 # will also need to contain libunwind.a for an unwinding implementation. Note
508 # that this option only makes sense for MUSL targets that produce statically
512 # The root location of the `wasm32-wasi` sysroot.
515 # Used in testing for configuring where the QEMU images are located, you
516 # probably don't want to use this.
519 # =============================================================================
520 # Distribution options
522 # These options are related to distribution, mostly for the Rust project itself.
523 # You probably won't need to concern yourself with any of these options
524 # =============================================================================
527 # This is the folder of artifacts that the build system will sign. All files in
528 # this directory will be signed with the default gpg key using the system `gpg`
529 # binary. The `asc` and `sha256` files will all be output into the standard dist
530 # output folder (currently `build/dist`)
532 # This folder should be populated ahead of time before the build system is
534 #sign-folder = "path/to/folder/to/sign"
536 # This is a file which contains the password of the default gpg key. This will
537 # be passed to `gpg` down the road when signing all files in `sign-folder`
538 # above. This should be stored in plaintext.
539 #gpg-password-file = "path/to/gpg/password"
541 # The remote address that all artifacts will eventually be uploaded to. The
542 # build system generates manifests which will point to these urls, and for the
543 # manifests to be correct they'll have to have the right URLs encoded.
545 # Note that this address should not contain a trailing slash as file names will
547 #upload-addr = "https://example.com/folder"
549 # Whether to build a plain source tarball to upload
550 # We disable that on Windows not to override the one already uploaded on S3
551 # as the one built on Windows will contain backslashes in paths causing problems
556 # Whether to allow failures when building tools
557 #missing-tools = false