]> git.lizzy.rs Git - rust.git/blob - src/bootstrap/config.toml.example
Unignore u128 test for stage 0,1
[rust.git] / src / bootstrap / 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 the LLVM build is a Release or Debug build
18 #optimize = true
19
20 # Indicates whether an LLVM Release build should include debug info
21 #release-debuginfo = false
22
23 # Indicates whether the LLVM assertions are enabled or not
24 #assertions = false
25
26 # Indicates whether ccache is used when building LLVM
27 #ccache = false
28 # or alternatively ...
29 #ccache = "/path/to/ccache"
30
31 # If an external LLVM root is specified, we automatically check the version by
32 # default to make sure it's within the range that we're expecting, but setting
33 # this flag will indicate that this version check should not be done.
34 #version-check = false
35
36 # Link libstdc++ statically into the librustc_llvm instead of relying on a
37 # dynamic version to be available.
38 #static-libstdcpp = false
39
40 # Tell the LLVM build system to use Ninja instead of the platform default for
41 # the generated build system. This can sometimes be faster than make, for
42 # example.
43 #ninja = false
44
45 # LLVM targets to build support for.
46 # Note: this is NOT related to Rust compilation targets. However, as Rust is
47 # dependent on LLVM for code generation, turning targets off here WILL lead to
48 # the resulting rustc being unable to compile for the disabled architectures.
49 # Also worth pointing out is that, in case support for new targets are added to
50 # LLVM, enabling them here doesn't mean Rust is automatically gaining said
51 # support. You'll need to write a target specification at least, and most
52 # likely, teach rustc about the C ABI of the target. Get in touch with the
53 # Rust team and file an issue if you need assistance in porting!
54 #targets = "X86;ARM;AArch64;Mips;PowerPC;SystemZ;JSBackend;MSP430;Sparc;NVPTX"
55
56 # =============================================================================
57 # General build configuration options
58 # =============================================================================
59 [build]
60
61 # Build triple for the original snapshot compiler. This must be a compiler that
62 # nightlies are already produced for. The current platform must be able to run
63 # binaries of this build triple and the nightly will be used to bootstrap the
64 # first compiler.
65 #build = "x86_64-unknown-linux-gnu"    # defaults to your host platform
66
67 # In addition to the build triple, other triples to produce full compiler
68 # toolchains for. Each of these triples will be bootstrapped from the build
69 # triple and then will continue to bootstrap themselves. This platform must
70 # currently be able to run all of the triples provided here.
71 #host = ["x86_64-unknown-linux-gnu"]   # defaults to just the build triple
72
73 # In addition to all host triples, other triples to produce the standard library
74 # for. Each host triple will be used to produce a copy of the standard library
75 # for each target triple.
76 #target = ["x86_64-unknown-linux-gnu"] # defaults to just the build triple
77
78 # Instead of downloading the src/nightlies.txt version of Cargo specified, use
79 # this Cargo binary instead to build all Rust code
80 #cargo = "/path/to/bin/cargo"
81
82 # Instead of downloading the src/nightlies.txt version of the compiler
83 # specified, use this rustc binary instead as the stage0 snapshot compiler.
84 #rustc = "/path/to/bin/rustc"
85
86 # Flag to specify whether any documentation is built. If false, rustdoc and
87 # friends will still be compiled but they will not be used to generate any
88 # documentation.
89 #docs = true
90
91 # Indicate whether the compiler should be documented in addition to the standard
92 # library and facade crates.
93 #compiler-docs = false
94
95 # Indicate whether submodules are managed and updated automatically.
96 #submodules = true
97
98 # The path to (or name of) the GDB executable to use. This is only used for
99 # executing the debuginfo test suite.
100 #gdb = "gdb"
101
102 # The node.js executable to use. Note that this is only used for the emscripten
103 # target when running tests, otherwise this can be omitted.
104 #nodejs = "node"
105
106 # Python interpreter to use for various tasks throughout the build, notably
107 # rustdoc tests, the lldb python interpreter, and some dist bits and pieces.
108 # Note that Python 2 is currently required.
109 #python = "python2.7"
110
111 # Indicate whether the vendored sources are used for Rust dependencies or not
112 #vendor = false
113
114 # Typically the build system will build the rust compiler twice. The second
115 # compiler, however, will simply use its own libraries to link against. If you
116 # would rather to perform a full bootstrap, compiling the compiler three times,
117 # then you can set this option to true. You shouldn't ever need to set this
118 # option to true.
119 #full-bootstrap = false
120
121 # Enable a build of the and extended rust tool set which is not only the
122 # compiler but also tools such as Cargo. This will also produce "combined
123 # installers" which are used to install Rust and Cargo together. This is
124 # disabled by default.
125 #extended = false
126
127 # =============================================================================
128 # General install configuration options
129 # =============================================================================
130 [install]
131
132 # Instead of installing to /usr/local, install to this path instead.
133 #prefix = "/usr/local"
134
135 # Where to install libraries in `prefix` above
136 #libdir = "lib"
137
138 # Where to install man pages in `prefix` above
139 #mandir = "share/man"
140
141 # Where to install documentation in `prefix` above
142 #docdir = "share/doc/rust"
143
144 # =============================================================================
145 # Options for compiling Rust code itself
146 # =============================================================================
147 [rust]
148
149 # Whether or not to optimize the compiler and standard library
150 #optimize = true
151
152 # Number of codegen units to use for each compiler invocation. A value of 0
153 # means "the number of cores on this machine", and 1+ is passed through to the
154 # compiler.
155 #codegen-units = 1
156
157 # Whether or not debug assertions are enabled for the compiler and standard
158 # library
159 #debug-assertions = false
160
161 # Whether or not debuginfo is emitted
162 #debuginfo = false
163
164 # Whether or not line number debug information is emitted
165 #debuginfo-lines = false
166
167 # Whether or not to only build debuginfo for the standard library if enabled.
168 # If enabled, this will not compile the compiler with debuginfo, just the
169 # standard library.
170 #debuginfo-only-std = false
171
172 # Whether or not jemalloc is built and enabled
173 #use-jemalloc = true
174
175 # Whether or not jemalloc is built with its debug option set
176 #debug-jemalloc = false
177
178 # Whether or not `panic!`s generate backtraces (RUST_BACKTRACE)
179 #backtrace = true
180
181 # The default linker that will be used by the generated compiler. Note that this
182 # is not the linker used to link said compiler.
183 #default-linker = "cc"
184
185 # The default ar utility that will be used by the generated compiler if LLVM
186 # cannot be used. Note that this is not used to assemble said compiler.
187 #default-ar = "ar"
188
189 # The "channel" for the Rust build to produce. The stable/beta channels only
190 # allow using stable features, whereas the nightly and dev channels allow using
191 # nightly features
192 #channel = "dev"
193
194 # By default the `rustc` executable is built with `-Wl,-rpath` flags on Unix
195 # platforms to ensure that the compiler is usable by default from the build
196 # directory (as it links to a number of dynamic libraries). This may not be
197 # desired in distributions, for example.
198 #rpath = true
199
200 # Flag indicating whether tests are compiled with optimizations (the -O flag) or
201 # with debuginfo (the -g flag)
202 #optimize-tests = true
203 #debuginfo-tests = true
204
205 # Flag indicating whether codegen tests will be run or not. If you get an error
206 # saying that the FileCheck executable is missing, you may want to disable this.
207 #codegen-tests = true
208
209 # =============================================================================
210 # Options for specific targets
211 #
212 # Each of the following options is scoped to the specific target triple in
213 # question and is used for determining how to compile each target.
214 # =============================================================================
215 [target.x86_64-unknown-linux-gnu]
216
217 # C compiler to be used to compiler C code and link Rust code. Note that the
218 # default value is platform specific, and if not specified it may also depend on
219 # what platform is crossing to what platform.
220 #cc = "cc"
221
222 # C++ compiler to be used to compiler C++ code (e.g. LLVM and our LLVM shims).
223 # This is only used for host targets.
224 #cxx = "c++"
225
226 # Path to the `llvm-config` binary of the installation of a custom LLVM to link
227 # against. Note that if this is specifed we don't compile LLVM at all for this
228 # target.
229 #llvm-config = "../path/to/llvm/root/bin/llvm-config"
230
231 # Path to the custom jemalloc static library to link into the standard library
232 # by default. This is only used if jemalloc is still enabled above
233 #jemalloc = "/path/to/jemalloc/libjemalloc_pic.a"
234
235 # If this target is for Android, this option will be required to specify where
236 # the NDK for the target lives. This is used to find the C compiler to link and
237 # build native code.
238 #android-ndk = "/path/to/ndk"
239
240 # The root location of the MUSL installation directory. The library directory
241 # will also need to contain libunwind.a for an unwinding implementation. Note
242 # that this option only makes sense for MUSL targets that produce statically
243 # linked binaries
244 #musl-root = "..."
245
246 # =============================================================================
247 # Distribution options
248 #
249 # These options are related to distribution, mostly for the Rust project itself.
250 # You probably won't need to concern yourself with any of these options
251 # =============================================================================
252 [dist]
253
254 # This is the folder of artifacts that the build system will sign. All files in
255 # this directory will be signed with the default gpg key using the system `gpg`
256 # binary. The `asc` and `sha256` files will all be output into the standard dist
257 # output folder (currently `build/dist`)
258 #
259 # This folder should be populated ahead of time before the build system is
260 # invoked.
261 #sign-folder = "path/to/folder/to/sign"
262
263 # This is a file which contains the password of the default gpg key. This will
264 # be passed to `gpg` down the road when signing all files in `sign-folder`
265 # above. This should be stored in plaintext.
266 #gpg-password-file = "path/to/gpg/password"
267
268 # The remote address that all artifacts will eventually be uploaded to. The
269 # build system generates manifests which will point to these urls, and for the
270 # manifests to be correct they'll have to have the right URLs encoded.
271 #
272 # Note that this address should not contain a trailing slash as file names will
273 # be appended to it.
274 #upload-addr = "https://example.com/folder"