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 # Whether to use Rust CI built LLVM instead of locally building it.
19 # Unless you're developing for a target where Rust CI doesn't build a compiler
20 # toolchain or changing LLVM locally, you probably want to set this to true.
22 # It's currently false by default due to being newly added; please file bugs if
23 # enabling this did not work for you on Linux (macOS and Windows support is
26 # We also currently only support this when building LLVM for the build triple.
28 # Note that many of the LLVM options are not currently supported for
29 # downloading. Currently only the "assertions" option can be toggled.
30 #download-ci-llvm = false
32 # Indicates whether LLVM rebuild should be skipped when running bootstrap. If
33 # this is `false` then the compiler's LLVM will be rebuilt whenever the built
34 # version doesn't have the correct hash. If it is `true` then LLVM will never
35 # be rebuilt. The default value is `false`.
38 # Indicates whether the LLVM build is a Release or Debug build
41 # Indicates whether LLVM should be built with ThinLTO. Note that this will
42 # only succeed if you use clang, lld, llvm-ar, and llvm-ranlib in your C/C++
43 # toolchain (see the `cc`, `cxx`, `linker`, `ar`, and `ranlib` options below).
44 # More info at: https://clang.llvm.org/docs/ThinLTO.html#clang-bootstrap
47 # Indicates whether an LLVM Release build should include debug info
48 #release-debuginfo = false
50 # Indicates whether the LLVM assertions are enabled or not
53 # Indicates whether ccache is used when building LLVM
55 # or alternatively ...
56 #ccache = "/path/to/ccache"
58 # If an external LLVM root is specified, we automatically check the version by
59 # default to make sure it's within the range that we're expecting, but setting
60 # this flag will indicate that this version check should not be done.
63 # Link libstdc++ statically into the rustc_llvm instead of relying on a
64 # dynamic version to be available.
65 #static-libstdcpp = false
67 # Whether to use Ninja to build LLVM. This runs much faster than make.
70 # LLVM targets to build support for.
71 # Note: this is NOT related to Rust compilation targets. However, as Rust is
72 # dependent on LLVM for code generation, turning targets off here WILL lead to
73 # the resulting rustc being unable to compile for the disabled architectures.
74 # Also worth pointing out is that, in case support for new targets are added to
75 # LLVM, enabling them here doesn't mean Rust is automatically gaining said
76 # support. You'll need to write a target specification at least, and most
77 # likely, teach rustc about the C ABI of the target. Get in touch with the
78 # Rust team and file an issue if you need assistance in porting!
79 #targets = "AArch64;ARM;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;Sparc;SystemZ;WebAssembly;X86"
81 # LLVM experimental targets to build support for. These targets are specified in
82 # the same format as above, but since these targets are experimental, they are
83 # not built by default and the experimental Rust compilation targets that depend
84 # on them will not work unless the user opts in to building them.
85 #experimental-targets = "AVR"
87 # Cap the number of parallel linker invocations when compiling LLVM.
88 # This can be useful when building LLVM with debug info, which significantly
89 # increases the size of binaries and consequently the memory required by
90 # each linker process.
91 # If absent or 0, linker invocations are treated like any other job and
92 # controlled by rustbuild's -j parameter.
95 # When invoking `llvm-config` this configures whether the `--shared` argument is
96 # passed to prefer linking to shared libraries.
99 # When building llvm, this configures what is being appended to the version.
100 # The default is "-rust-$version-$channel", except for dev channel where rustc
101 # version number is omitted. To use LLVM version as is, provide an empty string.
102 #version-suffix = "-rust-dev"
104 # On MSVC you can compile LLVM with clang-cl, but the test suite doesn't pass
105 # with clang-cl, so this is special in that it only compiles LLVM with clang-cl
106 #clang-cl = '/path/to/clang-cl.exe'
108 # Pass extra compiler and linker flags to the LLVM CMake build.
109 #cflags = "-fextra-flag"
110 #cxxflags = "-fextra-flag"
111 #ldflags = "-Wl,extra-flag"
113 # Use libc++ when building LLVM instead of libstdc++. This is the default on
114 # platforms already use libc++ as the default C++ library, but this option
115 # allows you to use libc++ even on platforms when it's not. You need to ensure
116 # that your host compiler ships with libc++.
119 # The value specified here will be passed as `-DLLVM_USE_LINKER` to CMake.
122 # Whether or not to specify `-DLLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN=YES`
123 #allow-old-toolchain = false
125 # =============================================================================
126 # General build configuration options
127 # =============================================================================
129 # The default stage to use for the `doc` subcommand
132 # The default stage to use for the `build` subcommand
135 # The default stage to use for the `test` subcommand
138 # The default stage to use for the `dist` subcommand
141 # The default stage to use for the `install` subcommand
144 # The default stage to use for the `bench` subcommand
147 # Build triple for the original snapshot compiler. This must be a compiler that
148 # nightlies are already produced for. The current platform must be able to run
149 # binaries of this build triple and the nightly will be used to bootstrap the
152 # Defaults to host platform
153 #build = "x86_64-unknown-linux-gnu"
155 # Which triples to produce a compiler toolchain for. Each of these triples will
156 # be bootstrapped from the build triple themselves.
158 # Defaults to just the build triple
159 #host = ["x86_64-unknown-linux-gnu"]
161 # Which triples to build libraries (core/alloc/std/test/proc_macro) for. Each of
162 # these triples will be bootstrapped from the build triple themselves.
164 # Defaults to `host`. If you set this explicitly, you likely want to add all
165 # host triples to this list as well in order for those host toolchains to be
166 # able to compile programs for their native target.
167 #target = ["x86_64-unknown-linux-gnu"]
169 # Use this directory to store build artifacts.
170 # You can use "$ROOT" to indicate the root of the git repository.
173 # Instead of downloading the src/stage0.txt version of Cargo specified, use
174 # this Cargo binary instead to build all Rust code
175 #cargo = "/path/to/bin/cargo"
177 # Instead of downloading the src/stage0.txt version of the compiler
178 # specified, use this rustc binary instead as the stage0 snapshot compiler.
179 #rustc = "/path/to/bin/rustc"
181 # Instead of download the src/stage0.txt version of rustfmt specified,
182 # use this rustfmt binary instead as the stage0 snapshot rustfmt.
183 #rustfmt = "/path/to/bin/rustfmt"
185 # Flag to specify whether any documentation is built. If false, rustdoc and
186 # friends will still be compiled but they will not be used to generate any
190 # Indicate whether the compiler should be documented in addition to the standard
191 # library and facade crates.
192 #compiler-docs = false
194 # Indicate whether git submodules are managed and updated automatically.
197 # Update git submodules only when the checked out commit in the submodules differs
198 # from what is committed in the main rustc repo.
199 #fast-submodules = true
201 # The path to (or name of) the GDB executable to use. This is only used for
202 # executing the debuginfo test suite.
205 # The node.js executable to use. Note that this is only used for the emscripten
206 # target when running tests, otherwise this can be omitted.
209 # Python interpreter to use for various tasks throughout the build, notably
210 # rustdoc tests, the lldb python interpreter, and some dist bits and pieces.
212 # Defaults to the Python interpreter used to execute x.py
215 # Force Cargo to check that Cargo.lock describes the precise dependency
216 # set that all the Cargo.toml files create, instead of updating it.
219 # Indicate whether the vendored sources are used for Rust dependencies or not
222 # Typically the build system will build the Rust compiler twice. The second
223 # compiler, however, will simply use its own libraries to link against. If you
224 # would rather to perform a full bootstrap, compiling the compiler three times,
225 # then you can set this option to true. You shouldn't ever need to set this
227 #full-bootstrap = false
229 # Enable a build of the extended Rust tool set which is not only the compiler
230 # but also tools such as Cargo. This will also produce "combined installers"
231 # which are used to install Rust and Cargo together. This is disabled by
232 # default. The `tools` option (immediately below) specifies which tools should
233 # be built if `extended = true`.
236 # Installs chosen set of extended tools if `extended = true`. By default builds all.
237 # If chosen tool failed to build the installation fails. If `extended = false`, this
239 #tools = ["cargo", "rls", "clippy", "rustfmt", "analysis", "src"]
241 # Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose
244 # Build the sanitizer runtimes
247 # Build the profiler runtime (required when compiling with options that depend
248 # on this runtime, such as `-C profile-generate` or `-Z instrument-coverage`).
251 # Indicates whether the native libraries linked into Cargo will be statically
253 #cargo-native-static = false
255 # Run the build with low priority, by setting the process group's "nice" value
256 # to +10 on Unix platforms, and by using a "low priority" job object on Windows.
257 #low-priority = false
259 # Arguments passed to the `./configure` script, used during distcheck. You
260 # probably won't fill this in but rather it's filled in by the `./configure`
264 # Indicates that a local rebuild is occurring instead of a full bootstrap,
265 # essentially skipping stage0 as the local compiler is recompiling itself again.
266 #local-rebuild = false
268 # Print out how long each rustbuild step took (mostly intended for CI and
269 # tracking over time)
270 #print-step-timings = false
272 # =============================================================================
273 # General install configuration options
274 # =============================================================================
277 # Instead of installing to /usr/local, install to this path instead.
278 #prefix = "/usr/local"
280 # Where to install system configuration files
281 # If this is a relative path, it will get installed in `prefix` above
284 # Where to install documentation in `prefix` above
285 #docdir = "share/doc/rust"
287 # Where to install binaries in `prefix` above
290 # Where to install libraries in `prefix` above
293 # Where to install man pages in `prefix` above
294 #mandir = "share/man"
296 # Where to install data in `prefix` above (currently unused)
299 # Where to install additional info in `prefix` above (currently unused)
300 #infodir = "share/info"
302 # Where to install local state (currently unused)
303 # If this is a relative path, it will get installed in `prefix` above
304 #localstatedir = "/var/lib"
306 # =============================================================================
307 # Options for compiling Rust code itself
308 # =============================================================================
311 # Whether or not to optimize the compiler and standard library.
312 # WARNING: Building with optimize = false is NOT SUPPORTED. Due to bootstrapping,
313 # building without optimizations takes much longer than optimizing. Further, some platforms
314 # fail to build without this optimization (c.f. #65352).
317 # Indicates that the build should be configured for debugging Rust. A
318 # `debug`-enabled compiler and standard library will be somewhat
319 # slower (due to e.g. checking of debug assertions) but should remain
322 # Note: If this value is set to `true`, it will affect a number of
323 # configuration options below as well, if they have been left
324 # unconfigured in this file.
326 # Note: changes to the `debug` setting do *not* affect `optimize`
327 # above. In theory, a "maximally debuggable" environment would
328 # set `optimize` to `false` above to assist the introspection
329 # facilities of debuggers like lldb and gdb. To recreate such an
330 # environment, explicitly set `optimize` to `false` and `debug`
331 # to `true`. In practice, everyone leaves `optimize` set to
332 # `true`, because an unoptimized rustc with debugging
333 # enabled becomes *unusably slow* (e.g. rust-lang/rust#24840
334 # reported a 25x slowdown) and bootstrapping the supposed
335 # "maximally debuggable" environment (notably libstd) takes
340 # Number of codegen units to use for each compiler invocation. A value of 0
341 # means "the number of cores on this machine", and 1+ is passed through to the
344 # Uses the rustc defaults: https://doc.rust-lang.org/rustc/codegen-options/index.html#codegen-units
345 #codegen-units = if incremental { 256 } else { 16 }
347 # Sets the number of codegen units to build the standard library with,
348 # regardless of what the codegen-unit setting for the rest of the compiler is.
349 #codegen-units-std = 1
351 # Whether or not debug assertions are enabled for the compiler and standard
352 # library. Debug assertions control the maximum log level used by rustc. When
353 # enabled calls to `trace!` and `debug!` macros are preserved in the compiled
354 # binary, otherwise they are omitted.
356 # Defaults to rust.debug value
357 #debug-assertions = debug
359 # Whether or not debug assertions are enabled for the standard library.
360 # Overrides the `debug-assertions` option, if defined.
362 # Defaults to rust.debug-assertions value
363 #debug-assertions-std = debug-assertions
365 # Whether or not to leave debug! and trace! calls in the rust binary.
366 # Overrides the `debug-assertions` option, if defined.
368 # Defaults to rust.debug-assertions value
369 #debug-logging = debug-assertions
371 # Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
372 # `0` - no debug info
373 # `1` - line tables only - sufficient to generate backtraces that include line
374 # information and inlined functions, set breakpoints at source code
375 # locations, and step through execution in a debugger.
376 # `2` - full debug info with variable and type information
377 # Can be overridden for specific subsets of Rust code (rustc, std or tools).
378 # Debuginfo for tests run with compiletest is not controlled by this option
379 # and needs to be enabled separately with `debuginfo-level-tests`.
381 # Note that debuginfo-level = 2 generates several gigabytes of debuginfo
382 # and will slow down the linking process significantly.
384 # Defaults to 1 if debug is true
387 # Debuginfo level for the compiler.
389 # Defaults to rust.debuginfo-level value
390 #debuginfo-level-rustc = 0
392 # Debuginfo level for the standard library.
394 # Defaults to rust.debuginfo-level value
395 #debuginfo-level-std = 0
397 # Debuginfo level for the tools.
399 # Defaults to rust.debuginfo-level value
400 #debuginfo-level-tools = 0
402 # Debuginfo level for the test suites run with compiletest.
403 # FIXME(#61117): Some tests fail when this option is enabled.
404 #debuginfo-level-tests = 0
406 # Whether or not `panic!`s generate backtraces (RUST_BACKTRACE)
409 # Whether to always use incremental compilation when building rustc
412 # Build a multi-threaded rustc
413 # FIXME(#75760): Some UI tests fail when this option is enabled.
414 #parallel-compiler = false
416 # The default linker that will be hard-coded into the generated compiler for
417 # targets that don't specify linker explicitly in their target specifications.
418 # Note that this is not the linker used to link said compiler.
419 #default-linker = "cc"
421 # The "channel" for the Rust build to produce. The stable/beta channels only
422 # allow using stable features, whereas the nightly and dev channels allow using
426 # The root location of the musl installation directory.
429 # By default the `rustc` executable is built with `-Wl,-rpath` flags on Unix
430 # platforms to ensure that the compiler is usable by default from the build
431 # directory (as it links to a number of dynamic libraries). This may not be
432 # desired in distributions, for example.
435 # Prints each test name as it is executed, to help debug issues in the test harness itself.
436 #verbose-tests = false
438 # Flag indicating whether tests are compiled with optimizations (the -O flag).
439 #optimize-tests = true
441 # Flag indicating whether codegen tests will be run or not. If you get an error
442 # saying that the FileCheck executable is missing, you may want to disable this.
443 # Also see the target's llvm-filecheck option.
444 #codegen-tests = true
446 # Flag indicating whether git info will be retrieved from .git automatically.
447 # Having the git information can cause a lot of rebuilds during development.
448 # Note: If this attribute is not explicitly set (e.g. if left commented out) it
449 # will default to true if channel = "dev", but will default to false otherwise.
452 # When creating source tarballs whether or not to create a source tarball.
455 # After building or testing extended tools (e.g. clippy and rustfmt), append the
456 # result (broken, compiling, testing) into this JSON file.
457 #save-toolstates = "/path/to/toolstates.json"
459 # This is an array of the codegen backends that will be compiled for the rustc
460 # that's being compiled. The default is to only build the LLVM codegen backend,
461 # and currently the only standard option supported is `"llvm"`
462 #codegen-backends = ["llvm"]
464 # Indicates whether LLD will be compiled and made available in the sysroot for
468 # Indicates whether LLD will be used to link Rust crates during bootstrap on
469 # supported platforms. The LLD from the bootstrap distribution will be used
470 # and not the LLD compiled during the bootstrap.
472 # LLD will not be used if we're cross linking.
474 # Explicitly setting the linker for a target will override this option when targeting MSVC.
477 # Indicates whether some LLVM tools, like llvm-objdump, will be made available in the
481 # Whether to deny warnings in crates
482 #deny-warnings = true
484 # Print backtrace on internal compiler errors during bootstrap
485 #backtrace-on-ice = false
487 # Whether to verify generated LLVM IR
488 #verify-llvm-ir = false
490 # Compile the compiler with a non-default ThinLTO import limit. This import
491 # limit controls the maximum size of functions imported by ThinLTO. Decreasing
492 # will make code compile faster at the expense of lower runtime performance.
493 # If `incremental` is set to true above, the import limit will default to 10
494 # instead of LLVM's default of 100.
495 #thin-lto-import-instr-limit = 100
497 # Map debuginfo paths to `/rust/$sha/...`, generally only set for releases
498 #remap-debuginfo = false
500 # Link the compiler against `jemalloc`, where on Linux and OSX it should
501 # override the default allocator for rustc and LLVM.
504 # Run tests in various test suites with the "nll compare mode" in addition to
505 # running the tests in normal mode. Largely only used on CI and during local
507 #test-compare-mode = false
509 # Use LLVM libunwind as the implementation for Rust's unwinder.
510 #llvm-libunwind = false
512 # Enable Windows Control Flow Guard checks in the standard library.
513 # This only applies from stage 1 onwards, and only for Windows targets.
514 #control-flow-guard = false
516 # Enable symbol-mangling-version v0. This can be helpful when profiling rustc,
517 # as generics will be preserved in symbols (rather than erased into opaque T).
518 #new-symbol-mangling = false
520 # =============================================================================
521 # Options for specific targets
523 # Each of the following options is scoped to the specific target triple in
524 # question and is used for determining how to compile each target.
525 # =============================================================================
526 [target.x86_64-unknown-linux-gnu]
528 # C compiler to be used to compiler C code. Note that the
529 # default value is platform specific, and if not specified it may also depend on
530 # what platform is crossing to what platform.
533 # C++ compiler to be used to compiler C++ code (e.g. LLVM and our LLVM shims).
534 # This is only used for host targets.
537 # Archiver to be used to assemble static libraries compiled from C/C++ code.
538 # Note: an absolute path should be used, otherwise LLVM build will break.
541 # Ranlib to be used to assemble static libraries compiled from C/C++ code.
542 # Note: an absolute path should be used, otherwise LLVM build will break.
545 # Linker to be used to link Rust code. Note that the
546 # default value is platform specific, and if not specified it may also depend on
547 # what platform is crossing to what platform.
548 # Setting this will override the `use-lld` option for Rust code when targeting MSVC.
551 # Path to the `llvm-config` binary of the installation of a custom LLVM to link
552 # against. Note that if this is specified we don't compile LLVM at all for this
554 #llvm-config = "../path/to/llvm/root/bin/llvm-config"
556 # Normally the build system can find LLVM's FileCheck utility, but if
557 # not, you can specify an explicit file name for it.
558 #llvm-filecheck = "/path/to/FileCheck"
560 # If this target is for Android, this option will be required to specify where
561 # the NDK for the target lives. This is used to find the C compiler to link and
563 #android-ndk = "/path/to/ndk"
565 # Force static or dynamic linkage of the standard library for this target. If
566 # this target is a host for rustc, this will also affect the linkage of the
567 # compiler itself. This is useful for building rustc on targets that normally
568 # only use static libraries. If unset, the target's default linkage is used.
571 # The root location of the musl installation directory. The library directory
572 # will also need to contain libunwind.a for an unwinding implementation. Note
573 # that this option only makes sense for musl targets that produce statically
577 # The full path to the musl libdir.
578 #musl-libdir = musl-root/lib
580 # The root location of the `wasm32-wasi` sysroot.
583 # Used in testing for configuring where the QEMU images are located, you
584 # probably don't want to use this.
587 # =============================================================================
588 # Distribution options
590 # These options are related to distribution, mostly for the Rust project itself.
591 # You probably won't need to concern yourself with any of these options
592 # =============================================================================
595 # This is the folder of artifacts that the build system will sign. All files in
596 # this directory will be signed with the default gpg key using the system `gpg`
597 # binary. The `asc` and `sha256` files will all be output into the standard dist
598 # output folder (currently `build/dist`)
600 # This folder should be populated ahead of time before the build system is
602 #sign-folder = "path/to/folder/to/sign"
604 # This is a file which contains the password of the default gpg key. This will
605 # be passed to `gpg` down the road when signing all files in `sign-folder`
606 # above. This should be stored in plaintext.
607 #gpg-password-file = "path/to/gpg/password"
609 # The remote address that all artifacts will eventually be uploaded to. The
610 # build system generates manifests which will point to these urls, and for the
611 # manifests to be correct they'll have to have the right URLs encoded.
613 # Note that this address should not contain a trailing slash as file names will
615 #upload-addr = "https://example.com/folder"
617 # Whether to build a plain source tarball to upload
618 # We disable that on Windows not to override the one already uploaded on S3
619 # as the one built on Windows will contain backslashes in paths causing problems
624 # Whether to allow failures when building tools
625 #missing-tools = false