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 # All tier 1 targets are currently supported; set this to `"if-available"` if
39 # you are not sure whether you're on a tier 1 target.
41 # We also currently only support this when building LLVM for the build triple.
43 # Note that many of the LLVM options are not currently supported for
44 # downloading. Currently only the "assertions" option can be toggled.
46 # Defaults to "if-available" when `channel = "dev"` and "false" otherwise.
47 #download-ci-llvm = "if-available"
49 # Indicates whether LLVM rebuild should be skipped when running bootstrap. If
50 # this is `false` then the compiler's LLVM will be rebuilt whenever the built
51 # version doesn't have the correct hash. If it is `true` then LLVM will never
52 # be rebuilt. The default value is `false`.
55 # Indicates whether the LLVM build is a Release or Debug build
58 # Indicates whether LLVM should be built with ThinLTO. Note that this will
59 # only succeed if you use clang, lld, llvm-ar, and llvm-ranlib in your C/C++
60 # toolchain (see the `cc`, `cxx`, `linker`, `ar`, and `ranlib` options below).
61 # More info at: https://clang.llvm.org/docs/ThinLTO.html#clang-bootstrap
64 # Indicates whether an LLVM Release build should include debug info
65 #release-debuginfo = false
67 # Indicates whether the LLVM assertions are enabled or not
70 # Indicates whether the LLVM testsuite is enabled in the build or not. Does
71 # not execute the tests as part of the build as part of x.py build et al,
72 # just makes it possible to do `ninja check-llvm` in the staged LLVM build
73 # directory when doing LLVM development as part of Rust development.
76 # Indicates whether the LLVM plugin is enabled or not
79 # Indicates whether ccache is used when building LLVM
81 # or alternatively ...
82 #ccache = "/path/to/ccache"
84 # If an external LLVM root is specified, we automatically check the version by
85 # default to make sure it's within the range that we're expecting, but setting
86 # this flag will indicate that this version check should not be done.
89 # When true, link libstdc++ statically into the rustc_llvm.
90 # This is useful if you don't want to use the dynamic version of that
91 # library provided by LLVM.
92 #static-libstdcpp = false
94 # Whether to use Ninja to build LLVM. This runs much faster than make.
97 # LLVM targets to build support for.
98 # Note: this is NOT related to Rust compilation targets. However, as Rust is
99 # dependent on LLVM for code generation, turning targets off here WILL lead to
100 # the resulting rustc being unable to compile for the disabled architectures.
101 # Also worth pointing out is that, in case support for new targets are added to
102 # LLVM, enabling them here doesn't mean Rust is automatically gaining said
103 # support. You'll need to write a target specification at least, and most
104 # likely, teach rustc about the C ABI of the target. Get in touch with the
105 # Rust team and file an issue if you need assistance in porting!
106 #targets = "AArch64;ARM;BPF;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;Sparc;SystemZ;WebAssembly;X86"
108 # LLVM experimental targets to build support for. These targets are specified in
109 # the same format as above, but since these targets are experimental, they are
110 # not built by default and the experimental Rust compilation targets that depend
111 # on them will not work unless the user opts in to building them.
112 #experimental-targets = "AVR;M68k"
114 # Cap the number of parallel linker invocations when compiling LLVM.
115 # This can be useful when building LLVM with debug info, which significantly
116 # increases the size of binaries and consequently the memory required by
117 # each linker process.
118 # If absent or 0, linker invocations are treated like any other job and
119 # controlled by rustbuild's -j parameter.
122 # When invoking `llvm-config` this configures whether the `--shared` argument is
123 # passed to prefer linking to shared libraries.
124 # NOTE: `thin-lto = true` requires this to be `true` and will give an error otherwise.
127 # When building llvm, this configures what is being appended to the version.
128 # The default is "-rust-$version-$channel", except for dev channel where rustc
129 # version number is omitted. To use LLVM version as is, provide an empty string.
130 #version-suffix = "-rust-dev"
132 # On MSVC you can compile LLVM with clang-cl, but the test suite doesn't pass
133 # with clang-cl, so this is special in that it only compiles LLVM with clang-cl.
134 # Note that this takes a /path/to/clang-cl, not a boolean.
137 # Pass extra compiler and linker flags to the LLVM CMake build.
142 # Use libc++ when building LLVM instead of libstdc++. This is the default on
143 # platforms already use libc++ as the default C++ library, but this option
144 # allows you to use libc++ even on platforms when it's not. You need to ensure
145 # that your host compiler ships with libc++.
148 # The value specified here will be passed as `-DLLVM_USE_LINKER` to CMake.
149 #use-linker = <none> (path)
151 # Whether or not to specify `-DLLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN=YES`
152 #allow-old-toolchain = false
154 # Whether to include the Polly optimizer.
157 # Whether to build the clang compiler.
160 # Custom CMake defines to set when building LLVM.
163 # =============================================================================
164 # General build configuration options
165 # =============================================================================
167 # The default stage to use for the `check` subcommand
170 # The default stage to use for the `doc` subcommand
173 # The default stage to use for the `build` subcommand
176 # The default stage to use for the `test` subcommand
179 # The default stage to use for the `dist` subcommand
182 # The default stage to use for the `install` subcommand
185 # The default stage to use for the `bench` subcommand
188 # Build triple for the original snapshot compiler. This must be a compiler that
189 # nightlies are already produced for. The current platform must be able to run
190 # binaries of this build triple and the nightly will be used to bootstrap the
193 # Defaults to platform where `x.py` is run.
194 #build = "x86_64-unknown-linux-gnu" (as an example)
196 # Which triples to produce a compiler toolchain for. Each of these triples will
197 # be bootstrapped from the build triple themselves.
199 # Defaults to just the build triple.
200 #host = ["x86_64-unknown-linux-gnu"] (as an example)
202 # Which triples to build libraries (core/alloc/std/test/proc_macro) for. Each of
203 # these triples will be bootstrapped from the build triple themselves.
205 # Defaults to `host`. If you set this explicitly, you likely want to add all
206 # host triples to this list as well in order for those host toolchains to be
207 # able to compile programs for their native target.
208 #target = ["x86_64-unknown-linux-gnu"] (as an example)
210 # Use this directory to store build artifacts.
211 # You can use "$ROOT" to indicate the root of the git repository.
214 # Instead of downloading the src/stage0.json version of Cargo specified, use
215 # this Cargo binary instead to build all Rust code
216 #cargo = "/path/to/cargo"
218 # Instead of downloading the src/stage0.json version of the compiler
219 # specified, use this rustc binary instead as the stage0 snapshot compiler.
220 #rustc = "/path/to/rustc"
222 # Instead of download the src/stage0.json version of rustfmt specified,
223 # use this rustfmt binary instead as the stage0 snapshot rustfmt.
224 #rustfmt = "/path/to/rustfmt"
226 # Flag to specify whether any documentation is built. If false, rustdoc and
227 # friends will still be compiled but they will not be used to generate any
231 # Flag to specify whether CSS, JavaScript, and HTML are minified when
232 # docs are generated. JSON is always minified, because it's enormous,
233 # and generated in already-minified form from the beginning.
234 #docs-minification = true
236 # Indicate whether the compiler should be documented in addition to the standard
237 # library and facade crates.
238 #compiler-docs = false
240 # Indicate whether git submodules are managed and updated automatically.
243 # The path to (or name of) the GDB executable to use. This is only used for
244 # executing the debuginfo test suite.
247 # The node.js executable to use. Note that this is only used for the emscripten
248 # target when running tests, otherwise this can be omitted.
251 # Python interpreter to use for various tasks throughout the build, notably
252 # rustdoc tests, the lldb python interpreter, and some dist bits and pieces.
254 # Defaults to the Python interpreter used to execute x.py
257 # The path to the REUSE executable to use. Note that REUSE is not required in
258 # most cases, as our tooling relies on a cached (and shrinked) copy of the
259 # REUSE output present in the git repository and in our source tarballs.
261 # REUSE is only needed if your changes caused the overral licensing of the
262 # repository to change, and the cached copy has to be regenerated.
264 # Defaults to the "reuse" command in the system path.
267 # Force Cargo to check that Cargo.lock describes the precise dependency
268 # set that all the Cargo.toml files create, instead of updating it.
271 # Indicate whether the vendored sources are used for Rust dependencies or not
274 # Typically the build system will build the Rust compiler twice. The second
275 # compiler, however, will simply use its own libraries to link against. If you
276 # would rather to perform a full bootstrap, compiling the compiler three times,
277 # then you can set this option to true. You shouldn't ever need to set this
279 #full-bootstrap = false
281 # Enable a build of the extended Rust tool set which is not only the compiler
282 # but also tools such as Cargo. This will also produce "combined installers"
283 # which are used to install Rust and Cargo together. This is disabled by
284 # default. The `tools` option (immediately below) specifies which tools should
285 # be built if `extended = true`.
288 # Set of tools to be included in the installation.
290 # If `extended = false`, the only one of these built by default is rustdoc.
292 # If `extended = true`, they're all included, with the exception of
293 # rust-demangler which additionally requires `profiler = true` to be set.
295 # If any enabled tool fails to build, the installation fails.
304 # "rust-demangler", # if profiler = true
307 # Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose
310 # Build the sanitizer runtimes
313 # Build the profiler runtime (required when compiling with options that depend
314 # on this runtime, such as `-C profile-generate` or `-C instrument-coverage`).
317 # Indicates whether the native libraries linked into Cargo will be statically
319 #cargo-native-static = false
321 # Run the build with low priority, by setting the process group's "nice" value
322 # to +10 on Unix platforms, and by using a "low priority" job object on Windows.
323 #low-priority = false
325 # Arguments passed to the `./configure` script, used during distcheck. You
326 # probably won't fill this in but rather it's filled in by the `./configure`
330 # Indicates that a local rebuild is occurring instead of a full bootstrap,
331 # essentially skipping stage0 as the local compiler is recompiling itself again.
332 #local-rebuild = false
334 # Print out how long each rustbuild step took (mostly intended for CI and
335 # tracking over time)
336 #print-step-timings = false
338 # Print out resource usage data for each rustbuild step, as defined by the Unix
339 # struct rusage. (Note that this setting is completely unstable: the data it
340 # captures, what platforms it supports, the format of its associated output, and
341 # this setting's very existence, are all subject to change.)
342 #print-step-rusage = false
344 # Always patch binaries for usage with Nix toolchains. If `true` then binaries
345 # will be patched unconditionally. If `false` or unset, binaries will be patched
346 # only if the current distribution is NixOS. This option is useful when using
347 # a Nix toolchain on non-NixOS distributions.
348 #patch-binaries-for-nix = false
350 # Collect information and statistics about the current build and writes it to
351 # disk. Enabling this or not has no impact on the resulting build output. The
352 # schema of the file generated by the build metrics feature is unstable, and
353 # this is not intended to be used during local development.
356 # =============================================================================
357 # General install configuration options
358 # =============================================================================
361 # Instead of installing to /usr/local, install to this path instead.
362 #prefix = "/usr/local"
364 # Where to install system configuration files
365 # If this is a relative path, it will get installed in `prefix` above
368 # Where to install documentation in `prefix` above
369 #docdir = "share/doc/rust"
371 # Where to install binaries in `prefix` above
374 # Where to install libraries in `prefix` above
377 # Where to install man pages in `prefix` above
378 #mandir = "share/man"
380 # Where to install data in `prefix` above
383 # =============================================================================
384 # Options for compiling Rust code itself
385 # =============================================================================
388 # Whether or not to optimize the compiler and standard library.
389 # WARNING: Building with optimize = false is NOT SUPPORTED. Due to bootstrapping,
390 # building without optimizations takes much longer than optimizing. Further, some platforms
391 # fail to build without this optimization (c.f. #65352).
394 # Indicates that the build should be configured for debugging Rust. A
395 # `debug`-enabled compiler and standard library will be somewhat
396 # slower (due to e.g. checking of debug assertions) but should remain
399 # Note: If this value is set to `true`, it will affect a number of
400 # configuration options below as well, if they have been left
401 # unconfigured in this file.
403 # Note: changes to the `debug` setting do *not* affect `optimize`
404 # above. In theory, a "maximally debuggable" environment would
405 # set `optimize` to `false` above to assist the introspection
406 # facilities of debuggers like lldb and gdb. To recreate such an
407 # environment, explicitly set `optimize` to `false` and `debug`
408 # to `true`. In practice, everyone leaves `optimize` set to
409 # `true`, because an unoptimized rustc with debugging
410 # enabled becomes *unusably slow* (e.g. rust-lang/rust#24840
411 # reported a 25x slowdown) and bootstrapping the supposed
412 # "maximally debuggable" environment (notably libstd) takes
417 # Whether to download the stage 1 and 2 compilers from CI.
418 # This is mostly useful for tools; if you have changes to `compiler/` they will be ignored.
420 # You can set this to "if-unchanged" to only download if `compiler/` has not been modified.
421 #download-rustc = false
423 # Number of codegen units to use for each compiler invocation. A value of 0
424 # means "the number of cores on this machine", and 1+ is passed through to the
427 # Uses the rustc defaults: https://doc.rust-lang.org/rustc/codegen-options/index.html#codegen-units
428 #codegen-units = if incremental { 256 } else { 16 }
430 # Sets the number of codegen units to build the standard library with,
431 # regardless of what the codegen-unit setting for the rest of the compiler is.
432 # NOTE: building with anything other than 1 is known to occasionally have bugs.
433 # See https://github.com/rust-lang/rust/issues/83600.
434 #codegen-units-std = codegen-units
436 # Whether or not debug assertions are enabled for the compiler and standard
437 # library. Debug assertions control the maximum log level used by rustc. When
438 # enabled calls to `trace!` and `debug!` macros are preserved in the compiled
439 # binary, otherwise they are omitted.
441 # Defaults to rust.debug value
442 #debug-assertions = rust.debug (boolean)
444 # Whether or not debug assertions are enabled for the standard library.
445 # Overrides the `debug-assertions` option, if defined.
447 # Defaults to rust.debug-assertions value
448 #debug-assertions-std = rust.debug-assertions (boolean)
450 # Whether or not to leave debug! and trace! calls in the rust binary.
451 # Overrides the `debug-assertions` option, if defined.
453 # Defaults to rust.debug-assertions value
455 # If you see a message from `tracing` saying
456 # `max_level_info` is enabled and means logging won't be shown,
457 # set this value to `true`.
458 #debug-logging = rust.debug-assertions (boolean)
460 # Whether or not overflow checks are enabled for the compiler and standard
463 # Defaults to rust.debug value
464 #overflow-checks = rust.debug (boolean)
466 # Whether or not overflow checks are enabled for the standard library.
467 # Overrides the `overflow-checks` option, if defined.
469 # Defaults to rust.overflow-checks value
470 #overflow-checks-std = rust.overflow-checks (boolean)
472 # Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
473 # `0` - no debug info
474 # `1` - line tables only - sufficient to generate backtraces that include line
475 # information and inlined functions, set breakpoints at source code
476 # locations, and step through execution in a debugger.
477 # `2` - full debug info with variable and type information
478 # Can be overridden for specific subsets of Rust code (rustc, std or tools).
479 # Debuginfo for tests run with compiletest is not controlled by this option
480 # and needs to be enabled separately with `debuginfo-level-tests`.
482 # Note that debuginfo-level = 2 generates several gigabytes of debuginfo
483 # and will slow down the linking process significantly.
485 # Defaults to 1 if debug is true
488 # Debuginfo level for the compiler.
489 #debuginfo-level-rustc = debuginfo-level
491 # Debuginfo level for the standard library.
492 #debuginfo-level-std = debuginfo-level
494 # Debuginfo level for the tools.
495 #debuginfo-level-tools = debuginfo-level
497 # Debuginfo level for the test suites run with compiletest.
498 # FIXME(#61117): Some tests fail when this option is enabled.
499 #debuginfo-level-tests = 0
501 # Should rustc be build with split debuginfo? Default is platform dependent.
502 # Valid values are the same as those accepted by `-C split-debuginfo`
503 # (`off`/`unpacked`/`packed`).
505 # On Linux, split debuginfo is disabled by default.
507 # On Apple platforms, unpacked split debuginfo is used by default. Unpacked
508 # debuginfo does not run `dsymutil`, which packages debuginfo from disparate
509 # object files into a single `.dSYM` file. `dsymutil` adds time to builds for
510 # no clear benefit, and also makes it more difficult for debuggers to find
511 # debug info. The compiler currently defaults to running `dsymutil` to preserve
512 # its historical default, but when compiling the compiler itself, we skip it by
513 # default since we know it's safe to do so in that case.
515 # On Windows platforms, packed debuginfo is the only supported option,
516 # producing a `.pdb` file.
517 #split-debuginfo = if linux { off } else if windows { packed } else if apple { unpacked }
519 # Whether or not `panic!`s generate backtraces (RUST_BACKTRACE)
522 # Whether to always use incremental compilation when building rustc
525 # Build a multi-threaded rustc
526 # FIXME(#75760): Some UI tests fail when this option is enabled.
527 #parallel-compiler = false
529 # The default linker that will be hard-coded into the generated
530 # compiler for targets that don't specify a default linker explicitly
531 # in their target specifications. Note that this is not the linker
532 # used to link said compiler. It can also be set per-target (via the
533 # `[target.<triple>]` block), which may be useful in a cross-compilation
536 # See https://doc.rust-lang.org/rustc/codegen-options/index.html#linker for more information.
537 #default-linker = <none> (path)
539 # The "channel" for the Rust build to produce. The stable/beta channels only
540 # allow using stable features, whereas the nightly and dev channels allow using
544 # A descriptive string to be appended to `rustc --version` output, which is
545 # also used in places like debuginfo `DW_AT_producer`. This may be useful for
546 # supplementary build information, like distro-specific package versions.
548 # The Rust compiler will differentiate between versions of itself, including
549 # based on this string, which means that if you wish to be compatible with
550 # upstream Rust you need to set this to "". However, note that if you are not
551 # actually compatible -- for example if you've backported patches that change
552 # behavior -- this may lead to miscompilations or other bugs.
553 #description = <none> (string)
555 # The root location of the musl installation directory. The library directory
556 # will also need to contain libunwind.a for an unwinding implementation. Note
557 # that this option only makes sense for musl targets that produce statically
560 # Defaults to /usr on musl hosts. Has no default otherwise.
561 #musl-root = <platform specific> (path)
563 # By default the `rustc` executable is built with `-Wl,-rpath` flags on Unix
564 # platforms to ensure that the compiler is usable by default from the build
565 # directory (as it links to a number of dynamic libraries). This may not be
566 # desired in distributions, for example.
569 # Prints each test name as it is executed, to help debug issues in the test harness itself.
570 #verbose-tests = false
572 # Flag indicating whether tests are compiled with optimizations (the -O flag).
573 #optimize-tests = true
575 # Flag indicating whether codegen tests will be run or not. If you get an error
576 # saying that the FileCheck executable is missing, you may want to disable this.
577 # Also see the target's llvm-filecheck option.
578 #codegen-tests = true
580 # Flag indicating whether git info will be retrieved from .git automatically.
581 # Having the git information can cause a lot of rebuilds during development.
582 # Note: If this attribute is not explicitly set (e.g. if left commented out) it
583 # will default to true if channel = "dev", but will default to false otherwise.
584 #ignore-git = if channel == "dev" { true } else { false }
586 # When creating source tarballs whether or not to create a source tarball.
589 # After building or testing extended tools (e.g. clippy and rustfmt), append the
590 # result (broken, compiling, testing) into this JSON file.
591 #save-toolstates = <none> (path)
593 # This is an array of the codegen backends that will be compiled for the rustc
594 # that's being compiled. The default is to only build the LLVM codegen backend,
595 # and currently the only standard options supported are `"llvm"`, `"cranelift"`
596 # and `"gcc"`. The first backend in this list will be used as default by rustc
597 # when no explicit backend is specified.
598 #codegen-backends = ["llvm"]
600 # Indicates whether LLD will be compiled and made available in the sysroot for
604 # Indicates whether LLD will be used to link Rust crates during bootstrap on
605 # supported platforms. The LLD from the bootstrap distribution will be used
606 # and not the LLD compiled during the bootstrap.
608 # LLD will not be used if we're cross linking.
610 # Explicitly setting the linker for a target will override this option when targeting MSVC.
613 # Indicates whether some LLVM tools, like llvm-objdump, will be made available in the
617 # Whether to deny warnings in crates
618 #deny-warnings = true
620 # Print backtrace on internal compiler errors during bootstrap
621 #backtrace-on-ice = false
623 # Whether to verify generated LLVM IR
624 #verify-llvm-ir = false
626 # Compile the compiler with a non-default ThinLTO import limit. This import
627 # limit controls the maximum size of functions imported by ThinLTO. Decreasing
628 # will make code compile faster at the expense of lower runtime performance.
629 #thin-lto-import-instr-limit = if incremental { 10 } else { LLVM default (currently 100) }
631 # Map debuginfo paths to `/rust/$sha/...`, generally only set for releases
632 #remap-debuginfo = false
634 # Link the compiler against `jemalloc`, where on Linux and OSX it should
635 # override the default allocator for rustc and LLVM.
638 # Run tests in various test suites with the "nll compare mode" in addition to
639 # running the tests in normal mode. Largely only used on CI and during local
641 #test-compare-mode = false
643 # Global default for llvm-libunwind for all targets. See the target-specific
644 # documentation for llvm-libunwind below. Note that the target-specific
645 # option will override this if set.
646 #llvm-libunwind = 'no'
648 # Enable Windows Control Flow Guard checks in the standard library.
649 # This only applies from stage 1 onwards, and only for Windows targets.
650 #control-flow-guard = false
652 # Enable symbol-mangling-version v0. This can be helpful when profiling rustc,
653 # as generics will be preserved in symbols (rather than erased into opaque T).
654 # When no setting is given, the new scheme will be used when compiling the
655 # compiler and its tools and the legacy scheme will be used when compiling the
657 # If an explicit setting is given, it will be used for all parts of the codebase.
658 #new-symbol-mangling = true|false (see comment)
660 # Select LTO mode that will be used for compiling rustc. By default, thin local LTO
661 # (LTO within a single crate) is used (like for any Rust crate). You can also select
662 # "thin" or "fat" to apply Thin/Fat LTO to the `rustc_driver` dylib.
665 # =============================================================================
666 # Options for specific targets
668 # Each of the following options is scoped to the specific target triple in
669 # question and is used for determining how to compile each target.
670 # =============================================================================
671 [target.x86_64-unknown-linux-gnu]
673 # C compiler to be used to compile C code. Note that the
674 # default value is platform specific, and if not specified it may also depend on
675 # what platform is crossing to what platform.
676 # See `src/bootstrap/cc_detect.rs` for details.
679 # C++ compiler to be used to compile C++ code (e.g. LLVM and our LLVM shims).
680 # This is only used for host targets.
681 # See `src/bootstrap/cc_detect.rs` for details.
684 # Archiver to be used to assemble static libraries compiled from C/C++ code.
685 # Note: an absolute path should be used, otherwise LLVM build will break.
688 # Ranlib to be used to assemble static libraries compiled from C/C++ code.
689 # Note: an absolute path should be used, otherwise LLVM build will break.
690 #ranlib = "ranlib" (path)
692 # Linker to be used to bootstrap Rust code. Note that the
693 # default value is platform specific, and if not specified it may also depend on
694 # what platform is crossing to what platform.
695 # Setting this will override the `use-lld` option for Rust code when targeting MSVC.
696 #linker = "cc" (path)
698 # Path to the `llvm-config` binary of the installation of a custom LLVM to link
699 # against. Note that if this is specified we don't compile LLVM at all for this
701 #llvm-config = <none> (path)
703 # Override detection of whether this is a Rust-patched LLVM. This would be used
704 # in conjunction with either an llvm-config or build.submodules = false.
705 #llvm-has-rust-patches = if llvm-config { false } else { true }
707 # Normally the build system can find LLVM's FileCheck utility, but if
708 # not, you can specify an explicit file name for it.
709 #llvm-filecheck = "/path/to/llvm-version/bin/FileCheck"
711 # Use LLVM libunwind as the implementation for Rust's unwinder.
712 # Accepted values are 'in-tree' (formerly true), 'system' or 'no' (formerly false).
713 # This option only applies for Linux and Fuchsia targets.
714 # On Linux target, if crt-static is not enabled, 'no' means dynamic link to
715 # `libgcc_s.so`, 'in-tree' means static link to the in-tree build of llvm libunwind
716 # and 'system' means dynamic link to `libunwind.so`. If crt-static is enabled,
717 # the behavior is depend on the libc. On musl target, 'no' and 'in-tree' both
718 # means static link to the in-tree build of llvm libunwind, and 'system' means
719 # static link to `libunwind.a` provided by system. Due to the limitation of glibc,
720 # it must link to `libgcc_eh.a` to get a working output, and this option have no effect.
721 #llvm-libunwind = 'no' if Linux, 'in-tree' if Fuchsia
723 # If this target is for Android, this option will be required to specify where
724 # the NDK for the target lives. This is used to find the C compiler to link and
726 # See `src/bootstrap/cc_detect.rs` for details.
727 #android-ndk = <none> (path)
729 # Build the sanitizer runtimes for this target.
730 # This option will override the same option under [build] section.
731 #sanitizers = build.sanitizers (bool)
733 # Build the profiler runtime for this target(required when compiling with options that depend
734 # on this runtime, such as `-C profile-generate` or `-C instrument-coverage`).
735 # This option will override the same option under [build] section.
736 #profiler = build.profiler (bool)
738 # Force static or dynamic linkage of the standard library for this target. If
739 # this target is a host for rustc, this will also affect the linkage of the
740 # compiler itself. This is useful for building rustc on targets that normally
741 # only use static libraries. If unset, the target's default linkage is used.
742 #crt-static = <platform-specific> (bool)
744 # The root location of the musl installation directory. The library directory
745 # will also need to contain libunwind.a for an unwinding implementation. Note
746 # that this option only makes sense for musl targets that produce statically
748 #musl-root = build.musl-root (path)
750 # The full path to the musl libdir.
751 #musl-libdir = musl-root/lib
753 # The root location of the `wasm32-wasi` sysroot. Only used for the
754 # `wasm32-wasi` target. If you are building wasm32-wasi target, make sure to
755 # create a `[target.wasm32-wasi]` section and move this field there.
756 #wasi-root = <none> (path)
758 # Used in testing for configuring where the QEMU images are located, you
759 # probably don't want to use this.
760 #qemu-rootfs = <none> (path)
762 # Skip building the `std` library for this target. Enabled by default for
763 # target triples containing `-none`, `nvptx`, `switch`, or `-uefi`.
764 #no-std = <platform-specific> (bool)
766 # =============================================================================
767 # Distribution options
769 # These options are related to distribution, mostly for the Rust project itself.
770 # You probably won't need to concern yourself with any of these options
771 # =============================================================================
774 # This is the folder of artifacts that the build system will sign. All files in
775 # this directory will be signed with the default gpg key using the system `gpg`
776 # binary. The `asc` and `sha256` files will all be output into the standard dist
777 # output folder (currently `build/dist`)
779 # This folder should be populated ahead of time before the build system is
781 #sign-folder = <none> (path)
783 # The remote address that all artifacts will eventually be uploaded to. The
784 # build system generates manifests which will point to these urls, and for the
785 # manifests to be correct they'll have to have the right URLs encoded.
787 # Note that this address should not contain a trailing slash as file names will
789 #upload-addr = <none> (URL)
791 # Whether to build a plain source tarball to upload
792 # We disable that on Windows not to override the one already uploaded on S3
793 # as the one built on Windows will contain backslashes in paths causing problems
797 # Whether to allow failures when building tools
798 #missing-tools = false
800 # List of compression formats to use when generating dist tarballs. The list of
801 # formats is provided to rust-installer, which must support all of them.
803 # This list must be non-empty.
804 #compression-formats = ["gz", "xz"]