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 # 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.
18 # =============================================================================
20 # =============================================================================
22 # Use different pre-set defaults than the global defaults.
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`).
28 # =============================================================================
29 # Tweaking how LLVM is compiled
30 # =============================================================================
33 # Whether to use Rust CI built LLVM instead of locally building it.
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.
38 # It's currently false by default due to being newly added; please file bugs if
39 # enabling this did not work for you on x86_64-unknown-linux-gnu.
40 # Other target triples are currently not supported; see #77084.
42 # We also currently only support this when building LLVM for the build triple.
44 # Note that many of the LLVM options are not currently supported for
45 # downloading. Currently only the "assertions" option can be toggled.
46 #download-ci-llvm = false
48 # Indicates whether LLVM rebuild should be skipped when running bootstrap. If
49 # this is `false` then the compiler's LLVM will be rebuilt whenever the built
50 # version doesn't have the correct hash. If it is `true` then LLVM will never
51 # be rebuilt. The default value is `false`.
54 # Indicates whether the LLVM build is a Release or Debug build
57 # Indicates whether LLVM should be built with ThinLTO. Note that this will
58 # only succeed if you use clang, lld, llvm-ar, and llvm-ranlib in your C/C++
59 # toolchain (see the `cc`, `cxx`, `linker`, `ar`, and `ranlib` options below).
60 # More info at: https://clang.llvm.org/docs/ThinLTO.html#clang-bootstrap
63 # Indicates whether an LLVM Release build should include debug info
64 #release-debuginfo = false
66 # Indicates whether the LLVM assertions are enabled or not
69 # Indicates whether ccache is used when building LLVM
71 # or alternatively ...
72 #ccache = "/path/to/ccache"
74 # If an external LLVM root is specified, we automatically check the version by
75 # default to make sure it's within the range that we're expecting, but setting
76 # this flag will indicate that this version check should not be done.
79 # Link libstdc++ statically into the rustc_llvm instead of relying on a
80 # dynamic version to be available.
81 #static-libstdcpp = false
83 # Whether to use Ninja to build LLVM. This runs much faster than make.
86 # LLVM targets to build support for.
87 # Note: this is NOT related to Rust compilation targets. However, as Rust is
88 # dependent on LLVM for code generation, turning targets off here WILL lead to
89 # the resulting rustc being unable to compile for the disabled architectures.
90 # Also worth pointing out is that, in case support for new targets are added to
91 # LLVM, enabling them here doesn't mean Rust is automatically gaining said
92 # support. You'll need to write a target specification at least, and most
93 # likely, teach rustc about the C ABI of the target. Get in touch with the
94 # Rust team and file an issue if you need assistance in porting!
95 #targets = "AArch64;ARM;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;Sparc;SystemZ;WebAssembly;X86"
97 # LLVM experimental targets to build support for. These targets are specified in
98 # the same format as above, but since these targets are experimental, they are
99 # not built by default and the experimental Rust compilation targets that depend
100 # on them will not work unless the user opts in to building them.
101 #experimental-targets = "AVR"
103 # Cap the number of parallel linker invocations when compiling LLVM.
104 # This can be useful when building LLVM with debug info, which significantly
105 # increases the size of binaries and consequently the memory required by
106 # each linker process.
107 # If absent or 0, linker invocations are treated like any other job and
108 # controlled by rustbuild's -j parameter.
111 # When invoking `llvm-config` this configures whether the `--shared` argument is
112 # passed to prefer linking to shared libraries.
115 # When building llvm, this configures what is being appended to the version.
116 # The default is "-rust-$version-$channel", except for dev channel where rustc
117 # version number is omitted. To use LLVM version as is, provide an empty string.
118 #version-suffix = "-rust-dev"
120 # On MSVC you can compile LLVM with clang-cl, but the test suite doesn't pass
121 # with clang-cl, so this is special in that it only compiles LLVM with clang-cl
122 #clang-cl = '/path/to/clang-cl.exe'
124 # Pass extra compiler and linker flags to the LLVM CMake build.
125 #cflags = "-fextra-flag"
126 #cxxflags = "-fextra-flag"
127 #ldflags = "-Wl,extra-flag"
129 # Use libc++ when building LLVM instead of libstdc++. This is the default on
130 # platforms already use libc++ as the default C++ library, but this option
131 # allows you to use libc++ even on platforms when it's not. You need to ensure
132 # that your host compiler ships with libc++.
135 # The value specified here will be passed as `-DLLVM_USE_LINKER` to CMake.
138 # Whether or not to specify `-DLLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN=YES`
139 #allow-old-toolchain = false
141 # Whether to include the Polly optimizer.
144 # =============================================================================
145 # General build configuration options
146 # =============================================================================
148 # The default stage to use for the `doc` subcommand
151 # The default stage to use for the `build` subcommand
154 # The default stage to use for the `test` subcommand
157 # The default stage to use for the `dist` subcommand
160 # The default stage to use for the `install` subcommand
163 # The default stage to use for the `bench` subcommand
166 # Build triple for the original snapshot compiler. This must be a compiler that
167 # nightlies are already produced for. The current platform must be able to run
168 # binaries of this build triple and the nightly will be used to bootstrap the
171 # Defaults to host platform
172 #build = "x86_64-unknown-linux-gnu"
174 # Which triples to produce a compiler toolchain for. Each of these triples will
175 # be bootstrapped from the build triple themselves.
177 # Defaults to just the build triple
178 #host = ["x86_64-unknown-linux-gnu"]
180 # Which triples to build libraries (core/alloc/std/test/proc_macro) for. Each of
181 # these triples will be bootstrapped from the build triple themselves.
183 # Defaults to `host`. If you set this explicitly, you likely want to add all
184 # host triples to this list as well in order for those host toolchains to be
185 # able to compile programs for their native target.
186 #target = ["x86_64-unknown-linux-gnu"]
188 # Use this directory to store build artifacts.
189 # You can use "$ROOT" to indicate the root of the git repository.
192 # Instead of downloading the src/stage0.txt version of Cargo specified, use
193 # this Cargo binary instead to build all Rust code
194 #cargo = "/path/to/bin/cargo"
196 # Instead of downloading the src/stage0.txt version of the compiler
197 # specified, use this rustc binary instead as the stage0 snapshot compiler.
198 #rustc = "/path/to/bin/rustc"
200 # Instead of download the src/stage0.txt version of rustfmt specified,
201 # use this rustfmt binary instead as the stage0 snapshot rustfmt.
202 #rustfmt = "/path/to/bin/rustfmt"
204 # Flag to specify whether any documentation is built. If false, rustdoc and
205 # friends will still be compiled but they will not be used to generate any
209 # Indicate whether the compiler should be documented in addition to the standard
210 # library and facade crates.
211 #compiler-docs = false
213 # Indicate whether git submodules are managed and updated automatically.
216 # Update git submodules only when the checked out commit in the submodules differs
217 # from what is committed in the main rustc repo.
218 #fast-submodules = true
220 # The path to (or name of) the GDB executable to use. This is only used for
221 # executing the debuginfo test suite.
224 # The node.js executable to use. Note that this is only used for the emscripten
225 # target when running tests, otherwise this can be omitted.
228 # Python interpreter to use for various tasks throughout the build, notably
229 # rustdoc tests, the lldb python interpreter, and some dist bits and pieces.
231 # Defaults to the Python interpreter used to execute x.py
234 # Force Cargo to check that Cargo.lock describes the precise dependency
235 # set that all the Cargo.toml files create, instead of updating it.
238 # Indicate whether the vendored sources are used for Rust dependencies or not
241 # Typically the build system will build the Rust compiler twice. The second
242 # compiler, however, will simply use its own libraries to link against. If you
243 # would rather to perform a full bootstrap, compiling the compiler three times,
244 # then you can set this option to true. You shouldn't ever need to set this
246 #full-bootstrap = false
248 # Enable a build of the extended Rust tool set which is not only the compiler
249 # but also tools such as Cargo. This will also produce "combined installers"
250 # which are used to install Rust and Cargo together. This is disabled by
251 # default. The `tools` option (immediately below) specifies which tools should
252 # be built if `extended = true`.
255 # Installs chosen set of extended tools if `extended = true`. By default builds all.
256 # If chosen tool failed to build the installation fails. If `extended = false`, this
258 #tools = ["cargo", "rls", "clippy", "rustfmt", "analysis", "src"]
260 # Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose
263 # Build the sanitizer runtimes
266 # Build the profiler runtime (required when compiling with options that depend
267 # on this runtime, such as `-C profile-generate` or `-Z instrument-coverage`).
270 # Indicates whether the native libraries linked into Cargo will be statically
272 #cargo-native-static = false
274 # Run the build with low priority, by setting the process group's "nice" value
275 # to +10 on Unix platforms, and by using a "low priority" job object on Windows.
276 #low-priority = false
278 # Arguments passed to the `./configure` script, used during distcheck. You
279 # probably won't fill this in but rather it's filled in by the `./configure`
283 # Indicates that a local rebuild is occurring instead of a full bootstrap,
284 # essentially skipping stage0 as the local compiler is recompiling itself again.
285 #local-rebuild = false
287 # Print out how long each rustbuild step took (mostly intended for CI and
288 # tracking over time)
289 #print-step-timings = false
291 # =============================================================================
292 # General install configuration options
293 # =============================================================================
296 # Instead of installing to /usr/local, install to this path instead.
297 #prefix = "/usr/local"
299 # Where to install system configuration files
300 # If this is a relative path, it will get installed in `prefix` above
303 # Where to install documentation in `prefix` above
304 #docdir = "share/doc/rust"
306 # Where to install binaries in `prefix` above
309 # Where to install libraries in `prefix` above
312 # Where to install man pages in `prefix` above
313 #mandir = "share/man"
315 # Where to install data in `prefix` above (currently unused)
318 # Where to install additional info in `prefix` above (currently unused)
319 #infodir = "share/info"
321 # Where to install local state (currently unused)
322 # If this is a relative path, it will get installed in `prefix` above
323 #localstatedir = "/var/lib"
325 # =============================================================================
326 # Options for compiling Rust code itself
327 # =============================================================================
330 # Whether or not to optimize the compiler and standard library.
331 # WARNING: Building with optimize = false is NOT SUPPORTED. Due to bootstrapping,
332 # building without optimizations takes much longer than optimizing. Further, some platforms
333 # fail to build without this optimization (c.f. #65352).
336 # Indicates that the build should be configured for debugging Rust. A
337 # `debug`-enabled compiler and standard library will be somewhat
338 # slower (due to e.g. checking of debug assertions) but should remain
341 # Note: If this value is set to `true`, it will affect a number of
342 # configuration options below as well, if they have been left
343 # unconfigured in this file.
345 # Note: changes to the `debug` setting do *not* affect `optimize`
346 # above. In theory, a "maximally debuggable" environment would
347 # set `optimize` to `false` above to assist the introspection
348 # facilities of debuggers like lldb and gdb. To recreate such an
349 # environment, explicitly set `optimize` to `false` and `debug`
350 # to `true`. In practice, everyone leaves `optimize` set to
351 # `true`, because an unoptimized rustc with debugging
352 # enabled becomes *unusably slow* (e.g. rust-lang/rust#24840
353 # reported a 25x slowdown) and bootstrapping the supposed
354 # "maximally debuggable" environment (notably libstd) takes
359 # Number of codegen units to use for each compiler invocation. A value of 0
360 # means "the number of cores on this machine", and 1+ is passed through to the
363 # Uses the rustc defaults: https://doc.rust-lang.org/rustc/codegen-options/index.html#codegen-units
364 #codegen-units = if incremental { 256 } else { 16 }
366 # Sets the number of codegen units to build the standard library with,
367 # regardless of what the codegen-unit setting for the rest of the compiler is.
368 #codegen-units-std = 1
370 # Whether or not debug assertions are enabled for the compiler and standard
371 # library. Debug assertions control the maximum log level used by rustc. When
372 # enabled calls to `trace!` and `debug!` macros are preserved in the compiled
373 # binary, otherwise they are omitted.
375 # Defaults to rust.debug value
376 #debug-assertions = rust.debug (boolean)
378 # Whether or not debug assertions are enabled for the standard library.
379 # Overrides the `debug-assertions` option, if defined.
381 # Defaults to rust.debug-assertions value
382 #debug-assertions-std = rust.debug-assertions (boolean)
384 # Whether or not to leave debug! and trace! calls in the rust binary.
385 # Overrides the `debug-assertions` option, if defined.
387 # Defaults to rust.debug-assertions value
389 # If you see a message from `tracing` saying
390 # `max_level_info` is enabled and means logging won't be shown,
391 # set this value to `true`.
392 #debug-logging = rust.debug-assertions (boolean)
394 # Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
395 # `0` - no debug info
396 # `1` - line tables only - sufficient to generate backtraces that include line
397 # information and inlined functions, set breakpoints at source code
398 # locations, and step through execution in a debugger.
399 # `2` - full debug info with variable and type information
400 # Can be overridden for specific subsets of Rust code (rustc, std or tools).
401 # Debuginfo for tests run with compiletest is not controlled by this option
402 # and needs to be enabled separately with `debuginfo-level-tests`.
404 # Note that debuginfo-level = 2 generates several gigabytes of debuginfo
405 # and will slow down the linking process significantly.
407 # Defaults to 1 if debug is true
410 # Debuginfo level for the compiler.
412 # Defaults to rust.debuginfo-level value
413 #debuginfo-level-rustc = 0
415 # Debuginfo level for the standard library.
417 # Defaults to rust.debuginfo-level value
418 #debuginfo-level-std = 0
420 # Debuginfo level for the tools.
422 # Defaults to rust.debuginfo-level value
423 #debuginfo-level-tools = 0
425 # Debuginfo level for the test suites run with compiletest.
426 # FIXME(#61117): Some tests fail when this option is enabled.
427 #debuginfo-level-tests = 0
429 # Whether or not `panic!`s generate backtraces (RUST_BACKTRACE)
432 # Whether to always use incremental compilation when building rustc
435 # Build a multi-threaded rustc
436 # FIXME(#75760): Some UI tests fail when this option is enabled.
437 #parallel-compiler = false
439 # The default linker that will be hard-coded into the generated compiler for
440 # targets that don't specify linker explicitly in their target specifications.
441 # Note that this is not the linker used to link said compiler.
442 #default-linker = "cc"
444 # The "channel" for the Rust build to produce. The stable/beta channels only
445 # allow using stable features, whereas the nightly and dev channels allow using
449 # The root location of the musl installation directory.
452 # By default the `rustc` executable is built with `-Wl,-rpath` flags on Unix
453 # platforms to ensure that the compiler is usable by default from the build
454 # directory (as it links to a number of dynamic libraries). This may not be
455 # desired in distributions, for example.
458 # Prints each test name as it is executed, to help debug issues in the test harness itself.
459 #verbose-tests = false
461 # Flag indicating whether tests are compiled with optimizations (the -O flag).
462 #optimize-tests = true
464 # Flag indicating whether codegen tests will be run or not. If you get an error
465 # saying that the FileCheck executable is missing, you may want to disable this.
466 # Also see the target's llvm-filecheck option.
467 #codegen-tests = true
469 # Flag indicating whether git info will be retrieved from .git automatically.
470 # Having the git information can cause a lot of rebuilds during development.
471 # Note: If this attribute is not explicitly set (e.g. if left commented out) it
472 # will default to true if channel = "dev", but will default to false otherwise.
475 # When creating source tarballs whether or not to create a source tarball.
478 # After building or testing extended tools (e.g. clippy and rustfmt), append the
479 # result (broken, compiling, testing) into this JSON file.
480 #save-toolstates = "/path/to/toolstates.json"
482 # This is an array of the codegen backends that will be compiled for the rustc
483 # that's being compiled. The default is to only build the LLVM codegen backend,
484 # and currently the only standard options supported are `"llvm"` and `"cranelift"`.
485 #codegen-backends = ["llvm"]
487 # Indicates whether LLD will be compiled and made available in the sysroot for
491 # Indicates whether LLD will be used to link Rust crates during bootstrap on
492 # supported platforms. The LLD from the bootstrap distribution will be used
493 # and not the LLD compiled during the bootstrap.
495 # LLD will not be used if we're cross linking.
497 # Explicitly setting the linker for a target will override this option when targeting MSVC.
500 # Indicates whether some LLVM tools, like llvm-objdump, will be made available in the
504 # Whether to deny warnings in crates
505 #deny-warnings = true
507 # Print backtrace on internal compiler errors during bootstrap
508 #backtrace-on-ice = false
510 # Whether to verify generated LLVM IR
511 #verify-llvm-ir = false
513 # Compile the compiler with a non-default ThinLTO import limit. This import
514 # limit controls the maximum size of functions imported by ThinLTO. Decreasing
515 # will make code compile faster at the expense of lower runtime performance.
516 # If `incremental` is set to true above, the import limit will default to 10
517 # instead of LLVM's default of 100.
518 #thin-lto-import-instr-limit = 100
520 # Map debuginfo paths to `/rust/$sha/...`, generally only set for releases
521 #remap-debuginfo = false
523 # Link the compiler against `jemalloc`, where on Linux and OSX it should
524 # override the default allocator for rustc and LLVM.
527 # Run tests in various test suites with the "nll compare mode" in addition to
528 # running the tests in normal mode. Largely only used on CI and during local
530 #test-compare-mode = false
532 # Use LLVM libunwind as the implementation for Rust's unwinder.
533 # Accepted values are 'in-tree' (formerly true), 'system' or 'no' (formerly false).
534 #llvm-libunwind = 'no'
536 # Enable Windows Control Flow Guard checks in the standard library.
537 # This only applies from stage 1 onwards, and only for Windows targets.
538 #control-flow-guard = false
540 # Enable symbol-mangling-version v0. This can be helpful when profiling rustc,
541 # as generics will be preserved in symbols (rather than erased into opaque T).
542 #new-symbol-mangling = false
544 # =============================================================================
545 # Options for specific targets
547 # Each of the following options is scoped to the specific target triple in
548 # question and is used for determining how to compile each target.
549 # =============================================================================
550 [target.x86_64-unknown-linux-gnu]
552 # C compiler to be used to compiler C code. Note that the
553 # default value is platform specific, and if not specified it may also depend on
554 # what platform is crossing to what platform.
557 # C++ compiler to be used to compiler C++ code (e.g. LLVM and our LLVM shims).
558 # This is only used for host targets.
561 # Archiver to be used to assemble static libraries compiled from C/C++ code.
562 # Note: an absolute path should be used, otherwise LLVM build will break.
565 # Ranlib to be used to assemble static libraries compiled from C/C++ code.
566 # Note: an absolute path should be used, otherwise LLVM build will break.
569 # Linker to be used to link Rust code. Note that the
570 # default value is platform specific, and if not specified it may also depend on
571 # what platform is crossing to what platform.
572 # Setting this will override the `use-lld` option for Rust code when targeting MSVC.
575 # Path to the `llvm-config` binary of the installation of a custom LLVM to link
576 # against. Note that if this is specified we don't compile LLVM at all for this
578 #llvm-config = "../path/to/llvm/root/bin/llvm-config"
580 # Normally the build system can find LLVM's FileCheck utility, but if
581 # not, you can specify an explicit file name for it.
582 #llvm-filecheck = "/path/to/FileCheck"
584 # If this target is for Android, this option will be required to specify where
585 # the NDK for the target lives. This is used to find the C compiler to link and
587 #android-ndk = "/path/to/ndk"
589 # Build the sanitizer runtimes for this target.
590 # This option will override the same option under [build] section.
593 # Build the profiler runtime for this target(required when compiling with options that depend
594 # on this runtime, such as `-C profile-generate` or `-Z instrument-coverage`).
595 # This option will override the same option under [build] section.
598 # Force static or dynamic linkage of the standard library for this target. If
599 # this target is a host for rustc, this will also affect the linkage of the
600 # compiler itself. This is useful for building rustc on targets that normally
601 # only use static libraries. If unset, the target's default linkage is used.
604 # The root location of the musl installation directory. The library directory
605 # will also need to contain libunwind.a for an unwinding implementation. Note
606 # that this option only makes sense for musl targets that produce statically
610 # The full path to the musl libdir.
611 #musl-libdir = musl-root/lib
613 # The root location of the `wasm32-wasi` sysroot.
616 # Used in testing for configuring where the QEMU images are located, you
617 # probably don't want to use this.
620 # =============================================================================
621 # Distribution options
623 # These options are related to distribution, mostly for the Rust project itself.
624 # You probably won't need to concern yourself with any of these options
625 # =============================================================================
628 # This is the folder of artifacts that the build system will sign. All files in
629 # this directory will be signed with the default gpg key using the system `gpg`
630 # binary. The `asc` and `sha256` files will all be output into the standard dist
631 # output folder (currently `build/dist`)
633 # This folder should be populated ahead of time before the build system is
635 #sign-folder = "path/to/folder/to/sign"
637 # This is a file which contains the password of the default gpg key. This will
638 # be passed to `gpg` down the road when signing all files in `sign-folder`
639 # above. This should be stored in plaintext.
640 #gpg-password-file = "path/to/gpg/password"
642 # The remote address that all artifacts will eventually be uploaded to. The
643 # build system generates manifests which will point to these urls, and for the
644 # manifests to be correct they'll have to have the right URLs encoded.
646 # Note that this address should not contain a trailing slash as file names will
648 #upload-addr = "https://example.com/folder"
650 # Whether to build a plain source tarball to upload
651 # We disable that on Windows not to override the one already uploaded on S3
652 # as the one built on Windows will contain backslashes in paths causing problems
657 # Whether to allow failures when building tools
658 #missing-tools = false