GNUmakefile

# disable built-in rules (mostly to aid debugging)
.SUFFIXES:

# Technically we need 4.1.90 for .SHELLSTATUS, but everything relevant
# seems to have at least 4.2 (mostly 4.4 and higher) anyway, so let's
# just require 4.2+ to simplify, and if we ever raise the limit to
# 4.4+, we'll have intcmp.

# Assumes make versions always have at least two components.
make_maj := $(word 1,$(subst ., ,$(MAKE_VERSION)))
ifneq (,$(filter $(make_maj),0 1 2 3))
  $(error $(MAKE) version $(MAKE_VERSION) is < 4.2)
endif
make_min := $(word 2,$(subst ., ,$(MAKE_VERSION)))
ifeq (4,$(make_maj))
  ifneq (,$(filter $(make_min),0 1))
    $(error $(MAKE) version $(MAKE_VERSION) is < 4.2)
  endif
endif

$(shell mkdir -p config/config.var && echo "$(MAKE)" > config/config.var/make)
ifneq (0, $(.SHELLSTATUS))
  $(error Unable to record config/config.var/make)
endif

ifeq ($V,1)
Q=
define quiet
endef
define notquiet
  $1
endef
else
define quiet
  @echo "  "$1 $2
endef
define notquiet
endef
Q=@
endif

MAKEFLAGS += --warn-undefined-variables

SHELL := bash
.DEFAULT_GOAL := all

# So where possible we can make tests more reproducible
export BUP_TEST_RANDOM_SEED ?= $(shell echo "$$RANDOM")

# Guard against accidentally using/testing a local bup
export PATH := $(CURDIR)/dev/shadow-bin:$(PATH)

clean_paths :=
generated_dependencies :=

# See config/config.vars.in (sets bup_python_config, among other things)
include config/config.vars
-include $(generated_dependencies)

pf := set -o pipefail

define isok
  && echo " ok" || echo " no"
endef

# If ok, strip trailing " ok" and return the output, otherwise, error
define shout
$(if $(subst ok,,$(lastword $(1))),$(error $(2)),$(shell x="$(1)"; echo $${x%???}))
endef

sampledata_rev := $(shell dev/configure-sampledata --revision $(isok))
sampledata_rev := \
  $(call shout,$(sampledata_rev),Could not parse sampledata revision)

current_sampledata := test/sampledata/var/rev/v$(sampledata_rev)

os := $(shell ($(pf); uname | sed 's/[-_].*//') $(isok))
os := $(call shout,$(os),Unable to determine OS)

# CFLAGS CPPFLAGS LDFLAGS are handled vis config/config.vars.in

# Satisfy --warn-undefined-variables
DESTDIR ?=
TARGET_ARCH ?=

bup_shared_cflags = $(bup_config_cflags)
bup_shared_cflags += -D_FILE_OFFSET_BITS=64
bup_shared_cflags += -Wno-unknown-pragmas -Wsign-compare
bup_shared_cflags += -O2 -Wall -Werror -Wformat=2 -MMD -MP

bup_shared_ldflags :=

soext := .so
ifeq ($(os),CYGWIN)
  soext := .dll
endif

ifdef TMPDIR
  test_tmp := $(TMPDIR)
else
  test_tmp := $(CURDIR)/test/tmp
endif

initial_setup := $(shell dev/update-checkout-info lib/bup/checkout_info.py $(isok))
initial_setup := $(call shout,$(initial_setup),update-checkout-info failed))
clean_paths += lib/bup/checkout_info.py

