debian/tg2quilt.mk

   1 #
   2 # tg2quilt.mk - TopGit-to-quilt functionality for debian/rules files
   3 #
   4 # This make(1) snippet facilitates the conversion of TopGit branches to
   5 # a quilt series.
   6 #
   7 # It is intended to be included from debian/rules files of TopGit-using
   8 # packages, like so:
   9 #
  10 #   -include /usr/share/topgit/tg2quilt.mk
  11 #
  12 # The snippet exports the following targets. These targets only perform the
  13 # describe behaviour when invoked from a TopGit repository (`tg summary -t`
  14 # returns a non-empty set); used outside, they simply output informational
  15 # messages but do not cause errors.
  16 #
  17 #       tg-export: exports the TopGit patches into a quilt series under
  18 #                  debian/patches.
  19 #                    You may set TG_BRANCHES to a comma- or -space-separated
  20 #                  subset of branches (but not comma-and-space-separated) to
  21 #                  export (before including the file).
  22 #                    If debian/patches/series already exists, the target
  23 #                  will take note, blather a bit, and get out of the way.
  24 #
  25 #        tg-clean: cleans the source tree, just like the debian/rules clean
  26 #                  target, and invokes tg-rmdir
  27 #
  28 #        tg-rmdir: tries to remove debian/patches, but only if there are no
  29 #                  non-TopGit files under the directory.
  30 #                    The heuristic is to find files that do not contain a line
  31 #                  matchines /^tg:/, minus the series file. If any such files
  32 #                  are found, an error occurs. Otherwise, the directory is
  33 #                  removed. This means that edits to the series file are
  34 #                  likely to vanish.
  35 #
  36 #   tg-forceclean: cleans the source tree, just like the debian/rules clean
  37 #                  target, and forcefully removes the debian/patches
  38 #                  directory in doing so. Yes, *force*-fully. WHAM!
  39 #
  40 # This file also hooks into the standard debian/rules and quilt targets such
  41 # that tg-export is automatically invoked before quilt gets a chance to patch
  42 # or unpatch the tree.
  43 #
  44 # The PATCHES_DIR variable can be set before including the file to override
  45 # the default debian/patches location.
  46 #
  47 # More information, particularly for people working on TopGit-using packages,
  48 # can be found in /usr/share/doc/topgit/HOWTO-tg2quilt.gz .
  49 #
  50 # Copyright © 2008 martin f. krafft <madduck@debian.org> Released under terms
  51 # of the the Artistic Licence 2.0.
  52 #
  53
  54 ifeq ($(shell tg summary -t),)
  55   # This is not a TopGit branch, so just blubber a bit.
  56
  57   tg-export tg-clean tg-forceclean tg-rmdir:
  58         @echo "E: The $@ target only works from a TopGit repository." >&2
  59 else
  60
  61 # We are in a TopGit branch, so let the fun begin.
  62
  63 PATCHES_DIR ?= debian/patches
  64
  65 # Hook tg-export into quilt's make(1) snippet such that it gets executed
  66 # before quilt patches or unpatches.
  67 debian/stamp-patched: tg-export
  68 unpatch: __tg-temp-export
  69 __tg-temp-export:
  70         @echo "Exporting TopGit branches to series so that quilt can clean up..." >&2
  71         $(MAKE) $(MAKEFLAGS) -f debian/rules tg-export
  72
  73 # Set some tg-export-specific variables, e.g. default TG_BRANCHES to all
  74 # TopGit branches
  75 tg-export: TG_BRANCHES ?= $(shell tg summary -t)
  76         # see make manual for this trick:
  77 tg-export: __TG_COMMA := ,
  78 tg-export: __TG_EMPTY :=
  79 tg-export: __TG_SPACE := $(__TG_EMPTY) $(__TG_EMPTY)
  80
  81 ifeq ($(wildcard $(PATCHES_DIR)/series),)
  82   # The series file does not exist, so we proceed normally
  83
  84   # tg-export will not work if the target dir already exists, so try to remove
  85   # it by calling tg-rmdir
  86   tg-export: tg-rmdir
  87         tg export -b $(subst $(__TG_SPACE),$(__TG_COMMA),$(TG_BRANCHES)) --quilt $(PATCHES_DIR)
  88 else
  89   # The series file already exists, so assume there is nothing to do.
  90   tg-export:
  91         @echo "I: TopGit patch series already exists, nothing to do." >&2
  92         @echo "I: (invoke the \`tg-clean\` target to remove the series.)" >&2
  93         @echo "I: (you can ignore this message during a \`tg-clean\` run.)" >&2
  94 endif
  95
  96 ifeq ($(wildcard $(PATCHES_DIR)),)
  97   # No patch directory, so nothing to do:
  98   tg-rmdir:
  99         @true
 100
 101 else
 102   # There is a patch directory, let's try to clean it out:
 103   tg-rmdir: __TG_FILES := $(shell find $(PATCHES_DIR) -type f -a -not -path \*/series \
 104                                     | xargs grep -l '^tg:')
 105   tg-rmdir:
 106         # remove all files whose contents matches /^tg:/
 107         test -n "$(__TG_FILES)" && rm $(__TG_FILES) || :
 108         # remove the series file
 109         test -f $(PATCHES_DIR)/series && rm $(PATCHES_DIR)/series || :
 110         # try to remove directories
 111         find $(PATCHES_DIR) -type d | tac | xargs rmdir 2>/dev/null || :
 112         # fail if the directory could not be removed and still exists
 113         @test ! -d $(PATCHES_DIR) || { \
 114           echo "E: $(PATCHES_DIR) contains non-TopGit-generated files:" >&2; \
 115           find $(PATCHES_DIR) -type f -printf 'E:   %P\n' >&2; \
 116           false; \
 117         }
 118 endif
 119
 120 # Make sure that we try to clean up the patches directory last
 121 tg-clean: clean
 122         $(MAKE) $(MAKEFLAGS) -f debian/rules tg-rmdir
 123
 124 tg-forceclean: clean
 125         test -d debian/patches && rm -r $(PATCHES_DIR) || :
 126
 127 endif
 128
 129 .PHONY: tg-clean tg-export tg-forceclean tg-rmdir
 130
 131 # vim:ft=make:ts=8:noet