Makefile.in

   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.
   4 #
   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.
  10
  11 # <help> \(^o^)/
  12 #
  13 # Greetings, adventurer! The Rust Build System is at your service.
  14 #
  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.
  19 #
  20 # First, start with one of these build targets:
  21 #
  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/`.
  26 #
  27 #   * check - Run the complete test suite
  28 #
  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.
  32 #
  33 #   * install - Install Rust. Note that installation is not necessary
  34 #               to use the compiler.
  35 #
  36 #   * uninstall - Uninstall the binaries
  37 #
  38 # For tips on working with The Rust Build System, just:
  39 #
  40 #     run `make tips`
  41 #
  42 # Otherwise
  43 #
  44 #     run `make`
  45 #
  46 # </help>
  47 #
  48 # <tips>
  49 #
  50 # # The Rust Build System Tip Line
  51 #
  52 # There are a bazillion different targets you might want to build. Here
  53 # are a few ideas.
  54 #
  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 #
  63 # Then mix in some of these environment variables to harness the
  64 # ultimate power of The Rust Build System.
  65 #
  66 #   * `VERBOSE=1` - Print all commands. Use this to see what's going on.
  67 #   * `RUSTFLAGS=...` - Add compiler flags to all `rustc` invocations
  68 #   * `JEMALLOC_FLAGS=...` - Pass flags to jemalloc's configure script
  69 #
  70 #   * `TESTNAME=...` - Specify the name of tests to run
  71 #   * `CHECK_IGNORED=1` - Run normally-ignored tests
  72 #   * `PLEASE_BENCH=1` - Run crate benchmarks (enable `--bench` flag)
  73 #
  74 #   * `CFG_ENABLE_VALGRIND=1` - Run tests under valgrind
  75 #   * `VALGRIND_COMPILE=1` - Run the compiler itself under valgrind
  76 #                            (may require `CFG_ENABLE_VALGRIND`)
  77 #
  78 #   * `NO_REBUILD=1` - Don't rebootstrap when testing std
  79 #                      (and possibly other crates)
  80 #   * `NO_MKFILE_DEPS=1` - Don't rebuild for modified .mk files
  81 #
  82 #   * `SAVE_TEMPS=1` - Use `--save-temps` flag on all `rustc` invocations
  83 #   * `ASM_COMMENTS=1` - Use `-Z asm-comments`
  84 #   * `TIME_PASSES=1` - Use `-Z time-passes`
  85 #   * `TIME_LLVM_PASSES=1` - Use `-Z time-llvm-passes`
  86 #   * `TRACE=1` - Use `-Z trace`
  87 #
  88 # # Rust recipes for build system success
  89 #
  90 #     // Modifying libstd? Use this comment to run unit tests just on your change
  91 #     make check-stage1-std NO_REBUILD=1 NO_BENCH=1
  92 #
  93 #     // Added a run-pass test? Use this to test running your test
  94 #     make check-stage1-rpass TESTNAME=my-shiny-new-test
  95 #
  96 #     // Having trouble figuring out which test is failing? Turn off parallel tests
  97 #     make check-stage1-std RUST_TEST_TASKS=1
  98 #
  99 # This is hardly all there is to know of The Rust Build System's
 100 # mysteries. The tale continues on the wiki[1][2].
 101 #
 102 # [1]: https://github.com/rust-lang/rust/wiki/Note-build-system
 103 # [2]: https://github.com/rust-lang/rust/wiki/Note-testsuite
 104 #
 105 # If you really feel like getting your hands dirty, then:
 106 #
 107 #     run `make nitty-gritty`
 108 #
 109 # </tips>
 110 #
 111 # <nitty-gritty>
 112 #
 113 # # The Rust Build System
 114 #
 115 # Gosh I wish there was something useful here (TODO).
 116 #
 117 # # An (old) explanation of how the build is structured:
 118 #
 119 # *Note: Hey, like, this is probably inaccurate, and is definitely
 120 # an outdated and insufficient explanation of the remarkable
 121 # Rust Build System.*
 122 #
 123 # There are multiple build stages (0-3) needed to verify that the
 124 # compiler is properly self-hosting. Each stage is divided between
 125 # 'host' artifacts and 'target' artifacts, where the stageN host
 126 # compiler builds artifacts for 1 or more stageN target architectures.
 127 # Once the stageN target compiler has been built for the host
 128 # architecture it is promoted (copied) to a stageN+1 host artifact.
 129 #
 130 # The stage3 host compiler is a compiler that successfully builds
 131 # itself and should (in theory) be bitwise identical to the stage2
 132 # host compiler. The process is bootstrapped using a stage0 host
 133 # compiler downloaded from a previous snapshot.
 134 #
 135 # At no time should stageN artifacts be interacting with artifacts
 136 # from other stages. For consistency, we use the 'promotion' logic
 137 # for all artifacts, even those that don't make sense on non-host
 138 # architectures.
 139 #
 140 # The directory layout for a stage is intended to match the layout
 141 # of the installed compiler, and looks like the following:
 142 #
 143 # stageN - this is the system root, corresponding to, e.g. /usr
 144 #   bin - binaries compiled for the host
 145 #   lib - libraries used by the host compiler
 146 #     rustlib - rustc's own place to organize libraries
 147 #       $(target) - target-specific artifacts
 148 #         bin - binaries for target architectures
 149 #         lib - libraries for target architectures
 150 #
 151 # A note about host libraries:
 152 #
 153 # The only libraries that get promoted to stageN/lib are those needed
 154 # by rustc. In general, rust programs, even those compiled for the
 155 # host architecture will use libraries from the target
 156 # directories. This gives rust some freedom to experiment with how
 157 # libraries are managed and versioned without polluting the common
 158 # areas of the filesystem.
 159 #
 160 # General rust binaries may still live in the host bin directory; they
 161 # will just link against the libraries in the target lib directory.
 162 #
 163 # Admittedly this is a little convoluted.
 164 #
 165 # </nitty-gritty>
 166 #
 167
 168 ######################################################################
 169 # Primary rules
 170 ######################################################################
 171
 172 # Issue #9531: If you change the order of any of the following (or add
 173 # new definitions), make sure definitions always precede their uses,
 174 # especially for the dependency lists of recipes.
 175
 176 # First, load the variables exported by the configure script
 177 include config.mk
 178
 179 # Just a few macros used everywhere
 180 include $(CFG_SRC_DIR)mk/util.mk
 181 # Reconfiguring when the makefiles or submodules change
 182 include $(CFG_SRC_DIR)mk/reconfig.mk
 183 # All crates and their dependencies
 184 include $(CFG_SRC_DIR)mk/crates.mk
 185 # Various bits of setup, common macros, and top-level rules
 186 include $(CFG_SRC_DIR)mk/main.mk
 187 # C and assembly components that are not LLVM
 188 include $(CFG_SRC_DIR)mk/rt.mk
 189 # Rules for crates in the target directories
 190 include $(CFG_SRC_DIR)mk/target.mk
 191 # Rules for crates in the host directories
 192 include $(CFG_SRC_DIR)mk/host.mk
 193 # Special rules for bootstrapping stage0
 194 include $(CFG_SRC_DIR)mk/stage0.mk
 195 # Rust-specific LLVM extensions
 196 include $(CFG_SRC_DIR)mk/rustllvm.mk
 197 # Documentation
 198 include $(CFG_SRC_DIR)mk/docs.mk
 199 # LLVM
 200 include $(CFG_SRC_DIR)mk/llvm.mk
 201 # Rules for installing debugger scripts
 202 include $(CFG_SRC_DIR)mk/debuggers.mk
 203
 204 ######################################################################
 205 # Secondary makefiles, conditionalized for speed
 206 ######################################################################
 207
 208 # Binary snapshots
 209 ifneq ($(strip $(findstring snap,$(MAKECMDGOALS))   \
 210                $(findstring clean,$(MAKECMDGOALS))),)
 211   CFG_INFO := $(info cfg: including snap rules)
 212   include $(CFG_SRC_DIR)mk/snap.mk
 213 endif
 214
 215 # The test suite
 216 ifneq ($(strip $(findstring check,$(MAKECMDGOALS)) \
 217                $(findstring test,$(MAKECMDGOALS))  \
 218                $(findstring perf,$(MAKECMDGOALS))  \
 219                $(findstring tidy,$(MAKECMDGOALS))),)
 220   CFG_INFO := $(info cfg: including test rules)
 221   include $(CFG_SRC_DIR)mk/tests.mk
 222   include $(CFG_SRC_DIR)mk/grammar.mk
 223 endif
 224
 225 # Performance and benchmarking
 226 ifneq ($(findstring perf,$(MAKECMDGOALS)),)
 227   CFG_INFO := $(info cfg: including perf rules)
 228   include $(CFG_SRC_DIR)mk/perf.mk
 229 endif
 230
 231 # Copy all the distributables to another directory for binary install
 232 ifneq ($(strip $(findstring prepare,$(MAKECMDGOALS)) \
 233                $(findstring dist,$(MAKECMDGOALS)) \
 234                $(findstring install,$(MAKECMDGOALS))),)
 235   CFG_INFO := $(info cfg: including prepare rules)
 236   include $(CFG_SRC_DIR)mk/prepare.mk
 237 endif
 238
 239 # Source and binary distribution artifacts
 240 ifneq ($(strip $(findstring dist,$(MAKECMDGOALS)) \
 241                $(findstring install,$(MAKECMDGOALS)) \
 242                $(findstring clean,$(MAKECMDGOALS))),)
 243   CFG_INFO := $(info cfg: including dist rules)
 244   include $(CFG_SRC_DIR)mk/dist.mk
 245 endif
 246
 247 # (Unix) Installation from the build directory
 248 ifneq ($(findstring install,$(MAKECMDGOALS)),)
 249   CFG_INFO := $(info cfg: including install rules)
 250   include $(CFG_SRC_DIR)mk/install.mk
 251 endif
 252
 253 # Cleaning
 254 ifneq ($(findstring clean,$(MAKECMDGOALS)),)
 255   CFG_INFO := $(info cfg: including clean rules)
 256   include $(CFG_SRC_DIR)mk/clean.mk
 257 endif
 258
 259 # CTAGS building
 260 ifneq ($(strip $(findstring TAGS.emacs,$(MAKECMDGOALS)) \
 261                $(findstring TAGS.vi,$(MAKECMDGOALS))),)
 262   CFG_INFO := $(info cfg: including ctags rules)
 263   include $(CFG_SRC_DIR)mk/ctags.mk
 264 endif
 265
 266 # Find all of the .d files and include them to add information about
 267 # header file dependencies.
 268 ALL_DEP_FILES := $(ALL_OBJ_FILES:%.o=%.d)
 269 -include $(ALL_DEP_FILES)