]> git.lizzy.rs Git - rust.git/blob - config.toml.example
Auto merge of #87798 - durin42:llvm-14, r=nikic
[rust.git] / config.toml.example
1 # Sample TOML configuration file for building Rust.
2 #
3 # To configure rustbuild, copy this file to the directory from which you will be
4 # running the build, and name it config.toml.
5 #
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
10 # system.
11
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.
16 changelog-seen = 2
17
18 # =============================================================================
19 # Global Settings
20 # =============================================================================
21
22 # Use different pre-set defaults than the global defaults.
23 #
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`).
26 #profile = <none>
27
28 # =============================================================================
29 # Tweaking how LLVM is compiled
30 # =============================================================================
31 [llvm]
32
33 # Whether to use Rust CI built LLVM instead of locally building it.
34 #
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.
37 #
38 # This is false by default so that distributions don't unexpectedly download
39 # LLVM from the internet.
40 #
41 # All tier 1 targets are currently supported; set this to `"if-available"` if
42 # you are not sure whether you're on a tier 1 target.
43 #
44 # We also currently only support this when building LLVM for the build triple.
45 #
46 # Note that many of the LLVM options are not currently supported for
47 # downloading. Currently only the "assertions" option can be toggled.
48 #download-ci-llvm = false
49
50 # Indicates whether LLVM rebuild should be skipped when running bootstrap. If
51 # this is `false` then the compiler's LLVM will be rebuilt whenever the built
52 # version doesn't have the correct hash. If it is `true` then LLVM will never
53 # be rebuilt. The default value is `false`.
54 #skip-rebuild = false
55
56 # Indicates whether the LLVM build is a Release or Debug build
57 #optimize = true
58
59 # Indicates whether LLVM should be built with ThinLTO. Note that this will
60 # only succeed if you use clang, lld, llvm-ar, and llvm-ranlib in your C/C++
61 # toolchain (see the `cc`, `cxx`, `linker`, `ar`, and `ranlib` options below).
62 # More info at: https://clang.llvm.org/docs/ThinLTO.html#clang-bootstrap
63 #thin-lto = false
64
65 # Indicates whether an LLVM Release build should include debug info
66 #release-debuginfo = false
67
68 # Indicates whether the LLVM assertions are enabled or not
69 #assertions = false
70
71 # Indicates whether the LLVM plugin is enabled or not
72 #plugins = false
73
74 # Indicates whether ccache is used when building LLVM
75 #ccache = false
76 # or alternatively ...
77 #ccache = "/path/to/ccache"
78
79 # If an external LLVM root is specified, we automatically check the version by
80 # default to make sure it's within the range that we're expecting, but setting
81 # this flag will indicate that this version check should not be done.
82 #version-check = true
83
84 # Link libstdc++ statically into the rustc_llvm instead of relying on a
85 # dynamic version to be available.
86 #static-libstdcpp = false
87
88 # Whether to use Ninja to build LLVM. This runs much faster than make.
89 #ninja = true
90
91 # LLVM targets to build support for.
92 # Note: this is NOT related to Rust compilation targets. However, as Rust is
93 # dependent on LLVM for code generation, turning targets off here WILL lead to
94 # the resulting rustc being unable to compile for the disabled architectures.
95 # Also worth pointing out is that, in case support for new targets are added to
96 # LLVM, enabling them here doesn't mean Rust is automatically gaining said
97 # support. You'll need to write a target specification at least, and most
98 # likely, teach rustc about the C ABI of the target. Get in touch with the
99 # Rust team and file an issue if you need assistance in porting!
100 #targets = "AArch64;ARM;BPF;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;Sparc;SystemZ;WebAssembly;X86"
101
102 # LLVM experimental targets to build support for. These targets are specified in
103 # the same format as above, but since these targets are experimental, they are
104 # not built by default and the experimental Rust compilation targets that depend
105 # on them will not work unless the user opts in to building them.
106 #experimental-targets = "AVR"
107
108 # Cap the number of parallel linker invocations when compiling LLVM.
109 # This can be useful when building LLVM with debug info, which significantly
110 # increases the size of binaries and consequently the memory required by
111 # each linker process.
112 # If absent or 0, linker invocations are treated like any other job and
113 # controlled by rustbuild's -j parameter.
114 #link-jobs = 0
115
116 # When invoking `llvm-config` this configures whether the `--shared` argument is
117 # passed to prefer linking to shared libraries.
118 # NOTE: `thin-lto = true` requires this to be `true` and will give an error otherwise.
119 #link-shared = false
120
121 # When building llvm, this configures what is being appended to the version.
122 # The default is "-rust-$version-$channel", except for dev channel where rustc
123 # version number is omitted. To use LLVM version as is, provide an empty string.
124 #version-suffix = "-rust-dev"
125
126 # On MSVC you can compile LLVM with clang-cl, but the test suite doesn't pass
127 # with clang-cl, so this is special in that it only compiles LLVM with clang-cl.
128 # Note that this takes a /path/to/clang-cl, not a boolean.
129 #clang-cl = cc
130
131 # Pass extra compiler and linker flags to the LLVM CMake build.
132 #cflags = ""
133 #cxxflags = ""
134 #ldflags = ""
135
136 # Use libc++ when building LLVM instead of libstdc++. This is the default on
137 # platforms already use libc++ as the default C++ library, but this option
138 # allows you to use libc++ even on platforms when it's not. You need to ensure
139 # that your host compiler ships with libc++.
140 #use-libcxx = false
141
142 # The value specified here will be passed as `-DLLVM_USE_LINKER` to CMake.
143 #use-linker = <none> (path)
144
145 # Whether or not to specify `-DLLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN=YES`
146 #allow-old-toolchain = false
147
148 # Whether to include the Polly optimizer.
149 #polly = false
150
151 # Whether to build the clang compiler.
152 #clang = false
153
154 # =============================================================================
155 # General build configuration options
156 # =============================================================================
157 [build]
158 # The default stage to use for the `check` subcommand
159 #check-stage = 0
160
161 # The default stage to use for the `doc` subcommand
162 #doc-stage = 0
163
164 # The default stage to use for the `build` subcommand
165 #build-stage = 1
166
167 # The default stage to use for the `test` subcommand
168 #test-stage = 1
169
170 # The default stage to use for the `dist` subcommand
171 #dist-stage = 2
172
173 # The default stage to use for the `install` subcommand
174 #install-stage = 2
175
176 # The default stage to use for the `bench` subcommand
177 #bench-stage = 2
178
179 # Build triple for the original snapshot compiler. This must be a compiler that
180 # nightlies are already produced for. The current platform must be able to run
181 # binaries of this build triple and the nightly will be used to bootstrap the
182 # first compiler.
183 #
184 # Defaults to platform where `x.py` is run.
185 #build = "x86_64-unknown-linux-gnu" (as an example)
186
187 # Which triples to produce a compiler toolchain for. Each of these triples will
188 # be bootstrapped from the build triple themselves.
189 #
190 # Defaults to just the build triple.
191 #host = ["x86_64-unknown-linux-gnu"] (as an example)
192
193 # Which triples to build libraries (core/alloc/std/test/proc_macro) for. Each of
194 # these triples will be bootstrapped from the build triple themselves.
195 #
196 # Defaults to `host`. If you set this explicitly, you likely want to add all
197 # host triples to this list as well in order for those host toolchains to be
198 # able to compile programs for their native target.
199 #target = ["x86_64-unknown-linux-gnu"] (as an example)
200
201 # Use this directory to store build artifacts.
202 # You can use "$ROOT" to indicate the root of the git repository.
203 #build-dir = "build"
204
205 # Instead of downloading the src/stage0.txt version of Cargo specified, use
206 # this Cargo binary instead to build all Rust code
207 #cargo = "/path/to/cargo"
208
209 # Instead of downloading the src/stage0.txt version of the compiler
210 # specified, use this rustc binary instead as the stage0 snapshot compiler.
211 #rustc = "/path/to/rustc"
212
213 # Instead of download the src/stage0.txt version of rustfmt specified,
214 # use this rustfmt binary instead as the stage0 snapshot rustfmt.
215 #rustfmt = "/path/to/rustfmt"
216
217 # Flag to specify whether any documentation is built. If false, rustdoc and
218 # friends will still be compiled but they will not be used to generate any
219 # documentation.
220 #docs = true
221
222 # Flag to specify whether CSS, JavaScript, and HTML are minified when
223 # docs are generated. JSON is always minified, because it's enormous,
224 # and generated in already-minified form from the beginning.
225 #docs-minification = true
226
227 # Indicate whether the compiler should be documented in addition to the standard
228 # library and facade crates.
229 #compiler-docs = false
230
231 # Indicate whether git submodules are managed and updated automatically.
232 #submodules = true
233
234 # Update git submodules only when the checked out commit in the submodules differs
235 # from what is committed in the main rustc repo.
236 #fast-submodules = true
237
238 # The path to (or name of) the GDB executable to use. This is only used for
239 # executing the debuginfo test suite.
240 #gdb = "gdb"
241
242 # The node.js executable to use. Note that this is only used for the emscripten
243 # target when running tests, otherwise this can be omitted.
244 #nodejs = "node"
245
246 # Python interpreter to use for various tasks throughout the build, notably
247 # rustdoc tests, the lldb python interpreter, and some dist bits and pieces.
248 #
249 # Defaults to the Python interpreter used to execute x.py
250 #python = "python"
251
252 # Force Cargo to check that Cargo.lock describes the precise dependency
253 # set that all the Cargo.toml files create, instead of updating it.
254 #locked-deps = false
255
256 # Indicate whether the vendored sources are used for Rust dependencies or not
257 #vendor = false
258
259 # Typically the build system will build the Rust compiler twice. The second
260 # compiler, however, will simply use its own libraries to link against. If you
261 # would rather to perform a full bootstrap, compiling the compiler three times,
262 # then you can set this option to true. You shouldn't ever need to set this
263 # option to true.
264 #full-bootstrap = false
265
266 # Enable a build of the extended Rust tool set which is not only the compiler
267 # but also tools such as Cargo. This will also produce "combined installers"
268 # which are used to install Rust and Cargo together. This is disabled by
269 # default. The `tools` option (immediately below) specifies which tools should
270 # be built if `extended = true`.
271 #extended = false
272
273 # Installs chosen set of extended tools if `extended = true`. By default builds
274 # all extended tools except `rust-demangler`, unless the target is also being
275 # built with `profiler = true`. If chosen tool failed to build the installation
276 # fails. If `extended = false`, this option is ignored.
277 #tools = ["cargo", "rls", "clippy", "rustfmt", "analysis", "src"] # + "rust-demangler" if `profiler`
278
279 # Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose
280 #verbose = 0
281
282 # Build the sanitizer runtimes
283 #sanitizers = false
284
285 # Build the profiler runtime (required when compiling with options that depend
286 # on this runtime, such as `-C profile-generate` or `-Z instrument-coverage`).
287 #profiler = false
288
289 # Indicates whether the native libraries linked into Cargo will be statically
290 # linked or not.
291 #cargo-native-static = false
292
293 # Run the build with low priority, by setting the process group's "nice" value
294 # to +10 on Unix platforms, and by using a "low priority" job object on Windows.
295 #low-priority = false
296
297 # Arguments passed to the `./configure` script, used during distcheck. You
298 # probably won't fill this in but rather it's filled in by the `./configure`
299 # script.
300 #configure-args = []
301
302 # Indicates that a local rebuild is occurring instead of a full bootstrap,
303 # essentially skipping stage0 as the local compiler is recompiling itself again.
304 #local-rebuild = false
305
306 # Print out how long each rustbuild step took (mostly intended for CI and
307 # tracking over time)
308 #print-step-timings = false
309
310 # Print out resource usage data for each rustbuild step, as defined by the Unix
311 # struct rusage. (Note that this setting is completely unstable: the data it
312 # captures, what platforms it supports, the format of its associated output, and
313 # this setting's very existence, are all subject to change.)
314 #print-step-rusage = false
315
316 # =============================================================================
317 # General install configuration options
318 # =============================================================================
319 [install]
320
321 # Instead of installing to /usr/local, install to this path instead.
322 #prefix = "/usr/local"
323
324 # Where to install system configuration files
325 # If this is a relative path, it will get installed in `prefix` above
326 #sysconfdir = "/etc"
327
328 # Where to install documentation in `prefix` above
329 #docdir = "share/doc/rust"
330
331 # Where to install binaries in `prefix` above
332 #bindir = "bin"
333
334 # Where to install libraries in `prefix` above
335 #libdir = "lib"
336
337 # Where to install man pages in `prefix` above
338 #mandir = "share/man"
339
340 # Where to install data in `prefix` above
341 #datadir = "share"
342
343 # =============================================================================
344 # Options for compiling Rust code itself
345 # =============================================================================
346 [rust]
347
348 # Whether or not to optimize the compiler and standard library.
349 # WARNING: Building with optimize = false is NOT SUPPORTED. Due to bootstrapping,
350 # building without optimizations takes much longer than optimizing. Further, some platforms
351 # fail to build without this optimization (c.f. #65352).
352 #optimize = true
353
354 # Indicates that the build should be configured for debugging Rust. A
355 # `debug`-enabled compiler and standard library will be somewhat
356 # slower (due to e.g. checking of debug assertions) but should remain
357 # usable.
358 #
359 # Note: If this value is set to `true`, it will affect a number of
360 #       configuration options below as well, if they have been left
361 #       unconfigured in this file.
362 #
363 # Note: changes to the `debug` setting do *not* affect `optimize`
364 #       above. In theory, a "maximally debuggable" environment would
365 #       set `optimize` to `false` above to assist the introspection
366 #       facilities of debuggers like lldb and gdb. To recreate such an
367 #       environment, explicitly set `optimize` to `false` and `debug`
368 #       to `true`. In practice, everyone leaves `optimize` set to
369 #       `true`, because an unoptimized rustc with debugging
370 #       enabled becomes *unusably slow* (e.g. rust-lang/rust#24840
371 #       reported a 25x slowdown) and bootstrapping the supposed
372 #       "maximally debuggable" environment (notably libstd) takes
373 #       hours to build.
374 #
375 #debug = false
376
377 # Whether to download the stage 1 and 2 compilers from CI.
378 # This is mostly useful for tools; if you have changes to `compiler/` they will be ignored.
379 #
380 # You can set this to "if-unchanged" to only download if `compiler/` has not been modified.
381 #download-rustc = false
382
383 # Number of codegen units to use for each compiler invocation. A value of 0
384 # means "the number of cores on this machine", and 1+ is passed through to the
385 # compiler.
386 #
387 # Uses the rustc defaults: https://doc.rust-lang.org/rustc/codegen-options/index.html#codegen-units
388 #codegen-units = if incremental { 256 } else { 16 }
389
390 # Sets the number of codegen units to build the standard library with,
391 # regardless of what the codegen-unit setting for the rest of the compiler is.
392 # NOTE: building with anything other than 1 is known to occasionally have bugs.
393 # See https://github.com/rust-lang/rust/issues/83600.
394 #codegen-units-std = codegen-units
395
396 # Whether or not debug assertions are enabled for the compiler and standard
397 # library. Debug assertions control the maximum log level used by rustc. When
398 # enabled calls to `trace!` and `debug!` macros are preserved in the compiled
399 # binary, otherwise they are omitted.
400 #
401 # Defaults to rust.debug value
402 #debug-assertions = rust.debug (boolean)
403
404 # Whether or not debug assertions are enabled for the standard library.
405 # Overrides the `debug-assertions` option, if defined.
406 #
407 # Defaults to rust.debug-assertions value
408 #debug-assertions-std = rust.debug-assertions (boolean)
409
410 # Whether or not to leave debug! and trace! calls in the rust binary.
411 # Overrides the `debug-assertions` option, if defined.
412 #
413 # Defaults to rust.debug-assertions value
414 #
415 # If you see a message from `tracing` saying
416 # `max_level_info` is enabled and means logging won't be shown,
417 # set this value to `true`.
418 #debug-logging = rust.debug-assertions (boolean)
419
420 # Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
421 # `0` - no debug info
422 # `1` - line tables only - sufficient to generate backtraces that include line
423 #       information and inlined functions, set breakpoints at source code
424 #       locations, and step through execution in a debugger.
425 # `2` - full debug info with variable and type information
426 # Can be overridden for specific subsets of Rust code (rustc, std or tools).
427 # Debuginfo for tests run with compiletest is not controlled by this option
428 # and needs to be enabled separately with `debuginfo-level-tests`.
429 #
430 # Note that debuginfo-level = 2 generates several gigabytes of debuginfo
431 # and will slow down the linking process significantly.
432 #
433 # Defaults to 1 if debug is true
434 #debuginfo-level = 0
435
436 # Debuginfo level for the compiler.
437 #debuginfo-level-rustc = debuginfo-level
438
439 # Debuginfo level for the standard library.
440 #debuginfo-level-std = debuginfo-level
441
442 # Debuginfo level for the tools.
443 #debuginfo-level-tools = debuginfo-level
444
445 # Debuginfo level for the test suites run with compiletest.
446 # FIXME(#61117): Some tests fail when this option is enabled.
447 #debuginfo-level-tests = 0
448
449 # Whether to run `dsymutil` on Apple platforms to gather debug info into .dSYM
450 # bundles. `dsymutil` adds time to builds for no clear benefit, and also makes
451 # it more difficult for debuggers to find debug info. The compiler currently
452 # defaults to running `dsymutil` to preserve its historical default, but when
453 # compiling the compiler itself, we skip it by default since we know it's safe
454 # to do so in that case.
455 #run-dsymutil = false
456
457 # Whether or not `panic!`s generate backtraces (RUST_BACKTRACE)
458 #backtrace = true
459
460 # Whether to always use incremental compilation when building rustc
461 #incremental = false
462
463 # Build a multi-threaded rustc
464 # FIXME(#75760): Some UI tests fail when this option is enabled.
465 #parallel-compiler = false
466
467 # The default linker that will be hard-coded into the generated compiler for
468 # targets that don't specify linker explicitly in their target specifications.
469 # Note that this is not the linker used to link said compiler.
470 #
471 # See https://doc.rust-lang.org/rustc/codegen-options/index.html#linker for more information.
472 #default-linker = <none> (path)
473
474 # The "channel" for the Rust build to produce. The stable/beta channels only
475 # allow using stable features, whereas the nightly and dev channels allow using
476 # nightly features
477 #channel = "dev"
478
479 # A descriptive string to be appended to `rustc --version` output, which is
480 # also used in places like debuginfo `DW_AT_producer`. This may be useful for
481 # supplementary build information, like distro-specific package versions.
482 #description = <none> (string)
483
484 # The root location of the musl installation directory. The library directory
485 # will also need to contain libunwind.a for an unwinding implementation. Note
486 # that this option only makes sense for musl targets that produce statically
487 # linked binaries.
488 #
489 # Defaults to /usr on musl hosts. Has no default otherwise.
490 #musl-root = <platform specific> (path)
491
492 # By default the `rustc` executable is built with `-Wl,-rpath` flags on Unix
493 # platforms to ensure that the compiler is usable by default from the build
494 # directory (as it links to a number of dynamic libraries). This may not be
495 # desired in distributions, for example.
496 #rpath = true
497
498 # Prints each test name as it is executed, to help debug issues in the test harness itself.
499 #verbose-tests = false
500
501 # Flag indicating whether tests are compiled with optimizations (the -O flag).
502 #optimize-tests = true
503
504 # Flag indicating whether codegen tests will be run or not. If you get an error
505 # saying that the FileCheck executable is missing, you may want to disable this.
506 # Also see the target's llvm-filecheck option.
507 #codegen-tests = true
508
509 # Flag indicating whether git info will be retrieved from .git automatically.
510 # Having the git information can cause a lot of rebuilds during development.
511 # Note: If this attribute is not explicitly set (e.g. if left commented out) it
512 # will default to true if channel = "dev", but will default to false otherwise.
513 #ignore-git = if channel == "dev" { true } else { false }
514
515 # When creating source tarballs whether or not to create a source tarball.
516 #dist-src = true
517
518 # After building or testing extended tools (e.g. clippy and rustfmt), append the
519 # result (broken, compiling, testing) into this JSON file.
520 #save-toolstates = <none> (path)
521
522 # This is an array of the codegen backends that will be compiled for the rustc
523 # that's being compiled. The default is to only build the LLVM codegen backend,
524 # and currently the only standard options supported are `"llvm"` and `"cranelift"`.
525 #codegen-backends = ["llvm"]
526
527 # Indicates whether LLD will be compiled and made available in the sysroot for
528 # rustc to execute.
529 #lld = false
530
531 # Indicates whether LLD will be used to link Rust crates during bootstrap on
532 # supported platforms. The LLD from the bootstrap distribution will be used
533 # and not the LLD compiled during the bootstrap.
534 #
535 # LLD will not be used if we're cross linking.
536 #
537 # Explicitly setting the linker for a target will override this option when targeting MSVC.
538 #use-lld = false
539
540 # Indicates whether some LLVM tools, like llvm-objdump, will be made available in the
541 # sysroot.
542 #llvm-tools = false
543
544 # Whether to deny warnings in crates
545 #deny-warnings = true
546
547 # Print backtrace on internal compiler errors during bootstrap
548 #backtrace-on-ice = false
549
550 # Whether to verify generated LLVM IR
551 #verify-llvm-ir = false
552
553 # Compile the compiler with a non-default ThinLTO import limit. This import
554 # limit controls the maximum size of functions imported by ThinLTO. Decreasing
555 # will make code compile faster at the expense of lower runtime performance.
556 #thin-lto-import-instr-limit = if incremental { 10 } else { LLVM default (currently 100) }
557
558 # Map debuginfo paths to `/rust/$sha/...`, generally only set for releases
559 #remap-debuginfo = false
560
561 # Link the compiler against `jemalloc`, where on Linux and OSX it should
562 # override the default allocator for rustc and LLVM.
563 #jemalloc = false
564
565 # Run tests in various test suites with the "nll compare mode" in addition to
566 # running the tests in normal mode. Largely only used on CI and during local
567 # development of NLL
568 #test-compare-mode = false
569
570 # Use LLVM libunwind as the implementation for Rust's unwinder.
571 # Accepted values are 'in-tree' (formerly true), 'system' or 'no' (formerly false).
572 # This option only applies for Linux and Fuchsia targets.
573 # On Linux target, if crt-static is not enabled, 'no' means dynamic link to
574 # `libgcc_s.so`, 'in-tree' means static link to the in-tree build of llvm libunwind
575 # and 'system' means dynamic link to `libunwind.so`. If crt-static is enabled,
576 # the behavior is depend on the libc. On musl target, 'no' and 'in-tree' both
577 # means static link to the in-tree build of llvm libunwind, and 'system' means
578 # static link to `libunwind.a` provided by system. Due to the limitation of glibc,
579 # it must link to `libgcc_eh.a` to get a working output, and this option have no effect.
580 #llvm-libunwind = 'no'
581
582 # Enable Windows Control Flow Guard checks in the standard library.
583 # This only applies from stage 1 onwards, and only for Windows targets.
584 #control-flow-guard = false
585
586 # Enable symbol-mangling-version v0. This can be helpful when profiling rustc,
587 # as generics will be preserved in symbols (rather than erased into opaque T).
588 #new-symbol-mangling = false
589
590 # =============================================================================
591 # Options for specific targets
592 #
593 # Each of the following options is scoped to the specific target triple in
594 # question and is used for determining how to compile each target.
595 # =============================================================================
596 [target.x86_64-unknown-linux-gnu]
597
598 # C compiler to be used to compile C code. Note that the
599 # default value is platform specific, and if not specified it may also depend on
600 # what platform is crossing to what platform.
601 # See `src/bootstrap/cc_detect.rs` for details.
602 #cc = "cc" (path)
603
604 # C++ compiler to be used to compile C++ code (e.g. LLVM and our LLVM shims).
605 # This is only used for host targets.
606 # See `src/bootstrap/cc_detect.rs` for details.
607 #cxx = "c++" (path)
608
609 # Archiver to be used to assemble static libraries compiled from C/C++ code.
610 # Note: an absolute path should be used, otherwise LLVM build will break.
611 #ar = "ar" (path)
612
613 # Ranlib to be used to assemble static libraries compiled from C/C++ code.
614 # Note: an absolute path should be used, otherwise LLVM build will break.
615 #ranlib = "ranlib" (path)
616
617 # Linker to be used to bootstrap Rust code. Note that the
618 # default value is platform specific, and if not specified it may also depend on
619 # what platform is crossing to what platform.
620 # Setting this will override the `use-lld` option for Rust code when targeting MSVC.
621 #linker = "cc" (path)
622
623 # Path to the `llvm-config` binary of the installation of a custom LLVM to link
624 # against. Note that if this is specified we don't compile LLVM at all for this
625 # target.
626 #llvm-config = <none> (path)
627
628 # Normally the build system can find LLVM's FileCheck utility, but if
629 # not, you can specify an explicit file name for it.
630 #llvm-filecheck = "/path/to/llvm-version/bin/FileCheck"
631
632 # If this target is for Android, this option will be required to specify where
633 # the NDK for the target lives. This is used to find the C compiler to link and
634 # build native code.
635 # See `src/bootstrap/cc_detect.rs` for details.
636 #android-ndk = <none> (path)
637
638 # Build the sanitizer runtimes for this target.
639 # This option will override the same option under [build] section.
640 #sanitizers = build.sanitizers (bool)
641
642 # Build the profiler runtime for this target(required when compiling with options that depend
643 # on this runtime, such as `-C profile-generate` or `-Z instrument-coverage`).
644 # This option will override the same option under [build] section.
645 #profiler = build.profiler (bool)
646
647 # Force static or dynamic linkage of the standard library for this target. If
648 # this target is a host for rustc, this will also affect the linkage of the
649 # compiler itself. This is useful for building rustc on targets that normally
650 # only use static libraries. If unset, the target's default linkage is used.
651 #crt-static = <platform-specific> (bool)
652
653 # The root location of the musl installation directory. The library directory
654 # will also need to contain libunwind.a for an unwinding implementation. Note
655 # that this option only makes sense for musl targets that produce statically
656 # linked binaries.
657 #musl-root = build.musl-root (path)
658
659 # The full path to the musl libdir.
660 #musl-libdir = musl-root/lib
661
662 # The root location of the `wasm32-wasi` sysroot. Only used for the
663 # `wasm32-wasi` target. If you are building wasm32-wasi target, make sure to
664 # create a `[target.wasm32-wasi]` section and move this field there.
665 #wasi-root = <none> (path)
666
667 # Used in testing for configuring where the QEMU images are located, you
668 # probably don't want to use this.
669 #qemu-rootfs = <none> (path)
670
671 # =============================================================================
672 # Distribution options
673 #
674 # These options are related to distribution, mostly for the Rust project itself.
675 # You probably won't need to concern yourself with any of these options
676 # =============================================================================
677 [dist]
678
679 # This is the folder of artifacts that the build system will sign. All files in
680 # this directory will be signed with the default gpg key using the system `gpg`
681 # binary. The `asc` and `sha256` files will all be output into the standard dist
682 # output folder (currently `build/dist`)
683 #
684 # This folder should be populated ahead of time before the build system is
685 # invoked.
686 #sign-folder = <none> (path)
687
688 # The remote address that all artifacts will eventually be uploaded to. The
689 # build system generates manifests which will point to these urls, and for the
690 # manifests to be correct they'll have to have the right URLs encoded.
691 #
692 # Note that this address should not contain a trailing slash as file names will
693 # be appended to it.
694 #upload-addr = <none> (URL)
695
696 # Whether to build a plain source tarball to upload
697 # We disable that on Windows not to override the one already uploaded on S3
698 # as the one built on Windows will contain backslashes in paths causing problems
699 # on linux
700 #src-tarball = true
701
702 # Whether to allow failures when building tools
703 #missing-tools = false
704
705 # List of compression formats to use when generating dist tarballs. The list of
706 # formats is provided to rust-installer, which must support all of them.
707 #
708 # This list must be non-empty.
709 #compression-formats = ["gz", "xz"]