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.
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.
11 ######################################################################
13 ######################################################################
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
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)
29 # License suitable for displaying in a popup
30 LICENSE.txt: $(S)COPYRIGHT $(S)LICENSE-APACHE $(S)LICENSE-MIT
34 ######################################################################
36 ######################################################################
38 PKG_TAR = dist/$(PKG_NAME)-src.tar.gz
40 PKG_GITMODULES := $(S)src/llvm $(S)src/compiler-rt \
41 $(S)src/rt/hoedown $(S)src/jemalloc
49 $(S)configure $(S)Makefile.in \
51 $(addprefix $(S)src/, \
57 $(foreach crate,$(CRATES),lib$(crate)) \
71 $(filter-out config.stamp, \
72 $(MKFILES_FOR_TARBALL))
74 UNROOTED_PKG_FILES := $(patsubst $(S)%,./%,$(PKG_FILES))
76 tmp/dist/$$(SRC_PKG_NAME)-image: $(PKG_FILES)
77 @$(call E, making src image)
78 $(Q)rm -Rf tmp/dist/$(SRC_PKG_NAME)-image
79 $(Q)mkdir -p tmp/dist/$(SRC_PKG_NAME)-image/lib/rustlib/src/rust
80 $(Q)echo "$(CFG_VERSION)" > tmp/dist/$(SRC_PKG_NAME)-image/lib/rustlib/src/rust/version
87 --exclude=*/llvm/test/*/*.ll \
88 --exclude=*/llvm/test/*/*.td \
89 --exclude=*/llvm/test/*/*.s \
90 --exclude=*/llvm/test/*/*/*.ll \
91 --exclude=*/llvm/test/*/*/*.td \
92 --exclude=*/llvm/test/*/*/*.s \
93 -c $(UNROOTED_PKG_FILES) | tar -x -f - -C tmp/dist/$(SRC_PKG_NAME)-image/lib/rustlib/src/rust
95 $(PKG_TAR): tmp/dist/$$(SRC_PKG_NAME)-image
97 $(Q)tar -czf $(PKG_TAR) -C tmp/dist/$(SRC_PKG_NAME)-image/lib/rustlib/src rust --transform 's,^rust,$(PKG_NAME),S'
99 dist-tar-src: $(PKG_TAR)
101 distcheck-tar-src: dist-tar-src
102 $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)
103 $(Q)rm -Rf tmp/distcheck/srccheck
104 $(Q)mkdir -p tmp/distcheck
105 @$(call E, unpacking $(PKG_TAR) in tmp/distcheck/$(PKG_NAME))
106 $(Q)cd tmp/distcheck && tar -xzf ../../$(PKG_TAR)
107 @$(call E, configuring in tmp/distcheck/srccheck)
108 $(Q)mkdir -p tmp/distcheck/srccheck
109 $(Q)cd tmp/distcheck/srccheck && ../$(PKG_NAME)/configure
110 @$(call E, making 'check' in tmp/distcheck/srccheck)
111 $(Q)+make -C tmp/distcheck/srccheck check
112 @$(call E, making 'clean' in tmp/distcheck/srccheck)
113 $(Q)+make -C tmp/distcheck/srccheck clean
114 $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)
115 $(Q)rm -Rf tmp/distcheck/srccheck
118 ######################################################################
119 # Unix binary installer tarballs
120 ######################################################################
122 define DEF_START_INSTALLER
123 dist-install-dir-$(1)-%: PREPARE_DIR_CMD=$(DEFAULT_PREPARE_DIR_CMD)
124 dist-install-dir-$(1)-%: PREPARE_BIN_CMD=$(DEFAULT_PREPARE_BIN_CMD)
125 dist-install-dir-$(1)-%: PREPARE_LIB_CMD=$(DEFAULT_PREPARE_LIB_CMD)
126 dist-install-dir-$(1)-%: PREPARE_MAN_CMD=$(DEFAULT_PREPARE_MAN_CMD)
127 dist-install-dir-$(1)-%: PREPARE_CLEAN=true
129 $$(eval $$(call DEF_PREPARE,dir-$(1)))
132 $(foreach target,$(CFG_TARGET),\
133 $(eval $(call DEF_START_INSTALLER,$(target))))
137 dist-install-dir-$(1)-host: PREPARE_HOST=$(1)
138 dist-install-dir-$(1)-host: PREPARE_TARGETS=$(2)
139 dist-install-dir-$(1)-host: PREPARE_DEST_DIR=tmp/dist/$$(PKG_NAME)-$(1)-image
140 dist-install-dir-$(1)-host: prepare-base-dir-$(1)-host docs
141 $$(Q)mkdir -p $$(PREPARE_DEST_DIR)/share/doc/rust
142 $$(Q)$$(PREPARE_MAN_CMD) $$(S)COPYRIGHT $$(PREPARE_DEST_DIR)/share/doc/rust
143 $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-APACHE $$(PREPARE_DEST_DIR)/share/doc/rust
144 $$(Q)$$(PREPARE_MAN_CMD) $$(S)LICENSE-MIT $$(PREPARE_DEST_DIR)/share/doc/rust
145 $$(Q)$$(PREPARE_MAN_CMD) $$(S)README.md $$(PREPARE_DEST_DIR)/share/doc/rust
147 prepare-overlay-$(1):
148 $$(Q)rm -Rf tmp/dist/$$(PKG_NAME)-$(1)-overlay
149 $$(Q)mkdir -p tmp/dist/$$(PKG_NAME)-$(1)-overlay
150 $$(Q)cp $$(S)COPYRIGHT tmp/dist/$$(PKG_NAME)-$(1)-overlay/
151 $$(Q)cp $$(S)LICENSE-APACHE tmp/dist/$$(PKG_NAME)-$(1)-overlay/
152 $$(Q)cp $$(S)LICENSE-MIT tmp/dist/$$(PKG_NAME)-$(1)-overlay/
153 $$(Q)cp $$(S)README.md tmp/dist/$$(PKG_NAME)-$(1)-overlay/
154 # This tiny morsel of metadata is used by rust-packaging
155 $$(Q)echo "$(CFG_VERSION)" > tmp/dist/$$(PKG_NAME)-$(1)-overlay/version
157 dist/$$(PKG_NAME)-$(1).tar.gz: dist-install-dir-$(1)-host prepare-overlay-$(1)
158 @$(call E, build: $$@)
159 # On a MinGW target we've got a few runtime DLL dependencies that we need
160 # to include. THe first argument to `make-win-dist` is where to put these DLLs
161 # (the image we're creating) and the second argument is a junk directory to
162 # ignore all the other MinGW stuff the script creates.
163 ifeq ($$(findstring pc-windows-gnu,$(1)),pc-windows-gnu)
164 $$(Q)rm -Rf tmp/dist/win-rust-gcc-$(1)
165 $$(Q)$$(CFG_PYTHON) $$(S)src/etc/make-win-dist.py \
166 tmp/dist/$$(PKG_NAME)-$(1)-image \
167 tmp/dist/win-rust-gcc-$(1) $(1)
169 # On 32-bit MinGW we're always including a DLL which needs some extra licenses
170 # to distribute. On 64-bit MinGW we don't actually distribute anything requiring
171 # us to distribute a license but it's likely that the install will *also*
172 # include the rust-mingw package down below, which also need licenses, so to be
173 # safe we just inlude it here in all MinGW packages.
174 ifdef CFG_WINDOWSY_$(1)
175 ifeq ($$(findstring $(1),gnu),gnu)
176 $$(Q)cp -r $$(S)src/etc/third-party \
177 tmp/dist/$$(PKG_NAME)-$(1)-image/share/doc/
180 $$(Q)$$(S)src/rust-installer/gen-installer.sh \
181 --product-name=Rust \
182 --rel-manifest-dir=rustlib \
183 --success-message=Rust-is-ready-to-roll. \
184 --image-dir=tmp/dist/$$(PKG_NAME)-$(1)-image \
185 --work-dir=tmp/dist \
187 --non-installed-overlay=tmp/dist/$$(PKG_NAME)-$(1)-overlay \
188 --package-name=$$(PKG_NAME)-$(1) \
189 --component-name=rustc \
190 --legacy-manifest-dirs=rustlib,cargo
191 $$(Q)rm -R tmp/dist/$$(PKG_NAME)-$(1)-image
193 dist-doc-install-dir-$(1): docs
194 $$(Q)mkdir -p tmp/dist/$$(DOC_PKG_NAME)-$(1)-image/share/doc/rust
195 $$(Q)cp -r doc tmp/dist/$$(DOC_PKG_NAME)-$(1)-image/share/doc/rust/html
197 dist/$$(DOC_PKG_NAME)-$(1).tar.gz: dist-doc-install-dir-$(1)
198 @$(call E, build: $$@)
199 $$(Q)$$(S)src/rust-installer/gen-installer.sh \
200 --product-name=Rust-Documentation \
201 --rel-manifest-dir=rustlib \
202 --success-message=Rust-documentation-is-installed. \
203 --image-dir=tmp/dist/$$(DOC_PKG_NAME)-$(1)-image \
204 --work-dir=tmp/dist \
206 --package-name=$$(DOC_PKG_NAME)-$(1) \
207 --component-name=rust-docs \
208 --legacy-manifest-dirs=rustlib,cargo \
209 --bulk-dirs=share/doc/rust/html
210 $$(Q)rm -R tmp/dist/$$(DOC_PKG_NAME)-$(1)-image
212 # Creates the rust-mingw package, and the first argument to make-win-dist is a
213 # "temporary directory" which is just thrown away (this contains the runtime
214 # DLLs included in the rustc package above) and the second argument is where to
215 # place all the MinGW components (which is what we want).
216 dist-mingw-install-dir-$(1):
217 $$(Q)mkdir -p tmp/dist/rust-mingw-tmp-$(1)-image
218 $$(Q)rm -Rf tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image
219 $$(Q)$$(CFG_PYTHON) $$(S)src/etc/make-win-dist.py \
220 tmp/dist/rust-mingw-tmp-$(1)-image \
221 tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image $(1)
223 dist/$$(MINGW_PKG_NAME)-$(1).tar.gz: dist-mingw-install-dir-$(1)
224 @$(call E, build: $$@)
225 $$(Q)$$(S)src/rust-installer/gen-installer.sh \
226 --product-name=Rust-MinGW \
227 --rel-manifest-dir=rustlib \
228 --success-message=Rust-MinGW-is-installed. \
229 --image-dir=tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image \
230 --work-dir=tmp/dist \
232 --package-name=$$(MINGW_PKG_NAME)-$(1) \
233 --component-name=rust-mingw \
234 --legacy-manifest-dirs=rustlib,cargo
235 $$(Q)rm -R tmp/dist/$$(MINGW_PKG_NAME)-$(1)-image
241 define DEF_INSTALLER_TARGETS
243 dist-install-dir-$(2)-target: PREPARE_HOST=$(1)
244 dist-install-dir-$(2)-target: PREPARE_TARGETS=$(2)
245 dist-install-dir-$(2)-target: PREPARE_DEST_DIR=tmp/dist/$$(STD_PKG_NAME)-$(2)-image
246 dist-install-dir-$(2)-target: prepare-base-dir-$(2)-target
248 dist/$$(STD_PKG_NAME)-$(2).tar.gz: dist-install-dir-$(2)-target
249 @$$(call E, build: $$@)
250 $$(Q)$$(S)src/rust-installer/gen-installer.sh \
251 --product-name=Rust \
252 --rel-manifest-dir=rustlib \
253 --success-message=std-is-standing-at-the-ready. \
254 --image-dir=tmp/dist/$$(STD_PKG_NAME)-$(2)-image \
255 --work-dir=tmp/dist \
257 --package-name=$$(STD_PKG_NAME)-$(2) \
258 --component-name=rust-std-$(2) \
259 --legacy-manifest-dirs=rustlib,cargo
260 $$(Q)rm -R tmp/dist/$$(STD_PKG_NAME)-$(2)-image
263 $(foreach host,$(CFG_HOST),\
264 $(eval $(call DEF_INSTALLER,$(host))))
266 dist/$(SRC_PKG_NAME).tar.gz: tmp/dist/$(SRC_PKG_NAME)-image
267 @$(call E, build: $@)
268 $(Q)$(S)src/rust-installer/gen-installer.sh \
269 --product-name=Rust \
270 --rel-manifest-dir=rustlib \
271 --success-message=Awesome-Source. \
272 --image-dir=tmp/dist/$(SRC_PKG_NAME)-image \
273 --work-dir=tmp/dist \
275 --package-name=$(SRC_PKG_NAME) \
276 --component-name=rust-src \
277 --legacy-manifest-dirs=rustlib,cargo
279 # When generating packages for the standard library, we've actually got a lot of
280 # artifacts to choose from. Each of the CFG_HOST compilers will have a copy of
281 # the standard library for each CFG_TARGET, but we only want to generate one
282 # standard library package. As a result, for each entry in CFG_TARGET we need to
283 # pick a CFG_HOST to get the standard library from.
285 # In theory it doesn't actually matter what host we choose as it should be the
286 # case that all hosts produce the same set of libraries for a target (regardless
287 # of the host itself). Currently there is a bug in the compiler, however, which
288 # means this is not the case (see #29228 and #29235). To solve the first of
289 # those bugs, we prefer to select a standard library from the host it was
290 # generated from, allowing plugins to work in more situations.
292 # For all CFG_TARGET entries in CFG_HOST, however, we just pick CFG_BUILD as the
293 # host we slurp up a standard library from.
294 $(foreach host,$(CFG_HOST),\
295 $(eval $(call DEF_INSTALLER_TARGETS,$(host),$(host))))
296 $(foreach target,$(filter-out $(CFG_HOST),$(CFG_TARGET)),\
297 $(eval $(call DEF_INSTALLER_TARGETS,$(CFG_BUILD),$(target))))
299 ifdef CFG_WINDOWSY_$(CFG_BUILD)
300 define BUILD_MINGW_TARBALL
301 ifeq ($$(findstring gnu,$(1)),gnu)
302 MAYBE_MINGW_TARBALLS += dist/$(MINGW_PKG_NAME)-$(1).tar.gz
306 $(foreach host,$(CFG_HOST),\
307 $(eval $(call BUILD_MINGW_TARBALL,$(host))))
310 ifeq ($(CFG_DISABLE_DOCS),)
311 MAYBE_DOC_TARBALLS=$(foreach host,$(CFG_HOST),dist/$(DOC_PKG_NAME)-$(host).tar.gz)
315 $(foreach host,$(CFG_HOST),dist/$(PKG_NAME)-$(host).tar.gz) \
316 $(foreach target,$(CFG_TARGET),dist/$(STD_PKG_NAME)-$(target).tar.gz) \
317 $(MAYBE_DOC_TARBALLS) $(MAYBE_MINGW_TARBALLS)
319 # Just try to run the compiler for the build host
320 distcheck-tar-bins: dist-tar-bins
321 @$(call E, checking binary tarball)
322 $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)
323 $(Q)rm -Rf tmp/distcheck/tarbininstall
324 $(Q)mkdir -p tmp/distcheck
325 $(Q)cd tmp/distcheck && tar -xzf ../../dist/$(PKG_NAME)-$(CFG_BUILD).tar.gz
326 $(Q)mkdir -p tmp/distcheck/tarbininstall
327 $(Q)sh tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)/install.sh --prefix=tmp/distcheck/tarbininstall
328 $(Q)sh tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)/install.sh --prefix=tmp/distcheck/tarbininstall --uninstall
329 $(Q)rm -Rf tmp/distcheck/$(PKG_NAME)-$(CFG_BUILD)
330 $(Q)rm -Rf tmp/distcheck/tarbininstall
332 ######################################################################
334 ######################################################################
336 # Just copy the docs to a folder under dist with the appropriate name
337 # for uploading to S3
340 $(Q) mkdir -p dist/doc/
341 $(Q) cp -r doc dist/doc/$(CFG_PACKAGE_VERS)
343 distcheck-docs: dist-docs
345 ######################################################################
346 # Primary targets (dist, distcheck)
347 ######################################################################
349 MAYBE_DIST_TAR_SRC=dist-tar-src dist/$(SRC_PKG_NAME).tar.gz
350 MAYBE_DISTCHECK_TAR_SRC=distcheck-tar-src dist/$(SRC_PKG_NAME).tar.gz
352 # FIXME #13224: On OS X don't produce tarballs simply because --exclude-vcs don't work.
353 # This is a huge hack because I just don't have time to figure out another solution.
354 ifeq ($(CFG_OSTYPE), apple-darwin)
356 MAYBE_DISTCHECK_TAR_SRC=
359 # Don't bother with source tarballs on windows just because we historically haven't.
360 ifeq ($(CFG_OSTYPE), pc-windows-gnu)
362 MAYBE_DISTCHECK_TAR_SRC=
365 ifneq ($(CFG_DISABLE_DOCS),)
367 MAYBE_DISTCHECK_DOCS=
369 MAYBE_DIST_DOCS=dist-docs
370 MAYBE_DISTCHECK_DOCS=distcheck-docs
373 dist: $(MAYBE_DIST_TAR_SRC) dist-tar-bins $(MAYBE_DIST_DOCS)
375 distcheck: $(MAYBE_DISTCHECK_TAR_SRC) distcheck-tar-bins $(MAYBE_DISTCHECK_DOCS)
376 $(Q)rm -Rf tmp/distcheck
378 @echo -----------------------------------------------
379 @echo "Rust ready for distribution (see ./dist)"
380 @echo -----------------------------------------------
382 .PHONY: dist distcheck