pkg/pkg.mk: use intermediate state files

Rely on file creation and dependencies instead of .PHONY targets.
Files will be rebuilt when changing version as the main `Makefile` will
have been updated. All steps are re-done on version change.

When deleting patches, the '.prepare' step should be redone thanks
to the included 'patch-dep.inc' file (TODO TEST ME).

Implementation in order:

* '.git': means the repository has been cloned.
* '.git-downloaded': Fetches the wanted version
* '.git-prepared': will clean checkout the version and apply patches

pkg/local.mk

@@ -6,10 +6,7 @@
 #
 # WARNING: any local changes made to $(PKG_BUILDDIR) *will* get lost!
 
-.PHONY: prepare git-download clean
+.PHONY: prepare clean
-
-git-download:
-	@true
 
 prepare: $(PKG_BUILDDIR)/.prepared
 	@true

pkg/pkg.mk

@@ -1,8 +1,12 @@
 #
 # Include this file if your Package needs to be checked out by git
 #
+# A package is up to date when its '.git-prepared' file is up to date.
+# Any change to the package makefile will force updating the repository
+#
 # Packages should include this file just after defining the PKG_* variables
 # This will ensure the variables are defined in the Makefile.
+
 ifneq (,$(.DEFAULT_GOAL))
   $(error $(lastword $(MAKEFILE_LIST)) must be included at the beginning of the file after defining the PKG_* variables)
 endif
@@ -20,8 +24,8 @@ ifeq (,$(PKG_LICENSE))
   $(error PKG_LICENSE not defined)
 endif
 
-PKG_DIR?=$(CURDIR)
+PKG_DIR ?= $(CURDIR)
-PKG_BUILDDIR?=$(PKGDIRBASE)/$(PKG_NAME)
+PKG_BUILDDIR ?= $(PKGDIRBASE)/$(PKG_NAME)
 PKG_SOURCE_LOCAL ?= $(PKG_SOURCE_LOCAL_$(shell echo $(PKG_NAME) | tr a-z- A-Z_))
 
 # allow overriding package source with local folder (useful during development)
@@ -29,59 +33,79 @@ ifneq (,$(PKG_SOURCE_LOCAL))
   include $(RIOTBASE)/pkg/local.mk
 else
 
-.PHONY: prepare git-download clean git-ensure-version
-
-prepare: git-download
-
-ifneq (,$(wildcard $(PKG_DIR)/patches))
-git-download: $(PKG_BUILDDIR)/.git-patched
-else
-git-download: git-ensure-version
-endif
-
 ifeq ($(QUIET),1)
   GIT_QUIET ?= --quiet
 endif
 
