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 DOC_PKG_NAME := rust-docs-$(CFG_PACKAGE_VERS)
  25 MINGW_PKG_NAME := rust-mingw-$(CFG_PACKAGE_VERS)
  26
  27 # License suitable for displaying in a popup
  28 LICENSE.txt: $(S)COPYRIGHT $(S)LICENSE-APACHE $(S)LICENSE-MIT
  29         cat $^ > $@
  30
  31
  32 ######################################################################
  33 # Source tarball
  34 ######################################################################
  35
  36 PKG_TAR = dist/$(PKG_NAME)-src.tar.gz
  37
  38 PKG_GITMODULES := $(S)src/llvm $(S)src/compiler-rt \
  39                   $(S)src/rt/hoedown $(S)src/jemalloc
  40 PKG_FILES := \
  41     $(S)COPYRIGHT                              \
  42     $(S)LICENSE-APACHE                         \
  43     $(S)LICENSE-MIT                            \
  44     $(S)AUTHORS.txt                            \
  45     $(S)CONTRIBUTING.md                        \
  46     $(S)README.md                              \
  47     $(S)RELEASES.md                            \
  48     $(S)configure $(S)Makefile.in              \
  49     $(S)man                                    \
  50     $(addprefix $(S)src/,                      \
  51       compiletest                              \
  52       doc                                      \
  53       driver                                   \
  54       etc                                      \
  55       $(foreach crate,$(CRATES),lib$(crate))   \
  56       libcoretest                              \
  57       libbacktrace                             \
  58       rt                                       \
  59       rustllvm                                 \
  60       snapshots.txt                            \
  61       rust-installer                           \
  62       rustbook                                 \
  63       test)                                    \
  64     $(PKG_GITMODULES)                          \
  65     $(filter-out config.stamp, \
  66                  $(MKFILES_FOR_TARBALL))
  67
  68 UNROOTED_PKG_FILES := $(patsubst $(S)%,./%,$(PKG_FILES))
  69
  70 $(PKG_TAR): $(PKG_FILES)
  71         @$(call E, making dist dir)
  72         $(Q)rm -Rf tmp/dist/$(PKG_NAME)
  73         $(Q)mkdir -p tmp/dist/$(PKG_NAME)
  74         $(Q)tar \
  75          -C $(S) \
  76          --exclude-vcs \
  77          --exclude=*~ \
  78          --exclude=*/llvm/test/*/*.ll \
  79          --exclude=*/llvm/test/*/*.td \
  80          --exclude=*/llvm/test/*/*.s \
  81          --exclude=*/llvm/test/*/*/*.ll \
  82          --exclude=*/llvm/test/*/*/*.td \
  83          --exclude=*/llvm/test/*/*/*.s \
  84          -c $(UNROOTED_PKG_FILES) | tar -x -C tmp/dist/$(PKG_NAME)
  85         @$(call E, making $@)
  86         $(Q)tar -czf $(PKG_TAR) -C tmp/dist $(PKG_NAME)
  87         $(Q)rm -Rf tmp/dist/$(PKG_NAME)
  88
  89 dist-tar-src: $(PKG_TAR)
  90
  91 distcheck-tar-src: dist-tar-src
  92         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)
  93         $(Q)rm -Rf tmp/distcheck/srccheck
  94         $(Q)mkdir -p tmp/distcheck
  95         @$(call E, unpacking $(PKG_TAR) in tmp/distcheck/$(PKG_NAME))
  96         $(Q)cd tmp/distcheck && tar -xzf ../../$(PKG_TAR)
  97         @$(call E, configuring in tmp/distcheck/srccheck)
  98         $(Q)mkdir -p tmp/distcheck/srccheck
  99         $(Q)cd tmp/distcheck/srccheck && ../$(PKG_NAME)/configure
 100         @$(call E, making 'check' in tmp/distcheck/srccheck)
 101         $(Q)+make -C tmp/distcheck/srccheck check
 102         @$(call E, making 'clean' in tmp/distcheck/srccheck)
 103         $(Q)+make -C tmp/distcheck/srccheck clean
 104         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)
 105         $(Q)rm -Rf tmp/distcheck/srccheck
 106
 107
 108 ######################################################################
 109 # Unix binary installer tarballs
 110 ######################################################################
 111
 112 NON_INSTALLED_PREFIXES=COPYRIGHT,LICENSE-APACHE,LICENSE-MIT,README.md,version
 113
 114 define DEF_INSTALLER
 115
 116 $$(eval $$(call DEF_PREPARE,dir-$(1)))
 117
 118 dist-install-dir-$(1): PREPARE_HOST=$(1)
 119 dist-install-dir-$(1): PREPARE_TARGETS=$(2)
 120 dist-install-dir-$(1): PREPARE_DEST_DIR=tmp/dist/$$(PKG_NAME)-$(1)-image
 121 dist-install-dir-$(1): PREPARE_DIR_CMD=$(DEFAULT_PREPARE_DIR_CMD)
 122 dist-install-dir-$(1): PREPARE_BIN_CMD=$(DEFAULT_PREPARE_BIN_CMD)
 123 dist-install-dir-$(1): PREPARE_LIB_CMD=$(DEFAULT_PREPARE_LIB_CMD)
 124 dist-install-dir-$(1): PREPARE_MAN_CMD=$(DEFAULT_PREPARE_MAN_CMD)
 125 dist-install-dir-$(1): PREPARE_CLEAN=true
 126 dist-install-dir-$(1): prepare-base-dir-$(1) docs compiler-docs
 127         $$(Q)$$(PREPARE_MAN_CMD) $$(S)COPYRIGHT $$(PREPARE_DEST_DIR)
 128         $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-APACHE $$(PREPARE_DEST_DIR)
 129         $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-MIT $$(PREPARE_DEST_DIR)
 130         $$(Q)$$(PREPARE_MAN_CMD) $$(S)README.md $$(PREPARE_DEST_DIR)
 131         $$(Q)mkdir -p $$(PREPARE_DEST_DIR)/share/doc/rust
 132         $$(Q)$$(PREPARE_MAN_CMD) $$(S)COPYRIGHT $$(PREPARE_DEST_DIR)/share/doc/rust
 133         $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-APACHE $$(PREPARE_DEST_DIR)/share/doc/rust
 134         $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-MIT $$(PREPARE_DEST_DIR)/share/doc/rust
 135         $$(Q)$$(PREPARE_MAN_CMD) $$(S)README.md $$(PREPARE_DEST_DIR)/share/doc/rust
 136 # This tiny morsel of metadata is used by rust-packaging
 137         $$(Q)echo "$(CFG_VERSION)" > $$(PREPARE_DEST_DIR)/version
 138
 139 dist/$$(PKG_NAME)-$(1).tar.gz: dist-install-dir-$(1)
 140         @$(call E, build: $$@)
 141 # Copy essential gcc components into installer
 142 ifdef CFG_WINDOWSY_$(1)
 143         $$(Q)rm -Rf tmp/dist/win-rust-gcc-$(1)
 144         $$(Q)$$(CFG_PYTHON) $$(S)src/etc/make-win-dist.py tmp/dist/$$(PKG_NAME)-$(1)-image tmp/dist/win-rust-gcc-$(1) $(1)
 145         $$(Q)cp -r $$(S)src/etc/third-party tmp/dist/$$(PKG_NAME)-$(1)-image/share/doc/
 146 endif
 147         $$(Q)$$(S)src/rust-installer/gen-installer.sh \
 148                 --product-name=Rust \
 149                 --verify-bin=rustc \
 150                 --rel-manifest-dir=rustlib \
 151                 --success-message=Rust-is-ready-to-roll. \
 152                 --image-dir=tmp/dist/$$(PKG_NAME)-$(1)-image \
 153                 --work-dir=tmp/dist \
 154                 --output-dir=dist \
 155                 --non-installed-prefixes=$$(NON_INSTALLED_PREFIXES) \
 156                 --package-name=$$(PKG_NAME)-$(1) \
 157                 --component-name=rustc \
 158                 --legacy-manifest-dirs=rustlib,cargo
 159         $$(Q)rm -R tmp/dist/$$(PKG_NAME)-$(1)-image
 160
 161 dist-doc-install-dir-$(1): docs compiler-docs
 162         $$(Q)mkdir -p tmp/dist/$$(DOC_PKG_NAME)-$(1)-image/share/doc/rust
 163         $$(Q)cp -r doc tmp/dist/$$(DOC_PKG_NAME)-$(1)-image/share/doc/rust/html
 164
 165 dist/$$(DOC_PKG_NAME)-$(1).tar.gz: dist-doc-install-dir-$(1)
 166         @$(call E, build: $$@)
 167         $$(Q)$$(S)src/rust-installer/gen-installer.sh \
 168                 --product-name=Rust-Documentation \
 169                 --rel-manifest-dir=rustlib \
 170                 --success-message=Rust-documentation-is-installed. \
 171                 --image-dir=tmp/dist/$$(DOC_PKG_NAME)-$(1)-image \
 172                 --work-dir=tmp/dist \
 173                 --output-dir=dist \
 174                 --package-name=$$(DOC_PKG_NAME)-$(1) \
 175                 --component-name=rust-docs \
 176                 --legacy-manifest-dirs=rustlib,cargo \
 177                 --bulk-dirs=share/doc/rust/html
 178         $$(Q)rm -R tmp/dist/$$(DOC_PKG_NAME)-$(1)-image
 179
 180 dist-mingw-install-dir-$(1):
 181         $$(Q)mkdir -p tmp/dist/rust-mingw-tmp-$(1)-image
 182         $$(Q)rm -Rf tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image
 183         $$(Q)$$(CFG_PYTHON) $$(S)src/etc/make-win-dist.py \
 184                 tmp/dist/rust-mingw-tmp-$(1)-image tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image $(1)
 185
 186 dist/$$(MINGW_PKG_NAME)-$(1).tar.gz: dist-mingw-install-dir-$(1)
 187         @$(call E, build: $$@)
 188         $$(Q)$$(S)src/rust-installer/gen-installer.sh \
 189                 --product-name=Rust-MinGW \
 190                 --rel-manifest-dir=rustlib \
 191                 --success-message=Rust-MinGW-is-installed. \
 192                 --image-dir=tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image \
 193                 --work-dir=tmp/dist \
 194                 --output-dir=dist \
 195                 --package-name=$$(MINGW_PKG_NAME)-$(1) \
 196                 --component-name=rust-mingw \
 197                 --legacy-manifest-dirs=rustlib,cargo
 198         $$(Q)rm -R tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image
 199
 200 endef
 201
 202 ifneq ($(CFG_ENABLE_DIST_HOST_ONLY),)
 203 $(foreach host,$(CFG_HOST),\
 204   $(eval $(call DEF_INSTALLER,$(host),$(host))))
 205 else
 206 $(foreach host,$(CFG_HOST),\
 207   $(eval $(call DEF_INSTALLER,$(host),$(CFG_TARGET))))
 208 endif
 209
 210 dist-install-dirs: $(foreach host,$(CFG_HOST),dist-install-dir-$(host))
 211
 212 ifdef CFG_WINDOWSY_$(CFG_BUILD)
 213 MAYBE_MINGW_TARBALLS=$(foreach host,$(CFG_HOST),dist/$(MINGW_PKG_NAME)-$(host).tar.gz)
 214 endif
 215
 216 ifeq ($(CFG_DISABLE_DOCS),)
 217 MAYBE_DOC_TARBALLS=$(foreach host,$(CFG_HOST),dist/$(DOC_PKG_NAME)-$(host).tar.gz)
 218 endif
 219
 220 dist-tar-bins: $(foreach host,$(CFG_HOST),dist/$(PKG_NAME)-$(host).tar.gz) \
 221         $(MAYBE_DOC_TARBALLS) $(MAYBE_MINGW_TARBALLS)
 222
 223 # Just try to run the compiler for the build host
 224 distcheck-tar-bins: dist-tar-bins
 225         @$(call E, checking binary tarball)
 226         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)
 227         $(Q)rm -Rf tmp/distcheck/tarbininstall
 228         $(Q)mkdir -p tmp/distcheck
 229         $(Q)cd tmp/distcheck && tar -xzf ../../dist/$(PKG_NAME)-$(CFG_BUILD).tar.gz
 230         $(Q)mkdir -p tmp/distcheck/tarbininstall
 231         $(Q)sh tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)/install.sh --prefix=tmp/distcheck/tarbininstall
 232         $(Q)sh tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)/install.sh --prefix=tmp/distcheck/tarbininstall --uninstall
 233         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)
 234         $(Q)rm -Rf tmp/distcheck/tarbininstall
 235
 236 ######################################################################
 237 # Docs
 238 ######################################################################
 239
 240 # Just copy the docs to a folder under dist with the appropriate name
 241 # for uploading to S3
 242 dist-docs: docs compiler-docs
 243         $(Q) rm -Rf dist/doc
 244         $(Q) mkdir -p dist/doc/
 245         $(Q) cp -r doc dist/doc/$(CFG_PACKAGE_VERS)
 246
 247 distcheck-docs: dist-docs
 248
 249 ######################################################################
 250 # Primary targets (dist, distcheck)
 251 ######################################################################
 252
 253 MAYBE_DIST_TAR_SRC=dist-tar-src
 254 MAYBE_DISTCHECK_TAR_SRC=distcheck-tar-src
 255
 256 # FIXME #13224: On OS X don't produce tarballs simply because --exclude-vcs don't work.
 257 # This is a huge hack because I just don't have time to figure out another solution.
 258 ifeq ($(CFG_OSTYPE), apple-darwin)
 259 MAYBE_DIST_TAR_SRC=
 260 MAYBE_DISTCHECK_TAR_SRC=
 261 endif
 262
 263 # Don't bother with source tarballs on windows just because we historically haven't.
 264 ifeq ($(CFG_OSTYPE), pc-windows-gnu)
 265 MAYBE_DIST_TAR_SRC=
 266 MAYBE_DISTCHECK_TAR_SRC=
 267 endif
 268
 269 ifneq ($(CFG_DISABLE_DOCS),)
 270 MAYBE_DIST_DOCS=
 271 MAYBE_DISTCHECK_DOCS=
 272 else
 273 MAYBE_DIST_DOCS=dist-docs
 274 MAYBE_DISTCHECK_DOCS=distcheck-docs
 275 endif
 276
 277 dist: $(MAYBE_DIST_TAR_SRC) dist-tar-bins $(MAYBE_DIST_DOCS)
 278
 279 distcheck: $(MAYBE_DISTCHECK_TAR_SRC) distcheck-tar-bins $(MAYBE_DISTCHECK_DOCS)
 280         $(Q)rm -Rf tmp/distcheck
 281         @echo
 282         @echo -----------------------------------------------
 283         @echo "Rust ready for distribution (see ./dist)"
 284         @echo -----------------------------------------------
 285
 286 .PHONY: dist distcheck