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-win - Windows exe installers
  21 # * dist-osx - OS X .pkg installers
  22 # * dist-tar-bins - Ad-hoc Unix binary installers
  23 # * dist-docs - Stage docs for upload
  24
  25 PKG_NAME := $(CFG_PACKAGE_NAME)
  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).tar.gz
  37
  38 PKG_GITMODULES := $(S)src/libuv $(S)src/llvm $(S)src/gyp $(S)src/compiler-rt
  39 PKG_FILES := \
  40     $(S)COPYRIGHT                              \
  41     $(S)LICENSE-APACHE                         \
  42     $(S)LICENSE-MIT                            \
  43     $(S)AUTHORS.txt                            \
  44     $(S)CONTRIBUTING.md                        \
  45     $(S)README.md                              \
  46     $(S)RELEASES.txt                           \
  47     $(S)configure $(S)Makefile.in              \
  48     $(S)man                                    \
  49     $(addprefix $(S)src/,                      \
  50       README.md                                \
  51       compiletest                              \
  52       doc                                      \
  53       driver                                   \
  54       etc                                      \
  55       $(foreach crate,$(CRATES),lib$(crate))   \
  56       libbacktrace                             \
  57       rt                                       \
  58       rustllvm                                 \
  59       snapshots.txt                            \
  60       test)                                    \
  61     $(PKG_GITMODULES)                          \
  62     $(filter-out config.stamp, \
  63                  $(MKFILES_FOR_TARBALL))
  64
  65 UNROOTED_PKG_FILES := $(patsubst $(S)%,./%,$(PKG_FILES))
  66
  67 $(PKG_TAR): $(PKG_FILES)
  68         @$(call E, making dist dir)
  69         $(Q)rm -Rf tmp/dist/$(PKG_NAME)
  70         $(Q)mkdir -p tmp/dist/$(PKG_NAME)
  71         $(Q)tar \
  72          -C $(S) \
  73          --exclude-vcs \
  74          --exclude=*~ \
  75          --exclude=*/llvm/test/*/*.ll \
  76          --exclude=*/llvm/test/*/*.td \
  77          --exclude=*/llvm/test/*/*.s \
  78          --exclude=*/llvm/test/*/*/*.ll \
  79          --exclude=*/llvm/test/*/*/*.td \
  80          --exclude=*/llvm/test/*/*/*.s \
  81          -c $(UNROOTED_PKG_FILES) | tar -x -C tmp/dist/$(PKG_NAME)
  82         @$(call E, making $@)
  83         $(Q)tar -czf $(PKG_TAR) -C tmp/dist $(PKG_NAME)
  84         $(Q)rm -Rf tmp/dist/$(PKG_NAME)
  85
  86 dist-tar-src: $(PKG_TAR)
  87
  88 distcheck-tar-src: dist-tar-src
  89         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)
  90         $(Q)rm -Rf tmp/distcheck/srccheck
  91         $(Q)mkdir -p tmp/distcheck
  92         @$(call E, unpacking $(PKG_TAR) in tmp/distcheck/$(PKG_NAME))
  93         $(Q)cd tmp/distcheck && tar -xzf ../../$(PKG_TAR)
  94         @$(call E, configuring in tmp/distcheck/srccheck)
  95         $(Q)mkdir -p tmp/distcheck/srccheck
  96         $(Q)cd tmp/distcheck/srccheck && ../$(PKG_NAME)/configure
  97         @$(call E, making 'check' in tmp/distcheck/srccheck)
  98         $(Q)+make -C tmp/distcheck/srccheck check
  99         @$(call E, making 'clean' in tmp/distcheck/srccheck)
 100         $(Q)+make -C tmp/distcheck/srccheck clean
 101         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)
 102         $(Q)rm -Rf tmp/distcheck/srccheck
 103
 104
 105 ######################################################################
 106 # Windows .exe installer
 107 ######################################################################
 108
 109 # FIXME Needs to support all hosts, but making rust.iss compatible looks like a chore
 110
 111 ifdef CFG_ISCC
 112
 113 PKG_EXE = dist/$(PKG_NAME)-install.exe
 114
 115 %.iss: $(S)src/etc/pkg/%.iss
 116         cp $< $@
 117
 118 %.ico: $(S)src/etc/pkg/%.ico
 119         cp $< $@
 120
 121 $(PKG_EXE): rust.iss modpath.iss upgrade.iss LICENSE.txt rust-logo.ico \
 122             $(CSREQ3_T_$(CFG_BUILD)_H_$(CFG_BUILD)) \
 123             dist-prepare-win
 124         $(CFG_PYTHON) $(S)src/etc/copy-runtime-deps.py tmp/dist/win/bin
 125         @$(call E, ISCC: $@)
 126         $(Q)"$(CFG_ISCC)" $<
 127
 128 $(eval $(call DEF_PREPARE,win))
 129
 130 dist-prepare-win: PREPARE_HOST=$(CFG_BUILD)
 131 dist-prepare-win: PREPARE_TARGETS=$(CFG_BUILD)
 132 dist-prepare-win: PREPARE_DEST_DIR=tmp/dist/win
 133 dist-prepare-win: PREPARE_DIR_CMD=$(DEFAULT_PREPARE_DIR_CMD)
 134 dist-prepare-win: PREPARE_BIN_CMD=$(DEFAULT_PREPARE_BIN_CMD)
 135 dist-prepare-win: PREPARE_LIB_CMD=$(DEFAULT_PREPARE_LIB_CMD)
 136 dist-prepare-win: PREPARE_MAN_CMD=$(DEFAULT_PREPARE_MAN_CMD)
 137 dist-prepare-win: PREPARE_CLEAN=true
 138 dist-prepare-win: prepare-base-win
 139
 140 endif
 141
 142 dist-win: $(PKG_EXE)
 143
 144 distcheck-win: dist-win
 145
 146 ######################################################################
 147 # OS X .pkg installer
 148 ######################################################################
 149
 150 ifeq ($(CFG_OSTYPE), apple-darwin)
 151
 152 define DEF_OSX_PKG
 153
 154 $$(eval $$(call DEF_PREPARE,osx-$(1)))
 155
 156 dist-prepare-osx-$(1): PREPARE_HOST=$(1)
 157 dist-prepare-osx-$(1): PREPARE_TARGETS=$(1)
 158 dist-prepare-osx-$(1): PREPARE_DEST_DIR=tmp/dist/pkgroot-$(1)
 159 dist-prepare-osx-$(1): PREPARE_DIR_CMD=$(DEFAULT_PREPARE_DIR_CMD)
 160 dist-prepare-osx-$(1): PREPARE_BIN_CMD=$(DEFAULT_PREPARE_BIN_CMD)
 161 dist-prepare-osx-$(1): PREPARE_LIB_CMD=$(DEFAULT_PREPARE_LIB_CMD)
 162 dist-prepare-osx-$(1): PREPARE_MAN_CMD=$(DEFAULT_PREPARE_MAN_CMD)
 163 dist-prepare-osx-$(1): prepare-base-osx-$(1)
 164
 165 dist/$(PKG_NAME)-$(1).pkg: $(S)src/etc/pkg/Distribution.xml LICENSE.txt \
 166                 dist-prepare-osx-$(1) \
 167                 tmp/dist/pkgres-$(1)/LICENSE.txt \
 168                 tmp/dist/pkgres-$(1)/welcome.rtf \
 169                 tmp/dist/pkgres-$(1)/rust-logo.png
 170         @$$(call E, making OS X pkg)
 171         $(Q)pkgbuild --identifier org.rust-lang.rust --root tmp/dist/pkgroot-$(1) rust.pkg
 172         $(Q)productbuild --distribution $(S)src/etc/pkg/Distribution.xml \
 173               --resources tmp/dist/pkgres-$(1) dist/$(PKG_NAME)-$(1).pkg
 174         $(Q)rm -rf tmp rust.pkg
 175
 176 tmp/dist/pkgres-$(1)/LICENSE.txt: LICENSE.txt
 177         @$$(call E,pkg resource LICENSE.txt)
 178         $(Q)mkdir -p $$(@D)
 179         $(Q)cp $$< $$@
 180
 181 tmp/dist/pkgres-$(1)/%: $(S)src/etc/pkg/%
 182         @$$(call E,pkg resource $$*)
 183         $(Q)mkdir -p $$(@D)
 184         $(Q)cp -r $$< $$@
 185
 186 endef
 187
 188 $(foreach host,$(CFG_HOST),$(eval $(call DEF_OSX_PKG,$(host))))
 189
 190 dist-osx: $(foreach host,$(CFG_HOST),dist/$(PKG_NAME)-$(host).pkg)
 191
 192 else
 193
 194 dist-osx:
 195
 196 endif
 197
 198 # FIXME should do something
 199 distcheck-osx: dist-osx
 200
 201
 202 ######################################################################
 203 # Unix binary installer tarballs
 204 ######################################################################
 205
 206 define DEF_PREPARE_DIST_DIR
 207
 208 dist-install-dir-$(1)$(3): PREPARE_HOST=$(1)
 209 dist-install-dir-$(1)$(3): PREPARE_TARGETS=$(2)
 210 dist-install-dir-$(1)$(3): PREPARE_DEST_DIR=tmp/dist/$$(PKG_NAME)-$(1)
 211 dist-install-dir-$(1)$(3): PREPARE_DIR_CMD=$(DEFAULT_PREPARE_DIR_CMD)
 212 dist-install-dir-$(1)$(3): PREPARE_BIN_CMD=$(DEFAULT_PREPARE_BIN_CMD)
 213 dist-install-dir-$(1)$(3): PREPARE_LIB_CMD=$(DEFAULT_PREPARE_LIB_CMD)
 214 dist-install-dir-$(1)$(3): PREPARE_MAN_CMD=$(DEFAULT_PREPARE_MAN_CMD)
 215 dist-install-dir-$(1)$(3): PREPARE_CLEAN=true
 216 dist-install-dir-$(1)$(3): prepare-base-dir-$(1) docs compiler-docs
 217         $$(Q)(cd $$(PREPARE_DEST_DIR)/ && find . -type f | sed 's/^\.\///') \
 218       > tmp/dist/manifest-$(1).in
 219         $$(Q)mv tmp/dist/manifest-$(1).in $$(PREPARE_DEST_DIR)/$$(CFG_LIBDIR_RELATIVE)/rustlib/manifest.in
 220 # Add remaining non-installed files
 221         $$(Q)$$(PREPARE_MAN_CMD) $$(S)COPYRIGHT $$(PREPARE_DEST_DIR)
 222         $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-APACHE $$(PREPARE_DEST_DIR)
 223         $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-MIT $$(PREPARE_DEST_DIR)
 224         $$(Q)$$(PREPARE_MAN_CMD) $$(S)README.md $$(PREPARE_DEST_DIR)
 225         $$(Q)cp -r doc $$(PREPARE_DEST_DIR)
 226         $$(Q)$$(PREPARE_BIN_CMD) $$(S)src/etc/install.sh $$(PREPARE_DEST_DIR)
 227
 228 endef
 229
 230 define DEF_INSTALLER
 231
 232 $$(eval $$(call DEF_PREPARE,dir-$(1)))
 233
 234 $$(eval $$(call DEF_PREPARE_DIST_DIR,$(1),$(1),))
 235
 236 $$(eval $$(call DEF_PREPARE_DIST_DIR,$(1),$(CFG_TARGET),-with-target-libs))
 237
 238 dist/$$(PKG_NAME)-$(1).tar.gz: dist-install-dir-$(1)
 239         @$(call E, build: $$@)
 240         $$(Q)tar -czf dist/$$(PKG_NAME)-$(1).tar.gz -C tmp/dist $$(PKG_NAME)-$(1)
 241
 242 endef
 243
 244 $(foreach host,$(CFG_HOST),\
 245   $(eval $(call DEF_INSTALLER,$(host))))
 246
 247 dist-install-dirs: $(foreach host,$(CFG_HOST),dist-install-dir-$(host))
 248
 249 dist-tar-bins: $(foreach host,$(CFG_HOST),dist/$(PKG_NAME)-$(host).tar.gz)
 250
 251 # Just try to run the compiler for the build host
 252 distcheck-tar-bins: dist-tar-bins
 253         @$(call E, checking binary tarball)
 254         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)
 255         $(Q)rm -Rf tmp/distcheck/tarbininstall
 256         $(Q)mkdir -p tmp/distcheck
 257         $(Q)cd tmp/distcheck && tar -xzf ../../dist/$(PKG_NAME)-$(CFG_BUILD).tar.gz
 258         $(Q)mkdir -p tmp/distcheck/tarbininstall
 259         $(Q)sh tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)/install.sh --prefix=tmp/distcheck/tarbininstall
 260         $(Q)tmp/distcheck/tarbininstall/bin/rustc --version
 261         $(Q)sh tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)/install.sh --prefix=tmp/distcheck/tarbininstall --uninstall
 262         $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)
 263         $(Q)rm -Rf tmp/distcheck/tarbininstall
 264
 265 ######################################################################
 266 # Docs
 267 ######################################################################
 268
 269 # Just copy the docs to a folder under dist with the appropriate name
 270 # for uploading to S3
 271 dist-docs: docs compiler-docs
 272         $(Q) rm -Rf dist/doc
 273         $(Q) mkdir -p dist/doc/
 274         $(Q) cp -r doc dist/doc/$(CFG_PACKAGE_VERS)
 275
 276 distcheck-docs: dist-docs
 277
 278 ######################################################################
 279 # Primary targets (dist, distcheck)
 280 ######################################################################
 281
 282 ifdef CFG_WINDOWSY_$(CFG_BUILD)
 283
 284 dist: dist-win
 285
 286 distcheck: distcheck-win
 287         $(Q)rm -Rf tmp/distcheck
 288         @echo
 289         @echo -----------------------------------------------
 290         @echo "Rust ready for distribution (see ./dist)"
 291         @echo -----------------------------------------------
 292
 293 else
 294
 295 # FIXME #13224: On OS X don't produce tarballs simply because --exclude-vcs don't work.
 296 # This is a huge hack because I just don't have time to figure out another solution.
 297 ifeq ($(CFG_OSTYPE), apple-darwin)
 298 MAYBE_DIST_TAR_SRC=
 299 MAYBE_DISTCHECK_TAR_SRC=
 300 else
 301 MAYBE_DIST_TAR_SRC=dist-tar-src
 302 MAYBE_DISTCHECK_TAR_SRC=distcheck-tar-src
 303 endif
 304
 305 dist: $(MAYBE_DIST_TAR_SRC) dist-osx dist-tar-bins dist-docs
 306
 307 distcheck: $(MAYBE_DISTCHECK_TAR_SRC) distcheck-osx distcheck-tar-bins distcheck-docs
 308         $(Q)rm -Rf tmp/distcheck
 309         @echo
 310         @echo -----------------------------------------------
 311         @echo "Rust ready for distribution (see ./dist)"
 312         @echo -----------------------------------------------
 313
 314 endif
 315
 316 .PHONY: dist distcheck