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