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