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