+GITFLAGS ?= -c user.email=buildsystem@riot -c user.name="RIOT buildsystem"
+GITAMFLAGS ?= $(GIT_QUIET) --no-gpg-sign --ignore-whitespace --whitespace=nowarn
+
+.PHONY: all prepare clean distclean FORCE
+
+PKG_PATCHES = $(sort $(wildcard $(PKG_DIR)/patches/*.patch))
+
+PKG_STATE_FILE = .pkg-state.git
+PKG_STATE      = $(PKG_BUILDDIR)/$(PKG_STATE_FILE)
+
+PKG_PREPARED   = $(PKG_STATE)-prepared
+PKG_PATCHED    = $(PKG_STATE)-patched
+PKG_DOWNLOADED = $(PKG_STATE)-downloaded
+
+# Declare 'all' first to have it being the default target
+all: $(PKG_PREPARED)
+prepare: $(PKG_PREPARED)
+
+# Allow packages to add a custom step to be `prepared`.
+# It should be a dependency of `$(PKG_PREPARED)` and depend on `$(PKG_PATCHED)`
+$(PKG_PREPARED): $(PKG_PATCHED)
+	@touch $@
+
 # Use explicit '--git-dir' and '--work-tree' to prevent issues when the
 # directory is not a git repository for any reason (clean -xdff or others)
 GIT_IN_PKG = git -C $(PKG_BUILDDIR) --git-dir=.git --work-tree=.
 
-GITFLAGS ?= -c user.email=buildsystem@riot -c user.name="RIOT buildsystem"
+# When $(PKG_PATCHED).d is included $(PKG_PATCHED) pre-requisites will include
-GITAMFLAGS ?= $(GIT_QUIET) --no-gpg-sign --ignore-whitespace --whitespace=nowarn
+# the old pre-requisites forcing a rebuild on pre-requisite removal, but we do
+# not want to generate $(PKG_PATCHED).d with the old pre-requisites
+PKG_PATCHED_PRE_REQUISITES = $(PKG_PATCHES) $(PKG_DOWNLOADED) $(MAKEFILE_LIST)
 
-ifneq (,$(wildcard $(PKG_DIR)/patches))
+# Generate dependency file. Force rebuilding on dependency deletion
-$(PKG_BUILDDIR)/.git-patched: git-ensure-version $(PKG_DIR)/Makefile $(PKG_DIR)/patches/*.patch
+# Warning: It will be evaluated before target execution, so use as first step
+#   $1: output file name
+gen_dependency_files = $(file >$1,$@: $2)$(foreach f,$2,$(file >>$1,$(f):))
+
+# Patch the package
+# * create dependencies files
+# * clean, without removing the 'state' files
+# * checkout the wanted base commit
+# * apply patches if there are any. (If none, it does nothing)
+$(PKG_PATCHED): $(PKG_PATCHED_PRE_REQUISITES)
+	$(info [INFO] patch $(PKG_NAME))
+	$(call gen_dependency_files,$@.d,$(PKG_PATCHED_PRE_REQUISITES))
+	$(Q)$(GIT_IN_PKG) clean $(GIT_QUIET) -xdff '**' $(PKG_STATE:$(PKG_BUILDDIR)/%=':!%*')
 	$(Q)$(GIT_IN_PKG) checkout $(GIT_QUIET) -f $(PKG_VERSION)
-	$(Q)$(GIT_IN_PKG) $(GITFLAGS) am $(GITAMFLAGS) "$(PKG_DIR)"/patches/*.patch
+	$(Q)$(GIT_IN_PKG) $(GITFLAGS) am $(GITAMFLAGS) $(PKG_PATCHES) </dev/null
-	$(Q)touch $@
+	@touch $@
-endif
 
-git-ensure-version: $(PKG_BUILDDIR)/.git-downloaded
+$(PKG_DOWNLOADED): $(MAKEFILE_LIST) | $(PKG_BUILDDIR)/.git
-	@if [ $(shell $(GIT_IN_PKG) rev-parse HEAD) != $(PKG_VERSION) ] ; then \
+	$(info [INFO] updating $(PKG_NAME) $(PKG_DOWNLOADED))
-		$(GIT_IN_PKG) clean $(GIT_QUIET) -xdff ; \
+	$(Q)$(GIT_IN_PKG) fetch $(GIT_QUIET) $(PKG_URL) $(PKG_VERSION)
-		$(GIT_IN_PKG) fetch $(GIT_QUIET) "$(PKG_URL)" "$(PKG_VERSION)" ; \
+	echo $(PKG_VERSION) > $@
-		$(GIT_IN_PKG) checkout $(GIT_QUIET) -f $(PKG_VERSION) ; \
-		touch $(PKG_BUILDDIR)/.git-downloaded ; \
-	fi
 
-$(PKG_BUILDDIR)/.git-downloaded:
+$(PKG_BUILDDIR)/.git:
+	$(info [INFO] cloning $(PKG_NAME))
 	$(Q)rm -Rf $(PKG_BUILDDIR)
 	$(Q)mkdir -p $(PKG_BUILDDIR)
-	$(Q)$(GITCACHE) clone "$(PKG_URL)" "$(PKG_VERSION)" "$(PKG_BUILDDIR)"
+	$(Q)$(GITCACHE) clone $(PKG_URL) $(PKG_VERSION) $(PKG_BUILDDIR)
-	$(Q)touch $@
 
 clean::
-	@test -d $(PKG_BUILDDIR) && { \
+	@-test -d $(PKG_BUILDDIR) && $(GIT_IN_PKG) clean $(GIT_QUIET) -xdff
-		rm $(PKG_BUILDDIR)/.git-patched ; \
-		$(GIT_IN_PKG) clean -f ; \
-		$(GIT_IN_PKG) checkout "$(PKG_VERSION)"; \
-		make $(PKG_BUILDDIR)/.git-patched ; \
-		touch $(PKG_BUILDDIR)/.git-downloaded ; \
-	} > /dev/null 2>&1 || true
 
 distclean::
-	rm -rf "$(PKG_BUILDDIR)"
+	rm -rf $(PKG_BUILDDIR)
+
+# Dependencies to 'patches'
+-include $(PKG_PATCHED).d
 
 # Reset goal for package
 .DEFAULT_GOAL =