mk/dist.mk

   1 # Copyright 2014 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 ######################################################################
  12 # Distribution
  13 ######################################################################
  14
  15 # Primary targets:
  16 #
  17 # * dist - make all distribution artifacts
  18 # * distcheck - sanity check dist artifacts
  19 # * dist-tar-src - source tarballs
  20 # * dist-tar-bins - Ad-hoc Unix binary installers
  21 # * dist-docs - Stage docs for upload
  22
  23 PKG_NAME := $(CFG_PACKAGE_NAME)
  24 STD_PKG_NAME := rust-std-$(CFG_PACKAGE_VERS)
  25 DOC_PKG_NAME := rust-docs-$(CFG_PACKAGE_VERS)
  26 MINGW_PKG_NAME := rust-mingw-$(CFG_PACKAGE_VERS)
  27 SRC_PKG_NAME := rust-src-$(CFG_PACKAGE_VERS)
  28
  29 # License suitable for displaying in a popup
  30 LICENSE.txt: $(S)COPYRIGHT $(S)LICENSE-APACHE $(S)LICENSE-MIT
  31         cat $^ > $@
  32
  33
  34 ######################################################################
  35 # Source tarball
  36 ######################################################################
  37
  38 PKG_TAR = dist/$(PKG_NAME)-src.tar.gz
  39
  40 PKG_GITMODULES := $(S)src/llvm $(S)src/compiler-rt \
  41                   $(S)src/rt/hoedown $(S)src/jemalloc
  42 PKG_FILES := \
  43     $(S)COPYRIGHT                              \
  44     $(S)LICENSE-APACHE                         \
  45     $(S)LICENSE-MIT                            \
  46     $(S)CONTRIBUTING.md                        \
  47     $(S)README.md                              \
  48     $(S)RELEASES.md                            \
  49     $(S)configure $(S)Makefile.in              \
  50     $(S)man                                    \
  51     $(addprefix $(S)src/,                      \
  52       bootstrap                                \
  53       build_helper                             \
  54       doc                                      \
  55       driver                                   \
  56       etc                                      \
  57       $(foreach crate,$(CRATES),lib$(crate))   \
  58       libcollectionstest                       \
  59       libcoretest                              \
  60       libbacktrace                             \
  61       rt                                       \
  62       rtstartup                                \
  63       rustllvm                                 \
  64       rustc                                    \
  65       stage0.txt                               \
  66       rust-installer                           \
  67       tools                                    \
  68       test)                                    \
  69     $(PKG_GITMODULES)                          \
  70     $(filter-out config.stamp, \
  71                  $(MKFILES_FOR_TARBALL))
  72
  73 UNROOTED_PKG_FILES := $(patsubst $(S)%,./%,$(PKG_FILES))
  74
  75 tmp/dist/$$(SRC_PKG_NAME)-image: $(PKG_FILES)
  76         @$(call E, making src image)
  77         $(Q)rm -Rf tmp/dist/$(SRC_PKG_NAME)-image
  78         $(Q)mkdir -p tmp/dist/$(SRC_PKG_NAME)-image/lib/rustlib/src/rust
  79         $(Q)echo "$(CFG_VERSION)" > tmp/dist/$(SRC_PKG_NAME)-image/lib/rustlib/src/rust/version
  80         $(Q)tar \
  81          -C $(S) \
  82          -f - \
  83          --exclude-vcs \
  84          --exclude=*~ \
  85          --exclude=*.pyc \
  86          --exclude=*/llvm/test/*/*.ll \
  87          --exclude=*/llvm/test/*/*.td \
  88          --exclude=*/llvm/test/*/*.s \
  89          --exclude=*/llvm/test/*/*/*.ll \
  90          --exclude=*/llvm/test/*/*/*.td \
  91          --exclude=*/llvm/test/*/*/*.s \
  92          -c $(UNROOTED_PKG_FILES) | tar -x -f - -C tmp/dist/$(SRC_PKG_NAME)-image/lib/rustlib/src/rust
  93
  94 $(PKG_TAR): tmp/dist/$$(SRC_PKG_NAME)-image
  95         @$(call E, making $@)
  96         $(Q)tar -czf $(PKG_TAR) -C tmp/dist/$(SRC_PKG_NAME)-image/lib/rustlib/src rust --transform 's,^rust,$(PKG_NAME),S'
  97
  98 dist-tar-src: $(PKG_TAR)
  99
 100 distcheck-tar-src: dist-tar-src
 101         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)
 102         $(Q)rm -Rf tmp/distcheck/srccheck
 103         $(Q)mkdir -p tmp/distcheck
 104         @$(call E, unpacking $(PKG_TAR) in tmp/distcheck/$(PKG_NAME))
 105         $(Q)cd tmp/distcheck && tar -xzf ../../$(PKG_TAR)
 106         @$(call E, configuring in tmp/distcheck/srccheck)
 107         $(Q)mkdir -p tmp/distcheck/srccheck
 108         $(Q)cd tmp/distcheck/srccheck && ../$(PKG_NAME)/configure
 109         @$(call E, making 'check' in tmp/distcheck/srccheck)
 110         $(Q)+make -C tmp/distcheck/srccheck check
 111         @$(call E, making 'clean' in tmp/distcheck/srccheck)
 112         $(Q)+make -C tmp/distcheck/srccheck clean
 113         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)
 114         $(Q)rm -Rf tmp/distcheck/srccheck
 115
 116
 117 ######################################################################
 118 # Unix binary installer tarballs
 119 ######################################################################
 120
 121 define DEF_START_INSTALLER
 122 dist-install-dir-$(1)-%: PREPARE_DIR_CMD=$(DEFAULT_PREPARE_DIR_CMD)
 123 dist-install-dir-$(1)-%: PREPARE_BIN_CMD=$(DEFAULT_PREPARE_BIN_CMD)
 124 dist-install-dir-$(1)-%: PREPARE_LIB_CMD=$(DEFAULT_PREPARE_LIB_CMD)
 125 dist-install-dir-$(1)-%: PREPARE_MAN_CMD=$(DEFAULT_PREPARE_MAN_CMD)
 126 dist-install-dir-$(1)-%: PREPARE_CLEAN=true
 127
 128 $$(eval $$(call DEF_PREPARE,dir-$(1)))
 129 endef
 130
 131 $(foreach target,$(CFG_TARGET),\
 132   $(eval $(call DEF_START_INSTALLER,$(target))))
 133
 134 define DEF_INSTALLER
 135
 136 dist-install-dir-$(1)-host: PREPARE_HOST=$(1)
 137 dist-install-dir-$(1)-host: PREPARE_TARGETS=$(2)
 138 dist-install-dir-$(1)-host: PREPARE_DEST_DIR=tmp/dist/$$(PKG_NAME)-$(1)-image
 139 dist-install-dir-$(1)-host: prepare-base-dir-$(1)-host docs
 140         $$(Q)mkdir -p $$(PREPARE_DEST_DIR)/share/doc/rust
 141         $$(Q)$$(PREPARE_MAN_CMD) $$(S)COPYRIGHT $$(PREPARE_DEST_DIR)/share/doc/rust
 142         $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-APACHE $$(PREPARE_DEST_DIR)/share/doc/rust
 143         $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-MIT $$(PREPARE_DEST_DIR)/share/doc/rust
 144         $$(Q)$$(PREPARE_MAN_CMD) $$(S)README.md $$(PREPARE_DEST_DIR)/share/doc/rust
 145
 146 prepare-overlay-$(1):
 147         $$(Q)rm -Rf tmp/dist/$$(PKG_NAME)-$(1)-overlay
 148         $$(Q)mkdir -p tmp/dist/$$(PKG_NAME)-$(1)-overlay
 149         $$(Q)cp $$(S)COPYRIGHT tmp/dist/$$(PKG_NAME)-$(1)-overlay/
 150         $$(Q)cp $$(S)LICENSE-APACHE tmp/dist/$$(PKG_NAME)-$(1)-overlay/
 151         $$(Q)cp $$(S)LICENSE-MIT tmp/dist/$$(PKG_NAME)-$(1)-overlay/
 152         $$(Q)cp $$(S)README.md tmp/dist/$$(PKG_NAME)-$(1)-overlay/
 153 # This tiny morsel of metadata is used by rust-packaging
 154         $$(Q)echo "$(CFG_VERSION)" > tmp/dist/$$(PKG_NAME)-$(1)-overlay/version
 155
 156 dist/$$(PKG_NAME)-$(1).tar.gz: dist-install-dir-$(1)-host prepare-overlay-$(1)
 157         @$(call E, build: $$@)
 158 # On a MinGW target we've got a few runtime DLL dependencies that we need
 159 # to include. THe first argument to `make-win-dist` is where to put these DLLs
 160 # (the image we're creating) and the second argument is a junk directory to
 161 # ignore all the other MinGW stuff the script creates.
 162 ifeq ($$(findstring pc-windows-gnu,$(1)),pc-windows-gnu)
 163         $$(Q)rm -Rf tmp/dist/win-rust-gcc-$(1)
 164         $$(Q)$$(CFG_PYTHON) $$(S)src/etc/make-win-dist.py \
 165                 tmp/dist/$$(PKG_NAME)-$(1)-image \
 166                 tmp/dist/win-rust-gcc-$(1) $(1)
 167 endif
 168 # On 32-bit MinGW we're always including a DLL which needs some extra licenses
 169 # to distribute. On 64-bit MinGW we don't actually distribute anything requiring
 170 # us to distribute a license but it's likely that the install will *also*
 171 # include the rust-mingw package down below, which also need licenses, so to be
 172 # safe we just inlude it here in all MinGW packages.
 173 ifdef CFG_WINDOWSY_$(1)
 174 ifeq ($$(findstring $(1),gnu),gnu)
 175         $$(Q)cp -r $$(S)src/etc/third-party \
 176                 tmp/dist/$$(PKG_NAME)-$(1)-image/share/doc/
 177 endif
 178 endif
 179         $$(Q)$$(S)src/rust-installer/gen-installer.sh \
 180                 --product-name=Rust \
 181                 --rel-manifest-dir=rustlib \
 182                 --success-message=Rust-is-ready-to-roll. \
 183                 --image-dir=tmp/dist/$$(PKG_NAME)-$(1)-image \
 184                 --work-dir=tmp/dist \
 185                 --output-dir=dist \
 186                 --non-installed-overlay=tmp/dist/$$(PKG_NAME)-$(1)-overlay \
 187                 --package-name=$$(PKG_NAME)-$(1) \
 188                 --component-name=rustc \
 189                 --legacy-manifest-dirs=rustlib,cargo
 190         $$(Q)rm -R tmp/dist/$$(PKG_NAME)-$(1)-image
 191
 192 dist-doc-install-dir-$(1): docs
 193         $$(Q)mkdir -p tmp/dist/$$(DOC_PKG_NAME)-$(1)-image/share/doc/rust
 194         $$(Q)cp -r doc tmp/dist/$$(DOC_PKG_NAME)-$(1)-image/share/doc/rust/html
 195
 196 dist/$$(DOC_PKG_NAME)-$(1).tar.gz: dist-doc-install-dir-$(1)
 197         @$(call E, build: $$@)
 198         $$(Q)$$(S)src/rust-installer/gen-installer.sh \
 199                 --product-name=Rust-Documentation \
 200                 --rel-manifest-dir=rustlib \
 201                 --success-message=Rust-documentation-is-installed. \
 202                 --image-dir=tmp/dist/$$(DOC_PKG_NAME)-$(1)-image \
 203                 --work-dir=tmp/dist \
 204                 --output-dir=dist \
 205                 --package-name=$$(DOC_PKG_NAME)-$(1) \
 206                 --component-name=rust-docs \
 207                 --legacy-manifest-dirs=rustlib,cargo \
 208                 --bulk-dirs=share/doc/rust/html
 209         $$(Q)rm -R tmp/dist/$$(DOC_PKG_NAME)-$(1)-image
 210
 211 # Creates the rust-mingw package, and the first argument to make-win-dist is a
 212 # "temporary directory" which is just thrown away (this contains the runtime
 213 # DLLs included in the rustc package above) and the second argument is where to
 214 # place all the MinGW components (which is what we want).
 215 dist-mingw-install-dir-$(1):
 216         $$(Q)mkdir -p tmp/dist/rust-mingw-tmp-$(1)-image
 217         $$(Q)rm -Rf tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image
 218         $$(Q)$$(CFG_PYTHON) $$(S)src/etc/make-win-dist.py \
 219                 tmp/dist/rust-mingw-tmp-$(1)-image \
 220                 tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image $(1)
 221
 222 dist/$$(MINGW_PKG_NAME)-$(1).tar.gz: dist-mingw-install-dir-$(1)
 223         @$(call E, build: $$@)
 224         $$(Q)$$(S)src/rust-installer/gen-installer.sh \
 225                 --product-name=Rust-MinGW \
 226                 --rel-manifest-dir=rustlib \
 227                 --success-message=Rust-MinGW-is-installed. \
 228                 --image-dir=tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image \
 229                 --work-dir=tmp/dist \
 230                 --output-dir=dist \
 231                 --package-name=$$(MINGW_PKG_NAME)-$(1) \
 232                 --component-name=rust-mingw \
 233                 --legacy-manifest-dirs=rustlib,cargo
 234         $$(Q)rm -R tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image
 235
 236 endef
 237
 238 # $(1) - host
 239 # $(2) - target
 240 define DEF_INSTALLER_TARGETS
 241
 242 dist-install-dir-$(2)-target: PREPARE_HOST=$(1)
 243 dist-install-dir-$(2)-target: PREPARE_TARGETS=$(2)
 244 dist-install-dir-$(2)-target: PREPARE_DEST_DIR=tmp/dist/$$(STD_PKG_NAME)-$(2)-image
 245 dist-install-dir-$(2)-target: prepare-base-dir-$(2)-target
 246
 247 dist/$$(STD_PKG_NAME)-$(2).tar.gz: dist-install-dir-$(2)-target
 248         @$$(call E, build: $$@)
 249         $$(Q)$$(S)src/rust-installer/gen-installer.sh \
 250                 --product-name=Rust \
 251                 --rel-manifest-dir=rustlib \
 252                 --success-message=std-is-standing-at-the-ready. \
 253                 --image-dir=tmp/dist/$$(STD_PKG_NAME)-$(2)-image \
 254                 --work-dir=tmp/dist \
 255                 --output-dir=dist \
 256                 --package-name=$$(STD_PKG_NAME)-$(2) \
 257                 --component-name=rust-std-$(2) \
 258                 --legacy-manifest-dirs=rustlib,cargo
 259         $$(Q)rm -R tmp/dist/$$(STD_PKG_NAME)-$(2)-image
 260 endef
 261
 262 $(foreach host,$(CFG_HOST),\
 263   $(eval $(call DEF_INSTALLER,$(host))))
 264
 265 dist/$(SRC_PKG_NAME).tar.gz: tmp/dist/$(SRC_PKG_NAME)-image
 266         @$(call E, build: $@)
 267         $(Q)$(S)src/rust-installer/gen-installer.sh \
 268                 --product-name=Rust \
 269                 --rel-manifest-dir=rustlib \
 270                 --success-message=Awesome-Source. \
 271                 --image-dir=tmp/dist/$(SRC_PKG_NAME)-image \
 272                 --work-dir=tmp/dist \
 273                 --output-dir=dist \
 274                 --package-name=$(SRC_PKG_NAME) \
 275                 --component-name=rust-src \
 276                 --legacy-manifest-dirs=rustlib,cargo
 277
 278 # When generating packages for the standard library, we've actually got a lot of
 279 # artifacts to choose from. Each of the CFG_HOST compilers will have a copy of
 280 # the standard library for each CFG_TARGET, but we only want to generate one
 281 # standard library package. As a result, for each entry in CFG_TARGET we need to
 282 # pick a CFG_HOST to get the standard library from.
 283 #
 284 # In theory it doesn't actually matter what host we choose as it should be the
 285 # case that all hosts produce the same set of libraries for a target (regardless
 286 # of the host itself). Currently there is a bug in the compiler, however, which
 287 # means this is not the case (see #29228 and #29235). To solve the first of
 288 # those bugs, we prefer to select a standard library from the host it was
 289 # generated from, allowing plugins to work in more situations.
 290 #
 291 # For all CFG_TARGET entries in CFG_HOST, however, we just pick CFG_BUILD as the
 292 # host we slurp up a standard library from.
 293 $(foreach host,$(CFG_HOST),\
 294   $(eval $(call DEF_INSTALLER_TARGETS,$(host),$(host))))
 295 $(foreach target,$(filter-out $(CFG_HOST),$(CFG_TARGET)),\
 296   $(eval $(call DEF_INSTALLER_TARGETS,$(CFG_BUILD),$(target))))
 297
 298 ifdef CFG_WINDOWSY_$(CFG_BUILD)
 299 define BUILD_MINGW_TARBALL
 300 ifeq ($$(findstring gnu,$(1)),gnu)
 301 MAYBE_MINGW_TARBALLS += dist/$(MINGW_PKG_NAME)-$(1).tar.gz
 302 endif
 303 endef
 304
 305 $(foreach host,$(CFG_HOST),\
 306   $(eval $(call BUILD_MINGW_TARBALL,$(host))))
 307 endif
 308
 309 ifeq ($(CFG_DISABLE_DOCS),)
 310 MAYBE_DOC_TARBALLS=$(foreach host,$(CFG_HOST),dist/$(DOC_PKG_NAME)-$(host).tar.gz)
 311 endif
 312
 313 dist-tar-bins: \
 314         $(foreach host,$(CFG_HOST),dist/$(PKG_NAME)-$(host).tar.gz) \
 315         $(foreach target,$(CFG_TARGET),dist/$(STD_PKG_NAME)-$(target).tar.gz) \
 316         $(MAYBE_DOC_TARBALLS) $(MAYBE_MINGW_TARBALLS)
 317
 318 # Just try to run the compiler for the build host
 319 distcheck-tar-bins: dist-tar-bins
 320         @$(call E, checking binary tarball)
 321         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)
 322         $(Q)rm -Rf tmp/distcheck/tarbininstall
 323         $(Q)mkdir -p tmp/distcheck
 324         $(Q)cd tmp/distcheck && tar -xzf ../../dist/$(PKG_NAME)-$(CFG_BUILD).tar.gz
 325         $(Q)mkdir -p tmp/distcheck/tarbininstall
 326         $(Q)sh tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)/install.sh --prefix=tmp/distcheck/tarbininstall
 327         $(Q)sh tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)/install.sh --prefix=tmp/distcheck/tarbininstall --uninstall
 328         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)
 329         $(Q)rm -Rf tmp/distcheck/tarbininstall
 330
 331 ######################################################################
 332 # Docs
 333 ######################################################################
 334
 335 # Just copy the docs to a folder under dist with the appropriate name
 336 # for uploading to S3
 337 dist-docs: docs
 338         $(Q) rm -Rf dist/doc
 339         $(Q) mkdir -p dist/doc/
 340         $(Q) cp -r doc dist/doc/$(CFG_PACKAGE_VERS)
 341
 342 distcheck-docs: dist-docs
 343
 344 ######################################################################
 345 # Primary targets (dist, distcheck)
 346 ######################################################################
 347
 348 MAYBE_DIST_TAR_SRC=dist-tar-src dist/$(SRC_PKG_NAME).tar.gz
 349 MAYBE_DISTCHECK_TAR_SRC=distcheck-tar-src dist/$(SRC_PKG_NAME).tar.gz
 350
 351 # FIXME #13224: On OS X don't produce tarballs simply because --exclude-vcs don't work.
 352 # This is a huge hack because I just don't have time to figure out another solution.
 353 ifeq ($(CFG_OSTYPE), apple-darwin)
 354 MAYBE_DIST_TAR_SRC=
 355 MAYBE_DISTCHECK_TAR_SRC=
 356 endif
 357
 358 # Don't bother with source tarballs on windows just because we historically haven't.
 359 ifeq ($(CFG_OSTYPE), pc-windows-gnu)
 360 MAYBE_DIST_TAR_SRC=
 361 MAYBE_DISTCHECK_TAR_SRC=
 362 endif
 363
 364 ifneq ($(CFG_DISABLE_DOCS),)
 365 MAYBE_DIST_DOCS=
 366 MAYBE_DISTCHECK_DOCS=
 367 else
 368 MAYBE_DIST_DOCS=dist-docs
 369 MAYBE_DISTCHECK_DOCS=distcheck-docs
 370 endif
 371
 372 dist: $(MAYBE_DIST_TAR_SRC) dist-tar-bins $(MAYBE_DIST_DOCS)
 373
 374 distcheck: $(MAYBE_DISTCHECK_TAR_SRC) distcheck-tar-bins $(MAYBE_DISTCHECK_DOCS)
 375         $(Q)rm -Rf tmp/distcheck
 376         @echo
 377         @echo -----------------------------------------------
 378         @echo "Rust ready for distribution (see ./dist)"
 379         @echo -----------------------------------------------
 380
 381 .PHONY: dist distcheck