fork/rust

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

borsAuto merge of #67350 - Mark-Simulacrum:stable-next, r=Mark-Simulacrum73528e339aa

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