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