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 # =============================================================================
142 # General build configuration options
143 # =============================================================================
145 # The default stage to use for the `doc` subcommand
148 # The default stage to use for the `build` subcommand
151 # The default stage to use for the `test` subcommand
154 # The default stage to use for the `dist` subcommand
157 # The default stage to use for the `install` subcommand
160 # The default stage to use for the `bench` subcommand
163 # Build triple for the original snapshot compiler. This must be a compiler that
164 # nightlies are already produced for. The current platform must be able to run
165 # binaries of this build triple and the nightly will be used to bootstrap the
168 # Defaults to host platform
169 #build = "x86_64-unknown-linux-gnu"
171 # Which triples to produce a compiler toolchain for. Each of these triples will
172 # be bootstrapped from the build triple themselves.
174 # Defaults to just the build triple
175 #host = ["x86_64-unknown-linux-gnu"]
177 # Which triples to build libraries (core/alloc/std/test/proc_macro) for. Each of
178 # these triples will be bootstrapped from the build triple themselves.
180 # Defaults to `host`. If you set this explicitly, you likely want to add all
181 # host triples to this list as well in order for those host toolchains to be
182 # able to compile programs for their native target.
183 #target = ["x86_64-unknown-linux-gnu"]
185 # Use this directory to store build artifacts.
186 # You can use "$ROOT" to indicate the root of the git repository.
189 # Instead of downloading the src/stage0.txt version of Cargo specified, use
190 # this Cargo binary instead to build all Rust code
191 #cargo = "/path/to/bin/cargo"
193 # Instead of downloading the src/stage0.txt version of the compiler
194 # specified, use this rustc binary instead as the stage0 snapshot compiler.
195 #rustc = "/path/to/bin/rustc"
197 # Instead of download the src/stage0.txt version of rustfmt specified,
198 # use this rustfmt binary instead as the stage0 snapshot rustfmt.
199 #rustfmt = "/path/to/bin/rustfmt"
201 # Flag to specify whether any documentation is built. If false, rustdoc and
202 # friends will still be compiled but they will not be used to generate any
206 # Indicate whether the compiler should be documented in addition to the standard
207 # library and facade crates.
208 #compiler-docs = false
210 # Indicate whether git submodules are managed and updated automatically.
213 # Update git submodules only when the checked out commit in the submodules differs
214 # from what is committed in the main rustc repo.
215 #fast-submodules = true
217 # The path to (or name of) the GDB executable to use. This is only used for
218 # executing the debuginfo test suite.
221 # The node.js executable to use. Note that this is only used for the emscripten
222 # target when running tests, otherwise this can be omitted.
225 # Python interpreter to use for various tasks throughout the build, notably
226 # rustdoc tests, the lldb python interpreter, and some dist bits and pieces.
228 # Defaults to the Python interpreter used to execute x.py
231 # Force Cargo to check that Cargo.lock describes the precise dependency
232 # set that all the Cargo.toml files create, instead of updating it.
235 # Indicate whether the vendored sources are used for Rust dependencies or not
238 # Typically the build system will build the Rust compiler twice. The second
239 # compiler, however, will simply use its own libraries to link against. If you
240 # would rather to perform a full bootstrap, compiling the compiler three times,
241 # then you can set this option to true. You shouldn't ever need to set this
243 #full-bootstrap = false
245 # Enable a build of the extended Rust tool set which is not only the compiler
246 # but also tools such as Cargo. This will also produce "combined installers"
247 # which are used to install Rust and Cargo together. This is disabled by
248 # default. The `tools` option (immediately below) specifies which tools should
249 # be built if `extended = true`.
252 # Installs chosen set of extended tools if `extended = true`. By default builds all.
253 # If chosen tool failed to build the installation fails. If `extended = false`, this
255 #tools = ["cargo", "rls", "clippy", "rustfmt", "analysis", "src"]
257 # Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose
260 # Build the sanitizer runtimes
263 # Build the profiler runtime (required when compiling with options that depend
264 # on this runtime, such as `-C profile-generate` or `-Z instrument-coverage`).
267 # Indicates whether the native libraries linked into Cargo will be statically
269 #cargo-native-static = false
271 # Run the build with low priority, by setting the process group's "nice" value
272 # to +10 on Unix platforms, and by using a "low priority" job object on Windows.
273 #low-priority = false
275 # Arguments passed to the `./configure` script, used during distcheck. You
276 # probably won't fill this in but rather it's filled in by the `./configure`
280 # Indicates that a local rebuild is occurring instead of a full bootstrap,
281 # essentially skipping stage0 as the local compiler is recompiling itself again.
282 #local-rebuild = false
284 # Print out how long each rustbuild step took (mostly intended for CI and
285 # tracking over time)
286 #print-step-timings = false
288 # =============================================================================
289 # General install configuration options
290 # =============================================================================
293 # Instead of installing to /usr/local, install to this path instead.
294 #prefix = "/usr/local"
296 # Where to install system configuration files
297 # If this is a relative path, it will get installed in `prefix` above
300 # Where to install documentation in `prefix` above
301 #docdir = "share/doc/rust"
303 # Where to install binaries in `prefix` above
306 # Where to install libraries in `prefix` above
309 # Where to install man pages in `prefix` above
310 #mandir = "share/man"
312 # Where to install data in `prefix` above (currently unused)
315 # Where to install additional info in `prefix` above (currently unused)
316 #infodir = "share/info"
318 # Where to install local state (currently unused)
319 # If this is a relative path, it will get installed in `prefix` above
320 #localstatedir = "/var/lib"
322 # =============================================================================
323 # Options for compiling Rust code itself
324 # =============================================================================
327 # Whether or not to optimize the compiler and standard library.
328 # WARNING: Building with optimize = false is NOT SUPPORTED. Due to bootstrapping,
329 # building without optimizations takes much longer than optimizing. Further, some platforms
330 # fail to build without this optimization (c.f. #65352).
333 # Indicates that the build should be configured for debugging Rust. A
334 # `debug`-enabled compiler and standard library will be somewhat
335 # slower (due to e.g. checking of debug assertions) but should remain
338 # Note: If this value is set to `true`, it will affect a number of
339 # configuration options below as well, if they have been left
340 # unconfigured in this file.
342 # Note: changes to the `debug` setting do *not* affect `optimize`
343 # above. In theory, a "maximally debuggable" environment would
344 # set `optimize` to `false` above to assist the introspection
345 # facilities of debuggers like lldb and gdb. To recreate such an
346 # environment, explicitly set `optimize` to `false` and `debug`
347 # to `true`. In practice, everyone leaves `optimize` set to
348 # `true`, because an unoptimized rustc with debugging
349 # enabled becomes *unusably slow* (e.g. rust-lang/rust#24840
350 # reported a 25x slowdown) and bootstrapping the supposed
351 # "maximally debuggable" environment (notably libstd) takes
356 # Number of codegen units to use for each compiler invocation. A value of 0
357 # means "the number of cores on this machine", and 1+ is passed through to the
360 # Uses the rustc defaults: https://doc.rust-lang.org/rustc/codegen-options/index.html#codegen-units
361 #codegen-units = if incremental { 256 } else { 16 }
363 # Sets the number of codegen units to build the standard library with,
364 # regardless of what the codegen-unit setting for the rest of the compiler is.
365 #codegen-units-std = 1
367 # Whether or not debug assertions are enabled for the compiler and standard
368 # library. Debug assertions control the maximum log level used by rustc. When
369 # enabled calls to `trace!` and `debug!` macros are preserved in the compiled
370 # binary, otherwise they are omitted.
372 # Defaults to rust.debug value
373 #debug-assertions = rust.debug (boolean)
375 # Whether or not debug assertions are enabled for the standard library.
376 # Overrides the `debug-assertions` option, if defined.
378 # Defaults to rust.debug-assertions value
379 #debug-assertions-std = rust.debug-assertions (boolean)
381 # Whether or not to leave debug! and trace! calls in the rust binary.
382 # Overrides the `debug-assertions` option, if defined.
384 # Defaults to rust.debug-assertions value
386 # If you see a message from `tracing` saying
387 # `max_level_info` is enabled and means logging won't be shown,
388 # set this value to `true`.
389 #debug-logging = rust.debug-assertions (boolean)
391 # Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
392 # `0` - no debug info
393 # `1` - line tables only - sufficient to generate backtraces that include line
394 # information and inlined functions, set breakpoints at source code
395 # locations, and step through execution in a debugger.
396 # `2` - full debug info with variable and type information
397 # Can be overridden for specific subsets of Rust code (rustc, std or tools).
398 # Debuginfo for tests run with compiletest is not controlled by this option
399 # and needs to be enabled separately with `debuginfo-level-tests`.
401 # Note that debuginfo-level = 2 generates several gigabytes of debuginfo
402 # and will slow down the linking process significantly.
404 # Defaults to 1 if debug is true
407 # Debuginfo level for the compiler.
409 # Defaults to rust.debuginfo-level value
410 #debuginfo-level-rustc = 0
412 # Debuginfo level for the standard library.
414 # Defaults to rust.debuginfo-level value
415 #debuginfo-level-std = 0
417 # Debuginfo level for the tools.
419 # Defaults to rust.debuginfo-level value
420 #debuginfo-level-tools = 0
422 # Debuginfo level for the test suites run with compiletest.
423 # FIXME(#61117): Some tests fail when this option is enabled.
424 #debuginfo-level-tests = 0
426 # Whether or not `panic!`s generate backtraces (RUST_BACKTRACE)
429 # Whether to always use incremental compilation when building rustc
432 # Build a multi-threaded rustc
433 # FIXME(#75760): Some UI tests fail when this option is enabled.
434 #parallel-compiler = false
436 # The default linker that will be hard-coded into the generated compiler for
437 # targets that don't specify linker explicitly in their target specifications.
438 # Note that this is not the linker used to link said compiler.
439 #default-linker = "cc"
441 # The "channel" for the Rust build to produce. The stable/beta channels only
442 # allow using stable features, whereas the nightly and dev channels allow using
446 # The root location of the musl installation directory.
449 # By default the `rustc` executable is built with `-Wl,-rpath` flags on Unix
450 # platforms to ensure that the compiler is usable by default from the build
451 # directory (as it links to a number of dynamic libraries). This may not be
452 # desired in distributions, for example.
455 # Prints each test name as it is executed, to help debug issues in the test harness itself.
456 #verbose-tests = false
458 # Flag indicating whether tests are compiled with optimizations (the -O flag).
459 #optimize-tests = true
461 # Flag indicating whether codegen tests will be run or not. If you get an error
462 # saying that the FileCheck executable is missing, you may want to disable this.
463 # Also see the target's llvm-filecheck option.
464 #codegen-tests = true
466 # Flag indicating whether git info will be retrieved from .git automatically.
467 # Having the git information can cause a lot of rebuilds during development.
468 # Note: If this attribute is not explicitly set (e.g. if left commented out) it
469 # will default to true if channel = "dev", but will default to false otherwise.
472 # When creating source tarballs whether or not to create a source tarball.
475 # After building or testing extended tools (e.g. clippy and rustfmt), append the
476 # result (broken, compiling, testing) into this JSON file.
477 #save-toolstates = "/path/to/toolstates.json"
479 # This is an array of the codegen backends that will be compiled for the rustc
480 # that's being compiled. The default is to only build the LLVM codegen backend,
481 # and currently the only standard option supported is `"llvm"`
482 #codegen-backends = ["llvm"]
484 # Indicates whether LLD will be compiled and made available in the sysroot for
488 # Indicates whether LLD will be used to link Rust crates during bootstrap on
489 # supported platforms. The LLD from the bootstrap distribution will be used
490 # and not the LLD compiled during the bootstrap.
492 # LLD will not be used if we're cross linking.
494 # Explicitly setting the linker for a target will override this option when targeting MSVC.
497 # Indicates whether some LLVM tools, like llvm-objdump, will be made available in the
501 # Whether to deny warnings in crates
502 #deny-warnings = true
504 # Print backtrace on internal compiler errors during bootstrap
505 #backtrace-on-ice = false
507 # Whether to verify generated LLVM IR
508 #verify-llvm-ir = false
510 # Compile the compiler with a non-default ThinLTO import limit. This import
511 # limit controls the maximum size of functions imported by ThinLTO. Decreasing
512 # will make code compile faster at the expense of lower runtime performance.
513 # If `incremental` is set to true above, the import limit will default to 10
514 # instead of LLVM's default of 100.
515 #thin-lto-import-instr-limit = 100
517 # Map debuginfo paths to `/rust/$sha/...`, generally only set for releases
518 #remap-debuginfo = false
520 # Link the compiler against `jemalloc`, where on Linux and OSX it should
521 # override the default allocator for rustc and LLVM.
524 # Run tests in various test suites with the "nll compare mode" in addition to
525 # running the tests in normal mode. Largely only used on CI and during local
527 #test-compare-mode = false
529 # Use LLVM libunwind as the implementation for Rust's unwinder.
530 #llvm-libunwind = false
532 # Enable Windows Control Flow Guard checks in the standard library.
533 # This only applies from stage 1 onwards, and only for Windows targets.
534 #control-flow-guard = false
536 # Enable symbol-mangling-version v0. This can be helpful when profiling rustc,
537 # as generics will be preserved in symbols (rather than erased into opaque T).
538 #new-symbol-mangling = false
540 # =============================================================================
541 # Options for specific targets
543 # Each of the following options is scoped to the specific target triple in
544 # question and is used for determining how to compile each target.
545 # =============================================================================
546 [target.x86_64-unknown-linux-gnu]
548 # C compiler to be used to compiler C code. Note that the
549 # default value is platform specific, and if not specified it may also depend on
550 # what platform is crossing to what platform.
553 # C++ compiler to be used to compiler C++ code (e.g. LLVM and our LLVM shims).
554 # This is only used for host targets.
557 # Archiver to be used to assemble static libraries compiled from C/C++ code.
558 # Note: an absolute path should be used, otherwise LLVM build will break.
561 # Ranlib 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 # Linker to be used to link Rust code. Note that the
566 # default value is platform specific, and if not specified it may also depend on
567 # what platform is crossing to what platform.
568 # Setting this will override the `use-lld` option for Rust code when targeting MSVC.
571 # Path to the `llvm-config` binary of the installation of a custom LLVM to link
572 # against. Note that if this is specified we don't compile LLVM at all for this
574 #llvm-config = "../path/to/llvm/root/bin/llvm-config"
576 # Normally the build system can find LLVM's FileCheck utility, but if
577 # not, you can specify an explicit file name for it.
578 #llvm-filecheck = "/path/to/FileCheck"
580 # If this target is for Android, this option will be required to specify where
581 # the NDK for the target lives. This is used to find the C compiler to link and
583 #android-ndk = "/path/to/ndk"
585 # Force static or dynamic linkage of the standard library for this target. If
586 # this target is a host for rustc, this will also affect the linkage of the
587 # compiler itself. This is useful for building rustc on targets that normally
588 # only use static libraries. If unset, the target's default linkage is used.
591 # The root location of the musl installation directory. The library directory
592 # will also need to contain libunwind.a for an unwinding implementation. Note
593 # that this option only makes sense for musl targets that produce statically
597 # The full path to the musl libdir.
598 #musl-libdir = musl-root/lib
600 # The root location of the `wasm32-wasi` sysroot.
603 # Used in testing for configuring where the QEMU images are located, you
604 # probably don't want to use this.
607 # =============================================================================
608 # Distribution options
610 # These options are related to distribution, mostly for the Rust project itself.
611 # You probably won't need to concern yourself with any of these options
612 # =============================================================================
615 # This is the folder of artifacts that the build system will sign. All files in
616 # this directory will be signed with the default gpg key using the system `gpg`
617 # binary. The `asc` and `sha256` files will all be output into the standard dist
618 # output folder (currently `build/dist`)
620 # This folder should be populated ahead of time before the build system is
622 #sign-folder = "path/to/folder/to/sign"
624 # This is a file which contains the password of the default gpg key. This will
625 # be passed to `gpg` down the road when signing all files in `sign-folder`
626 # above. This should be stored in plaintext.
627 #gpg-password-file = "path/to/gpg/password"
629 # The remote address that all artifacts will eventually be uploaded to. The
630 # build system generates manifests which will point to these urls, and for the
631 # manifests to be correct they'll have to have the right URLs encoded.
633 # Note that this address should not contain a trailing slash as file names will
635 #upload-addr = "https://example.com/folder"
637 # Whether to build a plain source tarball to upload
638 # We disable that on Windows not to override the one already uploaded on S3
639 # as the one built on Windows will contain backslashes in paths causing problems
644 # Whether to allow failures when building tools
645 #missing-tools = false