git.mk

   1 # git.mk
   2 #
   3 # Copyright 2009, Red Hat, Inc.
   4 # Written by Behdad Esfahbod
   5 #
   6 # Copying and distribution of this file, with or without modification,
   7 # are permitted in any medium without royalty provided the copyright
   8 # notice and this notice are preserved.
   9 #
  10 # The canonical source for this file is pango/git.mk, or whereever the
  11 # header of pango/git.mk suggests in the future.
  12 #
  13 # To use in your project, import this file in your git repo's toplevel,
  14 # then do "make -f git.mk".  This modifies all Makefile.am files in
  15 # your project to include git.mk.
  16 #
  17 # This enables automatic .gitignore generation.  If you need to ignore
  18 # more files, add them to the GITIGNOREFILES variable in your Makefile.am.
  19 # But think twice before doing that.  If a file has to be in .gitignore,
  20 # chances are very high that it's a generated file and should be in one
  21 # of MOSTLYCLEANFILES, CLEANFILES, DISTCLEANFILES, or MAINTAINERCLEANFILES.
  22 #
  23 # The only case that you need to manually add a file to GITIGNOREFILES is
  24 # when remove files in one of mostlyclean-local, clean-local, distclean-local,
  25 # or maintainer-clean-local.
  26 #
  27 # Note that for files like editor backup, etc, there are better places to
  28 # ignore them.  See "man gitignore".
  29 #
  30 # If "make maintainer-clean" removes the files but they are not recognized
  31 # by this script (that is, if "git stat" shows untracked files still), send
  32 # me the output of "git stat" as well as your Makefile.am and Makefile for
  33 # the directories involved.
  34 #
  35 # For a list of toplevel files that should be in MAINTAINERCLEANFILES, see
  36 # pango/Makefile.am.
  37 #
  38 # Don't EXTRA_DIST this file.  It is supposed to only live in git clones,
  39 # not tarballs.  It serves no useful purpose in tarballs and clutters the
  40 # build dir.
  41 #
  42 # This file knows how to handle autoconf, automake, libtool, gtk-doc,
  43 # gnome-doc-utils, intltool.
  44 #
  45 #
  46 # KNOWN ISSUES:
  47 #
  48 # - Recursive configure doesn't work as $(top_srcdir)/git.mk inside the
  49 #   submodule doesn't find us.  If you have configure.{in,ac} files in
  50 #   subdirs, add a proxy git.mk file in those dirs that simply does:
  51 #   "include $(top_srcdir)/../git.mk".  Add more ..'s to your taste.
  52 #   And add those files to git.  See vte/gnome-pty-helper/git.mk for
  53 #   example.
  54 #
  55
  56 git-all: git-mk-install
  57
  58 git-mk-install:
  59         @echo Installing git makefile
  60         @any_failed=; find $(top_srcdir) -name Makefile.am | while read x; do \
  61                 if grep 'include .*/git.mk' $$x >/dev/null; then \
  62                         echo $$x already includes git.mk; \
  63                 else \
  64                         failed=; \
  65                         echo "Updating $$x"; \
  66                         { cat $$x; \
  67                           echo ''; \
  68                           echo '-include $$(top_srcdir)/git.mk'; \
  69                         } > $$x.tmp || failed=1; \
  70                         if test x$$failed = x; then \
  71                                 mv $$x.tmp $$x || failed=1; \
  72                         fi; \
  73                         if test x$$failed = x; then : else \
  74                                 echo Failed updating $$x; >&2 \
  75                                 any_failed=1; \
  76                         fi; \
  77         fi; done; test -z "$$any_failed"
  78
  79 .PHONY: git-all git-mk-install
  80
  81
  82 ### .gitignore generation
  83
  84 $(srcdir)/.gitignore: Makefile.am $(top_srcdir)/git.mk
  85         @echo Generating $@; \
  86         GTKDOCGITIGNOREFILES=; \
  87         test "x$(DOC_MODULE)" = x -o "x$(DOC_MAIN_SGML_FILE)" = x || \
  88         GTKDOCGITIGNOREFILES=" \
  89                 $(DOC_MODULE)-decl-list.txt \
  90                 $(DOC_MODULE)-decl.txt \
  91                 tmpl/$(DOC_MODULE)-unused.sgml \
  92                 tmpl/*.bak \
  93                 xml html \
  94                 "; \
  95         GNOMEDOCUTILSGITIGNOREFILES=; \
  96         test "x$(DOC_MODULE)" = x -o "x$(DOC_LINGUAS)" = x || \
  97         GNOMEDOCUTILSGITIGNOREFILES=" \
  98                 $(_DOC_C_DOCS) \
  99                 $(_DOC_LC_DOCS) \
 100                 $(_DOC_OMF_ALL) \
 101                 $(_DOC_DSK_ALL) \
 102                 $(_DOC_HTML_ALL) \
 103                 $(_DOC_POFILES) \
 104                 */.xml2po.mo \
 105                 */*.omf.out \
 106                 "; \
 107         INTLTOOLGITIGNOREFILES=; test -f $(srcdir)/po/Makefile.in.in && \
 108         INTLTOOLGITIGNOREFILES=" \
 109                 po/Makefile.in.in \
 110                 po/Makefile.in \
 111                 po/Makefile \
 112                 po/*.gmo \
 113                 po/*.mo \
 114                 po/POTFILES \
 115                 po/stamp-it \
 116                 po/.intltool-merge-cache \
 117                 intltool-extract.in \
 118                 intltool-merge.in \
 119                 intltool-update.in \
 120                 "; \
 121         AUTOCONFGITIGNOREFILES=; test -f $(srcdir)/configure && \
 122         AUTOCONFGITIGNOREFILES=" \
 123                 autom4te.cache \
 124                 configure \
 125                 config.h \
 126                 stamp-h1 \
 127                 libtool \
 128                 config.lt \
 129                 "; \
 130         for x in \
 131                 .gitignore \
 132                 $$GTKDOCGITIGNOREFILES \
 133                 $$GNOMEDOCUTILSGITIGNOREFILES \
 134                 $$INTLTOOLGITIGNOREFILES \
 135                 $$AUTOCONFGITIGNOREFILES \
 136                 $(GITIGNOREFILES) \
 137                 $(CLEANFILES) \
 138                 $(PROGRAMS) \
 139                 $(EXTRA_PROGRAMS) \
 140                 $(LTLIBRARIES) \
 141                 so_locations \
 142                 .libs _libs \
 143                 $(MOSTLYCLEANFILES) \
 144                 "*.$(OBJEXT)" \
 145                 "*.lo" \
 146                 $(DISTCLEANFILES) \
 147                 $(am__CONFIG_DISTCLEAN_FILES) \
 148                 $(CONFIG_CLEAN_FILES) \
 149                 TAGS ID GTAGS GRTAGS GSYMS GPATH tags \
 150                 "*.tab.c" \
 151                 $(MAINTAINERCLEANFILES) \
 152                 $(BUILT_SOURCES) \
 153                 $(DEPDIR) \
 154                 Makefile \
 155                 Makefile.in \
 156                 "*.orig" \
 157                 "*.rej" \
 158                 "*.bak" \
 159                 "*~" \
 160                 ".*.swp" \
 161         ; do echo /$$x; done | \
 162         sed "s@^/`echo "$(srcdir)" | sed 's/\(.\)/[\1]/g'`/@/@" | \
 163         sed 's@/[.]/@/@g' | \
 164         LANG=C sort | uniq > $@.tmp && \
 165         mv $@.tmp $@;
 166
 167 all: $(srcdir)/.gitignore gitignore-recurse
 168 gitignore-recurse:
 169         @if test "x$(SUBDIRS)" = "x$(DIST_SUBDIRS)"; then :; else \
 170                 list='$(DIST_SUBDIRS)'; for subdir in $$list; do \
 171                   test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) .gitignore); \
 172                 done; \
 173         fi;
 174 maintainer-clean-local: gitignore-clean
 175 gitignore-clean:
 176         rm -f $(srcdir)/.gitignore
 177 .PHONY: gitignore-clean gitignore-recurse
 178