1 # Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 # file at the top-level directory of this distribution and at
3 # http://rust-lang.org/COPYRIGHT.
5 # Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 # http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 # <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 # option. This file may not be copied, modified, or distributed
9 # except according to those terms.
13 # Greetings, adventurer! The Rust Build System is at your service.
15 # Whether you want a genuine copy of `rustc`, access to the latest and
16 # most authoritative Rust documentation, or even to investigate the
17 # most intimate workings of the compiler itself, you've come to the
18 # right place. Let's see what's on the menu.
20 # First, start with one of these build targets:
22 # * all - The default. Build a complete, bootstrapped compiler.
23 # `rustc` will be in `${target-triple}/stage2/bin/`. Run it
24 # directly from the build directory if you like. This also
25 # comes with docs in `doc/`.
27 # * check - Run the complete test suite
29 # * clean - Clean the build repertory. It is advised to run this
30 # command if you want to build Rust again, after an update
31 # of the git repository.
33 # * install - Install Rust. Note that installation is not necessary
34 # to use the compiler.
36 # * uninstall - Uninstall the binaries
38 # For tips on working with The Rust Build System, just:
50 # # The Rust Build System Tip Line
52 # There are a bazillion different targets you might want to build. Here
55 # * docs - Build gobs of HTML documentation and put it into `doc/`
56 # * check-$(crate) - Test a crate, e.g. `check-std`
57 # * check-ref - Run the language reference tests
58 # * check-docs - Test the documentation examples
59 # * check-stage$(stage)-$(crate) - Test a crate in a specific stage
60 # * check-stage$(stage)-{rpass,rfail,cfail,rmake,...} - Run tests in src/test/
61 # * check-stage1-T-$(target)-H-$(host) - Run cross-compiled-tests
62 # * tidy-basic - show file / line stats
63 # * tidy-errors - show the highest rustc error code
64 # * tidy-features - show the status of language and lib features
66 # Then mix in some of these environment variables to harness the
67 # ultimate power of The Rust Build System.
69 # * `VERBOSE=1` - Print all commands. Use this to see what's going on.
70 # * `RUSTFLAGS=...` - Add compiler flags to all `rustc` invocations
71 # * `JEMALLOC_FLAGS=...` - Pass flags to jemalloc's configure script
73 # * `TESTNAME=...` - Specify the name of tests to run
74 # * `CHECK_IGNORED=1` - Run normally-ignored tests
75 # * `PLEASE_BENCH=1` - Run crate benchmarks (enable `--bench` flag)
77 # * `CFG_ENABLE_VALGRIND=1` - Run tests under valgrind
78 # * `VALGRIND_COMPILE=1` - Run the compiler itself under valgrind
79 # (requires `CFG_ENABLE_VALGRIND`)
81 # * `NO_REBUILD=1` - Don't rebootstrap when testing std
82 # (and possibly other crates)
83 # * `NO_MKFILE_DEPS=1` - Don't rebuild for modified .mk files
85 # * `SAVE_TEMPS=1` - Use `--save-temps` flag on all `rustc` invocations
86 # * `ASM_COMMENTS=1` - Use `-Z asm-comments`
87 # * `TIME_PASSES=1` - Use `-Z time-passes`
88 # * `TIME_LLVM_PASSES=1` - Use `-Z time-llvm-passes`
89 # * `TRACE=1` - Use `-Z trace`
91 # # Rust recipes for build system success
93 # // Modifying libstd? Use this comment to run unit tests just on your change
94 # make check-stage1-std NO_REBUILD=1 NO_BENCH=1
96 # // Added a run-pass test? Use this to test running your test
97 # make check-stage1-rpass TESTNAME=my-shiny-new-test
99 # // Having trouble figuring out which test is failing? Turn off parallel tests
100 # make check-stage1-std RUST_TEST_THREADS=1
102 # If you really feel like getting your hands dirty, then:
104 # run `make nitty-gritty`
110 # # The Rust Build System
112 # Gosh I wish there was something useful here (TODO).
114 # # An (old) explanation of how the build is structured:
116 # *Note: Hey, like, this is probably inaccurate, and is definitely
117 # an outdated and insufficient explanation of the remarkable
118 # Rust Build System.*
120 # There are multiple build stages (0-3) needed to verify that the
121 # compiler is properly self-hosting. Each stage is divided between
122 # 'host' artifacts and 'target' artifacts, where the stageN host
123 # compiler builds artifacts for 1 or more stageN target architectures.
124 # Once the stageN target compiler has been built for the host
125 # architecture it is promoted (copied) to a stageN+1 host artifact.
127 # The stage3 host compiler is a compiler that successfully builds
128 # itself and should (in theory) be bitwise identical to the stage2
129 # host compiler. The process is bootstrapped using a stage0 host
130 # compiler downloaded from a previous snapshot.
132 # At no time should stageN artifacts be interacting with artifacts
133 # from other stages. For consistency, we use the 'promotion' logic
134 # for all artifacts, even those that don't make sense on non-host
137 # The directory layout for a stage is intended to match the layout
138 # of the installed compiler, and looks like the following:
140 # stageN - this is the system root, corresponding to, e.g. /usr
141 # bin - binaries compiled for the host
142 # lib - libraries used by the host compiler
143 # rustlib - rustc's own place to organize libraries
144 # $(target) - target-specific artifacts
145 # bin - binaries for target architectures
146 # lib - libraries for target architectures
148 # A note about host libraries:
150 # The only libraries that get promoted to stageN/lib are those needed
151 # by rustc. In general, rust programs, even those compiled for the
152 # host architecture will use libraries from the target
153 # directories. This gives rust some freedom to experiment with how
154 # libraries are managed and versioned without polluting the common
155 # areas of the filesystem.
157 # General rust binaries may still live in the host bin directory; they
158 # will just link against the libraries in the target lib directory.
160 # Admittedly this is a little convoluted.
162 # If you find yourself working on the make infrastructure itself, and trying to
163 # find the value of a given variable after expansion, you can use:
165 # make print-VARIABLE_NAME
172 ######################################################################
174 ######################################################################
176 # Issue #9531: If you change the order of any of the following (or add
177 # new definitions), make sure definitions always precede their uses,
178 # especially for the dependency lists of recipes.
180 # First, load the variables exported by the configure script
183 # Just a few macros used everywhere
184 include $(CFG_SRC_DIR)mk/util.mk
185 # Reconfiguring when the makefiles or submodules change
186 include $(CFG_SRC_DIR)mk/reconfig.mk
187 # All crates and their dependencies
188 include $(CFG_SRC_DIR)mk/crates.mk
189 # Various bits of setup, common macros, and top-level rules
190 include $(CFG_SRC_DIR)mk/main.mk
191 # C and assembly components that are not LLVM
192 include $(CFG_SRC_DIR)mk/rt.mk
193 # Rules for crates in the target directories
194 include $(CFG_SRC_DIR)mk/target.mk
195 # Rules for crates in the host directories
196 include $(CFG_SRC_DIR)mk/host.mk
197 # Special rules for bootstrapping stage0
198 include $(CFG_SRC_DIR)mk/stage0.mk
199 # Rust-specific LLVM extensions
200 include $(CFG_SRC_DIR)mk/rustllvm.mk
202 include $(CFG_SRC_DIR)mk/docs.mk
204 include $(CFG_SRC_DIR)mk/llvm.mk
205 # Rules for installing debugger scripts
206 include $(CFG_SRC_DIR)mk/debuggers.mk
208 ######################################################################
209 # Secondary makefiles, conditionalized for speed
210 ######################################################################
213 ifneq ($(strip $(findstring snap,$(MAKECMDGOALS)) \
214 $(findstring clean,$(MAKECMDGOALS))),)
215 CFG_INFO := $(info cfg: including snap rules)
216 include $(CFG_SRC_DIR)mk/snap.mk
220 ifneq ($(strip $(findstring check,$(MAKECMDGOALS)) \
221 $(findstring test,$(MAKECMDGOALS)) \
222 $(findstring perf,$(MAKECMDGOALS)) \
223 $(findstring tidy,$(MAKECMDGOALS))),)
224 CFG_INFO := $(info cfg: including test rules)
225 include $(CFG_SRC_DIR)mk/tests.mk
226 include $(CFG_SRC_DIR)mk/grammar.mk
229 # Performance and benchmarking
230 ifneq ($(findstring perf,$(MAKECMDGOALS)),)
231 CFG_INFO := $(info cfg: including perf rules)
232 include $(CFG_SRC_DIR)mk/perf.mk
235 # Copy all the distributables to another directory for binary install
236 ifneq ($(strip $(findstring prepare,$(MAKECMDGOALS)) \
237 $(findstring dist,$(MAKECMDGOALS)) \
238 $(findstring install,$(MAKECMDGOALS))),)
239 CFG_INFO := $(info cfg: including prepare rules)
240 include $(CFG_SRC_DIR)mk/prepare.mk
243 # Source and binary distribution artifacts
244 ifneq ($(strip $(findstring dist,$(MAKECMDGOALS)) \
245 $(findstring install,$(MAKECMDGOALS)) \
246 $(findstring clean,$(MAKECMDGOALS))),)
247 CFG_INFO := $(info cfg: including dist rules)
248 include $(CFG_SRC_DIR)mk/dist.mk
251 # (Unix) Installation from the build directory
252 ifneq ($(findstring install,$(MAKECMDGOALS)),)
253 CFG_INFO := $(info cfg: including install rules)
254 include $(CFG_SRC_DIR)mk/install.mk
258 ifneq ($(findstring clean,$(MAKECMDGOALS)),)
259 CFG_INFO := $(info cfg: including clean rules)
260 include $(CFG_SRC_DIR)mk/clean.mk
264 ifneq ($(strip $(findstring TAGS.emacs,$(MAKECMDGOALS)) \
265 $(findstring TAGS.vi,$(MAKECMDGOALS))),)
266 CFG_INFO := $(info cfg: including ctags rules)
267 include $(CFG_SRC_DIR)mk/ctags.mk