# Dependency changes here should be mirrored in Makefile
config/config.vars: configure config/configure config/configure.inc config/*.in
	$(Q)MAKE="$(MAKE)" ./configure

# On some platforms, Python.h and readline.h fight over the
# _XOPEN_SOURCE version, i.e. -Werror crashes on a mismatch, so for
# now, we're just going to let Python's version win.

helpers_cflags = $(bup_python_cflags) $(bup_shared_cflags) -I$(CURDIR)/src
helpers_ldflags = $(bup_python_ldflags) $(bup_shared_ldflags)

bup_readline_cflags ?= # avoid warnings before config.vars exists
ifneq ($(strip $(bup_readline_cflags)),)
  readline_cflags += $(bup_readline_cflags)
  readline_xopen := $(filter -D_XOPEN_SOURCE=%,$(readline_cflags))
  readline_xopen := $(subst -D_XOPEN_SOURCE=,,$(readline_xopen))
  readline_cflags := $(filter-out -D_XOPEN_SOURCE=%,$(readline_cflags))
  readline_cflags += $(addprefix -DBUP_RL_EXPECTED_XOPEN_SOURCE=,$(readline_xopen))
  helpers_cflags += $(readline_cflags)
endif

helpers_ldflags += $(bup_readline_ldflags)

bup_have_libacl ?= # avoid warnings before config.vars exists
ifeq ($(bup_have_libacl),1)
  helpers_cflags += $(bup_libacl_cflags)
  helpers_ldflags += $(bup_libacl_ldflags)
endif

bup_ext_cmds := lib/cmd/bup-import-rdiff-backup lib/cmd/bup-import-rsnapshot

bup_deps := lib/bup/_helpers$(soext) lib/cmd/bup

incomplete_saves_svg := \
  issue/missing-objects-fig-bloom-get.svg \
  issue/missing-objects-fig-bloom-set.svg \
  issue/missing-objects-fig-bup-model-2.svg \
  issue/missing-objects-fig-bup-model.svg \
  issue/missing-objects-fig-gc-dangling.svg \
  issue/missing-objects-fig-get-bug-save.svg \
  issue/missing-objects-fig-git-model.svg \
  issue/missing-objects-fig-rm-after-gc.svg \
  issue/missing-objects-fig-rm-after.svg \
  issue/missing-objects-fig-rm-before.svg
clean_paths += $(incomplete_saves_svg)

issue/missing-objects.html: $(incomplete_saves_svg)

issue/%.svg: issue/%.dot
	$(call quiet,"DOT ",$@)
	$(Q)$(DOT) -Tsvg $< > $@

issue/%.html: issue/%.md
	$(call quiet,"HTML",$@)
	$(Q)$(PANDOC) -s --embed-resources --resource-path issue \
	  -r markdown -w html -o $@ $<

issues :=
man_md :=

DOT ?= $(shell type -p dot)
PANDOC ?= $(shell type -p pandoc)

ifeq (,$(PANDOC))
  $(info Warning: pandoc not found; skipping generation of related documents)
else
  man_md := $(wildcard Documentation/*.md)
  ifeq (,$(findstring --embed-resources,$(shell $(PANDOC) --help)))
    $(info Warning: no pandoc --embed-resources; skipping generation of related documents)
  else
    ifeq (,$(DOT))
      $(info Warning: graphviz dot not found; skipping generation of related documents)
    else
      issues += issue/missing-objects.html
    endif
  endif
endif


all: dev/bup-exec dev/bup-python dev/python $(bup_deps) Documentation/all \
  $(issues) $(current_sampledata)

$(current_sampledata):
	$(Q)dev/configure-sampledata --setup

man_roff := $(man_md:.md=)
man_html := $(man_md:.md=.html)

INSTALL=install
PREFIX=/usr/local
MANDIR=$(PREFIX)/share/man
DOCDIR=$(PREFIX)/share/doc/bup
BINDIR=$(PREFIX)/bin
LIBDIR=$(PREFIX)/lib/bup

dest_mandir := $(DESTDIR)$(MANDIR)
dest_docdir := $(DESTDIR)$(DOCDIR)
dest_bindir := $(DESTDIR)$(BINDIR)
dest_libdir := $(DESTDIR)$(LIBDIR)

install: all
	$(INSTALL) -d $(dest_bindir) $(dest_libdir)/bup/cmd $(dest_libdir)/cmd \
	  $(dest_libdir)/web/static
	for f in $(man_roff); do \
	    sec="$${f##*.}"; \
	    $(INSTALL) -d $(dest_mandir)/man"$$sec"; \
	    $(INSTALL) -m 0644 "$$f" $(dest_mandir)/man"$$sec"; \
	done
	test -z "$(man_html)" || install -d $(dest_docdir)
	test -z "$(man_html)" || $(INSTALL) -m 0644 $(man_html) $(dest_docdir)
	$(INSTALL) -pm 0755 lib/cmd/bup "$(dest_libdir)/cmd/bup"
	$(INSTALL) -pm 0755 $(bup_ext_cmds) "$(dest_libdir)/cmd/"
	cd "$(dest_bindir)" && \
	  ln -sf "$$($(CURDIR)/dev/python -c 'import os; print(os.path.relpath("$(abspath $(dest_libdir))/cmd/bup"))')" \
	    .
	set -e; \
	$(INSTALL) -pm 0644 lib/bup/*.py $(dest_libdir)/bup/
	$(INSTALL) -pm 0644 lib/bup/cmd/*.py $(dest_libdir)/bup/cmd/
	$(INSTALL) -pm 0755 \
		lib/bup/*$(soext) \
		$(dest_libdir)/bup
	$(INSTALL) -pm 0644 \
		lib/web/static/* \
		$(dest_libdir)/web/static/
	$(INSTALL) -pm 0644 \
		lib/web/*.html \
		$(dest_libdir)/web/
	if test -e lib/bup/checkout_info.py; then \
	    $(INSTALL) -pm 0644 lib/bup/checkout_info.py \
	        $(dest_libdir)/bup/source_info.py; \
	else \
	    ! grep -qF '$$Format' lib/bup/source_info.py; \
	    $(INSTALL) -pm 0644 lib/bup/source_info.py $(dest_libdir)/bup/; \
	fi

embed_cflags = $(bup_python_cflags_embed) $(bup_shared_cflags) -I$(CURDIR)/src
embed_ldflags = $(bup_python_ldflags_embed) $(bup_shared_ldflags)

config/config.h: config/config.vars
clean_paths += config/config.h.tmp

define cc_bin
  $(call quiet,"CC  ",$@)
  $(Q)$(CC) $(embed_cflags) -I src $(CPPFLAGS) $(CFLAGS) $^ \
    $(embed_ldflags) $(LDFLAGS) -fPIE -o $@
endef

clean_paths += dev/python-proposed
generated_dependencies += dev/python-proposed.d
dev/python-proposed: dev/python.c src/bup/compat.c src/bup/io.c
	$(Q)rm -f dev/python
	$(cc_bin)

clean_paths += dev/python
dev/python: dev/python-proposed
	$(Q)dev/validate-python $@-proposed
	$(Q)cp -R -p $@-proposed $@

clean_paths += dev/bup-exec
generated_dependencies += dev/bup-exec.d
dev/bup-exec: bup_shared_cflags += -D BUP_DEV_BUP_EXEC=1
dev/bup-exec: lib/cmd/bup.c src/bup/compat.c src/bup/io.c
	$(cc_bin)

clean_paths += dev/bup-python
generated_dependencies += dev/bup-python.d
dev/bup-python: bup_shared_cflags += -D BUP_DEV_BUP_PYTHON=1
dev/bup-python: lib/cmd/bup.c src/bup/compat.c src/bup/io.c
	$(cc_bin)

clean_paths += lib/cmd/bup
generated_dependencies += lib/cmd/bup.d
lib/cmd/bup: lib/cmd/bup.c src/bup/compat.c src/bup/io.c
	$(cc_bin)

clean_paths += lib/bup/_helpers$(soext)
generated_dependencies += lib/bup/_helpers.d
lib/bup/_helpers$(soext): lib/bup/_helpers.c src/bup/pyutil.c lib/bup/bupsplit.c lib/bup/_hashsplit.c
	$(call quiet,"CC  ",$@)
	$(Q)$(CC) $(helpers_cflags) $(CPPFLAGS) $(CFLAGS) $^ \
	  $(helpers_ldflags) $(LDFLAGS) -o $@

test/tmp:
	$(Q)mkdir test/tmp

# MAKEFLAGS must not be in an immediate := assignment
parallel_opt = $(lastword $(filter -j%,$(MAKEFLAGS)))
get_parallel_n = $(patsubst -j%,%,$(parallel_opt))
maybe_specific_n = $(if $(filter -j%,$(parallel_opt)),-n$(get_parallel_n))
xdist_opt = $(if $(filter -j,$(parallel_opt)),-nauto,$(maybe_specific_n))

.PHONY: lint-lib
lint-lib: dev/bup-exec dev/bup-python
	$(call quiet,"LINT","lib")
	$(Q)./pylint lib

# unused-wildcard-import: we always "import * from wvpytest"
.PHONY: lint-test
lint-test: dev/bup-exec dev/bup-python
	$(call quiet,"LINT","test")
	$(Q)./pylint -d unused-wildcard-import test/lib test/int

.PHONY: lint
lint: lint-lib lint-test

test: all test/tmp dev/python lint
	$(Q)! bup version >/dev/null  # Ensure we can't test the local bup (cf. dev/shadow-bin)
	$(Q)./bup features
	$(Q)./pytest $(xdist_opt)

stupid:
	PATH=/bin:/usr/bin $(MAKE) test

check: test

distcheck: all
	if test yes = $$(dev/python -c "import xdist; print('yes')" 2>/dev/null); then \
	  ($(call notquiet,set -x;) ./pytest $(xdist_opt) -m release;) \
	else \
	  ($(call notquiet,set -x;) ./pytest -m release;) \
	fi

long-test: export BUP_TEST_LEVEL=11
long-test: test

long-check: export BUP_TEST_LEVEL=11
long-check: check

.PHONY: check-py3
check-py3:
	$(MAKE) clean && BUP_PYTHON_CONFIG=python3-config $(MAKE) check

.PHONY: Documentation/all
Documentation/all: $(man_roff) $(man_html)

Documentation/substvars: $(bup_deps)
        # FIXME: real temp file
	$(Q)set -e; bup_ver=$$(./bup version); \
	echo "s,%BUP_VERSION%,$$bup_ver,g" > $@.tmp;
	$(Q)set -e; bup_date=$$(./bup version --date); \
	echo "s,%BUP_DATE%,$$bup_date,g" >> $@.tmp
	$(Q)mv $@.tmp $@

define render_page
  $(pf); sed -f Documentation/substvars $< \
    | "$(PANDOC)" -s -r markdown -w $(1) -o $(2)
endef

Documentation/%: Documentation/%.md Documentation/substvars
	$(call quiet,"MAN ",$@)
	$(Q)$(call render_page,man,$@)
Documentation/%.html: Documentation/%.md Documentation/substvars
	$(call quiet,"HTML",$@)
	$(Q)$(call render_page,html,$@)

.PHONY: Documentation/clean
Documentation/clean:
	cd Documentation && rm -f *~ .*~ *.[0-9] *.html substvars

# Note: this adds commits containing the current manpages in roff and
# html format to the man and html branches respectively.  The version
# is determined by "git describe --always".
.PHONY: update-doc-branches
update-doc-branches: Documentation/all
	dev/update-doc-branches refs/heads/man refs/heads/html

# push the pregenerated doc files to origin/man and origin/html
push-docs: export-docs
	git push origin man html

# import pregenerated doc files from origin/man and origin/html, in case you
# don't have pandoc but still want to be able to install the docs.
import-docs: Documentation/clean
	$(pf); git archive origin/html | (cd Documentation && tar -xvf -)
	$(pf); git archive origin/man | (cd Documentation && tar -xvf -)

clean: Documentation/clean
	cd config && rm -rf finished bin config.var

        # Clean up the mounts first, so that find, etc. won't crash later
	if test -e test/mnt; then dev/cleanup-mounts-under test/mnt; fi
	if test -e test/mnt; then rm -r test/mnt; fi
	if test -e test/tmp; then dev/cleanup-mounts-under test/tmp; fi
        # FIXME: migrate these to test/mnt/
	if test -e test/int/testfs; \
	  then umount test/int/testfs || true; fi
	rm -rf test/int/testfs test/int/testfs.img testfs.img

	cd config && rm -f \
	  ${CONFIGURE_DETRITUS} ${CONFIGURE_FILES} ${GENERATED_FILES}
	rm -rf $(clean_paths) .pytest_cache
	rm -f $(generated_dependencies)
	find . -name __pycache__ -exec rm -rf {} +
	if test -e test/tmp; then dev/force-delete test/tmp; fi
	dev/configure-sampledata --clean