3f709a545d332a0c956409afbc5933e212aa217d
[bup.git] / Makefile
1
2 SHELL := bash
3 .DEFAULT_GOAL := all
4
5 # See config/config.vars.in (sets bup_python, among other things)
6 include config/config.vars
7
8 pf := set -o pipefail
9
10 define isok
11   && echo " ok" || echo " no"
12 endef
13
14 # If ok, strip trailing " ok" and return the output, otherwise, error
15 define shout
16 $(if $(subst ok,,$(lastword $(1))),$(error $(2)),$(shell x="$(1)"; echo $${x%???}))
17 endef
18
19 sampledata_rev := $(shell t/configure-sampledata --revision $(isok))
20 sampledata_rev := \
21   $(call shout,$(sampledata_rev),Could not parse sampledata revision)
22
23 current_sampledata := t/sampledata/var/rev/v$(sampledata_rev)
24
25 os := $(shell ($(pf); uname | sed 's/[-_].*//') $(isok))
26 os := $(call shout,$(os),Unable to determine OS)
27
28 CFLAGS := -Wall -O2 -Werror -Wno-unknown-pragmas $(PYINCLUDE) $(CFLAGS)
29 CFLAGS := -D_FILE_OFFSET_BITS=64 $(CFLAGS)
30 SOEXT:=.so
31
32 ifeq ($(os),CYGWIN)
33   SOEXT:=.dll
34 endif
35
36 ifdef TMPDIR
37   test_tmp := $(TMPDIR)
38 else
39   test_tmp := $(CURDIR)/t/tmp
40 endif
41
42 initial_setup := $(shell ./configure-version --update $(isok))
43 initial_setup := $(call shout,$(initial_setup),Version configuration failed))
44
45 config/config.vars: configure config/configure config/configure.inc \
46   $(wildcard config/*.in)
47         MAKE="$(MAKE)" ./configure
48
49 bup_cmds := cmd/bup-python \
50   $(patsubst cmd/%-cmd.py,cmd/bup-%,$(wildcard cmd/*-cmd.py)) \
51   $(patsubst cmd/%-cmd.sh,cmd/bup-%,$(wildcard cmd/*-cmd.sh))
52
53 bup_deps := lib/bup/_checkout.py lib/bup/_helpers$(SOEXT) $(bup_cmds)
54
55 all: $(bup_deps) Documentation/all $(current_sampledata)
56
57 $(current_sampledata):
58         t/configure-sampledata --setup
59
60
61 bup_libdir="$script_home/../lib"  # bup_libdir will be adjusted during install
62
63 define install-bup-python
64   set -e; \
65   sed -e 's|.*# bup_libdir will be adjusted during install|bup_libdir="$$script_home/.."|' $1 > $2; \
66   chmod 0755 $2;
67 endef
68
69 PANDOC ?= $(shell type -p pandoc)
70
71 ifeq (,$(PANDOC))
72   $(shell echo "Warning: pandoc not found; skipping manpage generation" 1>&2)
73   man_md :=
74 else
75   man_md := $(wildcard Documentation/*.md)
76 endif
77
78 man_roff := $(patsubst %.md,%.1,$(man_md))
79 man_html := $(patsubst %.md,%.html,$(man_md))
80
81 INSTALL=install
82 PREFIX=/usr/local
83 MANDIR=$(PREFIX)/share/man
84 DOCDIR=$(PREFIX)/share/doc/bup
85 BINDIR=$(PREFIX)/bin
86 LIBDIR=$(PREFIX)/lib/bup
87
88 dest_mandir := $(DESTDIR)$(MANDIR)
89 dest_docdir := $(DESTDIR)$(DOCDIR)
90 dest_bindir := $(DESTDIR)$(BINDIR)
91 dest_libdir := $(DESTDIR)$(LIBDIR)
92
93 install: all
94         $(INSTALL) -d $(dest_bindir) \
95                 $(dest_libdir)/bup $(dest_libdir)/cmd \
96                 $(dest_libdir)/web $(dest_libdir)/web/static
97         test -z "$(man_roff)" || install -d $(dest_mandir)/man1
98         test -z "$(man_roff)" || $(INSTALL) -m 0644 $(man_roff) $(dest_mandir)/man1
99         test -z "$(man_html)" || install -d $(dest_docdir)
100         test -z "$(man_html)" || $(INSTALL) -m 0644 $(man_html) $(dest_docdir)
101         $(INSTALL) -pm 0755 cmd/bup $(dest_libdir)/cmd/
102         $(INSTALL) -pm 0755 cmd/bup-* $(dest_libdir)/cmd/
103         $(call install-bup-python,cmd/bup-python,"$(dest_libdir)/cmd/bup-python")
104         cd "$(dest_bindir)" && \
105           ln -sf "$$($(bup_python) -c 'import os; print(os.path.relpath("$(abspath $(dest_libdir))/cmd/bup"))')"
106         set -e; \
107         $(INSTALL) -pm 0644 \
108                 lib/bup/*.py \
109                 $(dest_libdir)/bup
110         $(INSTALL) -pm 0755 \
111                 lib/bup/*$(SOEXT) \
112                 $(dest_libdir)/bup
113         $(INSTALL) -pm 0644 \
114                 lib/web/static/* \
115                 $(dest_libdir)/web/static/
116         $(INSTALL) -pm 0644 \
117                 lib/web/*.html \
118                 $(dest_libdir)/web/
119
120 config/config.h: config/config.vars
121
122 lib/bup/_helpers$(SOEXT): \
123                 config/config.h \
124                 lib/bup/bupsplit.c lib/bup/_helpers.c lib/bup/csetup.py
125         @rm -f $@
126         cd lib/bup && \
127         LDFLAGS="$(LDFLAGS)" CFLAGS="$(CFLAGS)" "$(bup_python)" csetup.py build
128         # Make sure there's just the one file we expect before we copy it.
129         "$(bup_python)" -c \
130           "import glob; assert(len(glob.glob('lib/bup/build/*/_helpers*$(SOEXT)')) == 1)"
131         cp lib/bup/build/*/_helpers*$(SOEXT) "$@"
132
133 lib/bup/_checkout.py:
134         @if grep -F '$Format' lib/bup/_release.py \
135             && ! test -e lib/bup/_checkout.py; then \
136           echo "Something has gone wrong; $@ should already exist."; \
137           echo 'Check "./configure-version --update"'; \
138           false; \
139         fi
140
141 t/tmp:
142         mkdir t/tmp
143
144 runtests: runtests-python runtests-cmdline
145
146 python_tests := \
147   lib/bup/t/tbloom.py \
148   lib/bup/t/tclient.py \
149   lib/bup/t/tgit.py \
150   lib/bup/t/thashsplit.py \
151   lib/bup/t/thelpers.py \
152   lib/bup/t/tindex.py \
153   lib/bup/t/tmetadata.py \
154   lib/bup/t/toptions.py \
155   lib/bup/t/tresolve.py \
156   lib/bup/t/tshquote.py \
157   lib/bup/t/tvfs.py \
158   lib/bup/t/tvint.py \
159   lib/bup/t/txstat.py
160
161 # The "pwd -P" here may not be appropriate in the long run, but we
162 # need it until we settle the relevant drecurse/exclusion questions:
163 # https://groups.google.com/forum/#!topic/bup-list/9ke-Mbp10Q0
164 runtests-python: all t/tmp
165         mkdir -p t/tmp/test-log
166         $(pf); cd $$(pwd -P); TMPDIR="$(test_tmp)" \
167           ./wvtest.py  $(python_tests) 2>&1 \
168             | tee -a t/tmp/test-log/$$$$.log
169
170 cmdline_tests := \
171   t/test.sh \
172   t/test-argv \
173   t/test-cat-file.sh \
174   t/test-command-without-init-fails.sh \
175   t/test-compression.sh \
176   t/test-drecurse.sh \
177   t/test-fsck.sh \
178   t/test-fuse.sh \
179   t/test-ftp \
180   t/test-gc.sh \
181   t/test-import-duplicity.sh \
182   t/test-import-rdiff-backup.sh \
183   t/test-index.sh \
184   t/test-index-check-device.sh \
185   t/test-index-clear.sh \
186   t/test-list-idx.sh \
187   t/test-ls \
188   t/test-ls-remote \
189   t/test-main.sh \
190   t/test-meta.sh \
191   t/test-on.sh \
192   t/test-packsizelimit \
193   t/test-prune-older \
194   t/test-redundant-saves.sh \
195   t/test-restore-map-owner.sh \
196   t/test-restore-single-file.sh \
197   t/test-rm.sh \
198   t/test-rm-between-index-and-save.sh \
199   t/test-save-creates-no-unrefs.sh \
200   t/test-save-restore \
201   t/test-save-restore-excludes.sh \
202   t/test-save-strip-graft.sh \
203   t/test-save-with-valid-parent.sh \
204   t/test-sparse-files.sh \
205   t/test-split-join.sh \
206   t/test-tz.sh \
207   t/test-xdev.sh
208
209 ifeq "2" "$(bup_python_majver)"
210   cmdline_tests += \
211     t/test-web.sh
212 endif
213
214 tmp-target-run-test-get-%: all t/tmp
215         $(pf); cd $$(pwd -P); TMPDIR="$(test_tmp)" \
216           t/test-get $* 2>&1 | tee -a t/tmp/test-log/$$$$.log
217
218 test_get_targets += \
219   tmp-target-run-test-get-replace \
220   tmp-target-run-test-get-universal \
221   tmp-target-run-test-get-ff \
222   tmp-target-run-test-get-append \
223   tmp-target-run-test-get-pick \
224   tmp-target-run-test-get-new-tag \
225   tmp-target-run-test-get-unnamed
226
227 # For parallel runs.
228 # The "pwd -P" here may not be appropriate in the long run, but we
229 # need it until we settle the relevant drecurse/exclusion questions:
230 # https://groups.google.com/forum/#!topic/bup-list/9ke-Mbp10Q0
231 tmp-target-run-test%: all t/tmp
232         $(pf); cd $$(pwd -P); TMPDIR="$(test_tmp)" \
233           t/test$* 2>&1 | tee -a t/tmp/test-log/$$$$.log
234
235 runtests-cmdline: $(test_get_targets) $(subst t/test,tmp-target-run-test,$(cmdline_tests))
236
237 stupid:
238         PATH=/bin:/usr/bin $(MAKE) test
239
240 test: all
241         if test -e t/tmp/test-log; then rm -r t/tmp/test-log; fi
242         mkdir -p t/tmp/test-log
243         ./wvtest watch --no-counts \
244           $(MAKE) runtests 2>t/tmp/test-log/$$$$.log
245         ./wvtest report t/tmp/test-log/*.log
246
247 check: test
248
249 distcheck: all
250         ./wvtest run t/test-release-archive.sh
251
252 cmd/bup-python: cmd/python-cmd.sh config/config.var/bup-python
253         "$$(cat config/config.var/bup-python)" dev/replace -l '@bup_python@' \
254           "$$(dev/shquote < config/config.var/bup-python)" \
255           < "$<" > "$@".$$PPID.tmp
256         chmod +x "$@".$$PPID.tmp
257         mv "$@".$$PPID.tmp "$@"
258
259 long-test: export BUP_TEST_LEVEL=11
260 long-test: test
261
262 long-check: export BUP_TEST_LEVEL=11
263 long-check: check
264
265 .PHONY: check-both
266 check-both:
267         $(MAKE) clean \
268           && PYTHON=python3 BUP_ALLOW_UNEXPECTED_PYTHON_VERSION=true $(MAKE) check
269         $(MAKE) clean \
270           && PYTHON=python2 $(MAKE) check
271
272 cmd/bup-%: cmd/%-cmd.py
273         rm -f $@
274         ln -s $*-cmd.py $@
275
276 cmd/bup-%: cmd/%-cmd.sh
277         rm -f $@
278         ln -s $*-cmd.sh $@
279
280 .PHONY: Documentation/all
281 Documentation/all: $(man_roff) $(man_html)
282
283 Documentation/substvars: $(bup_deps)
284         echo "s,%BUP_VERSION%,$$(./bup version --tag),g" > $@
285         echo "s,%BUP_DATE%,$$(./bup version --date),g" >> $@
286
287 Documentation/%.1: Documentation/%.md Documentation/substvars
288         $(pf); sed -f Documentation/substvars $< \
289           | $(PANDOC) -s -r markdown -w man -o $@
290
291 Documentation/%.html: Documentation/%.md Documentation/substvars
292         $(pf); sed -f Documentation/substvars $< \
293           | $(PANDOC) -s -r markdown -w html -o $@
294
295 .PHONY: Documentation/clean
296 Documentation/clean:
297         cd Documentation && rm -f *~ .*~ *.[0-9] *.html substvars
298
299 # Note: this adds commits containing the current manpages in roff and
300 # html format to the man and html branches respectively.  The version
301 # is determined by "git describe --always".
302 .PHONY: update-doc-branches
303 update-doc-branches: Documentation/all
304         dev/update-doc-branches refs/heads/man refs/heads/html
305
306 # push the pregenerated doc files to origin/man and origin/html
307 push-docs: export-docs
308         git push origin man html
309
310 # import pregenerated doc files from origin/man and origin/html, in case you
311 # don't have pandoc but still want to be able to install the docs.
312 import-docs: Documentation/clean
313         $(pf); git archive origin/html | (cd Documentation && tar -xvf -)
314         $(pf); git archive origin/man | (cd Documentation && tar -xvf -)
315
316 clean: Documentation/clean cmd/bup-python
317         cd config && rm -f *~ .*~ \
318           ${CONFIGURE_DETRITUS} ${CONFIGURE_FILES} ${GENERATED_FILES}
319         cd config && rm -rf config.var
320         rm -f *.o lib/*/*.o *.so lib/*/*.so *.dll lib/*/*.dll *.exe \
321                 .*~ *~ */*~ lib/*/*~ lib/*/*/*~ \
322                 *.pyc */*.pyc lib/*/*.pyc lib/*/*/*.pyc \
323                 randomgen memtest \
324                 testfs.img lib/bup/t/testfs.img
325         for x in $$(ls cmd/*-cmd.py cmd/*-cmd.sh | grep -vF python-cmd.sh | cut -b 5-); do \
326             echo "cmd/bup-$${x%-cmd.*}"; \
327         done | xargs -t rm -f
328         if test -e t/mnt; then t/cleanup-mounts-under t/mnt; fi
329         if test -e t/mnt; then rm -r t/mnt; fi
330         if test -e t/tmp; then t/cleanup-mounts-under t/tmp; fi
331         # FIXME: migrate these to t/mnt/
332         if test -e lib/bup/t/testfs; \
333           then umount lib/bup/t/testfs || true; fi
334         rm -rf *.tmp *.tmp.meta t/*.tmp lib/*/*/*.tmp build lib/bup/build lib/bup/t/testfs
335         if test -e t/tmp; then t/force-delete t/tmp; fi
336         ./configure-version --clean
337         t/configure-sampledata --clean
338         # Remove last so that cleanup tools can depend on it
339         rm -f cmd/bup-python