fork/rust

git clone https://git.julia.blue/fork/rust

borsAuto merge of #72883 - Mark-Simulacrum:stable-next, r=Mark-Simulacrum49cae55760d

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