1# git.mk 2# 3# Copyright 2009, Red Hat, Inc. 4# Copyright 2010,2011,2012,2013 Behdad Esfahbod 5# Written by Behdad Esfahbod 6# 7# Copying and distribution of this file, with or without modification, 8# is permitted in any medium without royalty provided the copyright 9# notice and this notice are preserved. 10# 11# The latest version of this file can be downloaded from: 12# https://raw.github.com/behdad/git.mk/master/git.mk 13# Bugs, etc, should be reported upstream at: 14# https://github.com/behdad/git.mk 15# 16# To use in your project, import this file in your git repo's toplevel, 17# then do "make -f git.mk". This modifies all Makefile.am files in 18# your project to -include git.mk. Remember to add that line to new 19# Makefile.am files you create in your project, or just rerun the 20# "make -f git.mk". 21# 22# This enables automatic .gitignore generation. If you need to ignore 23# more files, add them to the GITIGNOREFILES variable in your Makefile.am. 24# But think twice before doing that. If a file has to be in .gitignore, 25# chances are very high that it's a generated file and should be in one 26# of MOSTLYCLEANFILES, CLEANFILES, DISTCLEANFILES, or MAINTAINERCLEANFILES. 27# 28# The only case that you need to manually add a file to GITIGNOREFILES is 29# when remove files in one of mostlyclean-local, clean-local, distclean-local, 30# or maintainer-clean-local make targets. 31# 32# Note that for files like editor backup, etc, there are better places to 33# ignore them. See "man gitignore". 34# 35# If "make maintainer-clean" removes the files but they are not recognized 36# by this script (that is, if "git status" shows untracked files still), send 37# me the output of "git status" as well as your Makefile.am and Makefile for 38# the directories involved and I'll diagnose. 39# 40# For a list of toplevel files that should be in MAINTAINERCLEANFILES, see 41# Makefile.am.sample in the git.mk git repo. 42# 43# Don't EXTRA_DIST this file. It is supposed to only live in git clones, 44# not tarballs. It serves no useful purpose in tarballs and clutters the 45# build dir. 46# 47# This file knows how to handle autoconf, automake, libtool, gtk-doc, 48# gnome-doc-utils, yelp.m4, mallard, intltool, gsettings, dejagnu. 49# 50# This makefile provides the following targets: 51# 52# - all: "make all" will build all gitignore files. 53# - gitignore: makes all gitignore files in the current dir and subdirs. 54# - .gitignore: make gitignore file for the current dir. 55# - gitignore-recurse: makes all gitignore files in the subdirs. 56# 57# KNOWN ISSUES: 58# 59# - Recursive configure doesn't work as $(top_srcdir)/git.mk inside the 60# submodule doesn't find us. If you have configure.{in,ac} files in 61# subdirs, add a proxy git.mk file in those dirs that simply does: 62# "include $(top_srcdir)/../git.mk". Add more ..'s to your taste. 63# And add those files to git. See vte/gnome-pty-helper/git.mk for 64# example. 65# 66 67 68 69############################################################################### 70# Variables user modules may want to add to toplevel MAINTAINERCLEANFILES: 71############################################################################### 72 73# 74# Most autotools-using modules should be fine including this variable in their 75# toplevel MAINTAINERCLEANFILES: 76GITIGNORE_MAINTAINERCLEANFILES_TOPLEVEL = \ 77 $(srcdir)/aclocal.m4 \ 78 $(srcdir)/autoscan.log \ 79 $(srcdir)/configure.scan \ 80 `AUX_DIR=$(srcdir)/$$(cd $(top_srcdir); $(AUTOCONF) --trace 'AC_CONFIG_AUX_DIR:$$1' ./configure.ac); \ 81 test "x$$AUX_DIR" = "x$(srcdir)/" && AUX_DIR=$(srcdir); \ 82 for x in \ 83 ar-lib \ 84 compile \ 85 config.guess \ 86 config.sub \ 87 depcomp \ 88 install-sh \ 89 ltmain.sh \ 90 missing \ 91 mkinstalldirs \ 92 test-driver \ 93 ; do echo "$$AUX_DIR/$$x"; done` \ 94 `cd $(top_srcdir); $(AUTOCONF) --trace 'AC_CONFIG_HEADERS:$$1' ./configure.ac | \ 95 head -n 1 | while read f; do echo "$(srcdir)/$$f.in"; done` 96# 97# All modules should also be fine including the following variable, which 98# removes automake-generated Makefile.in files: 99GITIGNORE_MAINTAINERCLEANFILES_MAKEFILE_IN = \ 100 `cd $(top_srcdir); $(AUTOCONF) --trace 'AC_CONFIG_FILES:$$1' ./configure.ac | \ 101 while read f; do \ 102 case $$f in Makefile|*/Makefile) \ 103 test -f "$(srcdir)/$$f.am" && echo "$(srcdir)/$$f.in";; esac; \ 104 done` 105# 106# Modules that use libtool and use AC_CONFIG_MACRO_DIR() may also include this, 107# though it's harmless to include regardless. 108GITIGNORE_MAINTAINERCLEANFILES_M4_LIBTOOL = \ 109 `MACRO_DIR=$(srcdir)/$$(cd $(top_srcdir); $(AUTOCONF) --trace 'AC_CONFIG_MACRO_DIR:$$1' ./configure.ac); \ 110 if test "x$$MACRO_DIR" != "x$(srcdir)/"; then \ 111 for x in \ 112 libtool.m4 \ 113 ltoptions.m4 \ 114 ltsugar.m4 \ 115 ltversion.m4 \ 116 lt~obsolete.m4 \ 117 ; do echo "$$MACRO_DIR/$$x"; done; \ 118 fi` 119 120 121 122############################################################################### 123# Default rule is to install ourselves in all Makefile.am files: 124############################################################################### 125 126git-all: git-mk-install 127 128git-mk-install: 129 @echo "Installing git makefile" 130 @any_failed=; \ 131 find "`test -z "$(top_srcdir)" && echo . || echo "$(top_srcdir)"`" -name Makefile.am | while read x; do \ 132 if grep 'include .*/git.mk' $$x >/dev/null; then \ 133 echo "$$x already includes git.mk"; \ 134 else \ 135 failed=; \ 136 echo "Updating $$x"; \ 137 { cat $$x; \ 138 echo ''; \ 139 echo '-include $$(top_srcdir)/git.mk'; \ 140 } > $$x.tmp || failed=1; \ 141 if test x$$failed = x; then \ 142 mv $$x.tmp $$x || failed=1; \ 143 fi; \ 144 if test x$$failed = x; then : else \ 145 echo "Failed updating $$x"; >&2 \ 146 any_failed=1; \ 147 fi; \ 148 fi; done; test -z "$$any_failed" 149 150.PHONY: git-all git-mk-install 151 152 153 154############################################################################### 155# Actual .gitignore generation: 156############################################################################### 157 158$(srcdir)/.gitignore: Makefile.am $(top_srcdir)/git.mk 159 @echo "git.mk: Generating $@" 160 @{ \ 161 if test "x$(DOC_MODULE)" = x -o "x$(DOC_MAIN_SGML_FILE)" = x; then :; else \ 162 for x in \ 163 $(DOC_MODULE)-decl-list.txt \ 164 $(DOC_MODULE)-decl.txt \ 165 tmpl/$(DOC_MODULE)-unused.sgml \ 166 "tmpl/*.bak" \ 167 xml html \ 168 ; do echo "/$$x"; done; \ 169 FLAVOR=$$(cd $(top_srcdir); $(AUTOCONF) --trace 'GTK_DOC_CHECK:$$2' ./configure.ac); \ 170 case $$FLAVOR in *no-tmpl*) echo /tmpl;; esac; \ 171 fi; \ 172 if test "x$(DOC_MODULE)$(DOC_ID)" = x -o "x$(DOC_LINGUAS)" = x; then :; else \ 173 for lc in $(DOC_LINGUAS); do \ 174 for x in \ 175 $(if $(DOC_MODULE),$(DOC_MODULE).xml) \ 176 $(DOC_PAGES) \ 177 $(DOC_INCLUDES) \ 178 ; do echo "/$$lc/$$x"; done; \ 179 done; \ 180 for x in \ 181 $(_DOC_OMF_ALL) \ 182 $(_DOC_DSK_ALL) \ 183 $(_DOC_HTML_ALL) \ 184 $(_DOC_MOFILES) \ 185 $(DOC_H_FILE) \ 186 "*/.xml2po.mo" \ 187 "*/*.omf.out" \ 188 ; do echo /$$x; done; \ 189 fi; \ 190 if test "x$(HELP_ID)" = x -o "x$(HELP_LINGUAS)" = x; then :; else \ 191 for lc in $(HELP_LINGUAS); do \ 192 for x in \ 193 $(HELP_FILES) \ 194 "$$lc.stamp" \ 195 "$$lc.mo" \ 196 ; do echo "/$$lc/$$x"; done; \ 197 done; \ 198 fi; \ 199 if test "x$(gsettings_SCHEMAS)" = x; then :; else \ 200 for x in \ 201 $(gsettings_SCHEMAS:.xml=.valid) \ 202 $(gsettings__enum_file) \ 203 ; do echo "/$$x"; done; \ 204 fi; \ 205 if test -f $(srcdir)/po/Makefile.in.in; then \ 206 for x in \ 207 po/Makefile.in.in \ 208 po/Makefile.in.in~ \ 209 po/Makefile.in \ 210 po/Makefile \ 211 po/Makevars.template \ 212 po/POTFILES \ 213 po/Rules-quot \ 214 po/stamp-it \ 215 po/.intltool-merge-cache \ 216 "po/*.gmo" \ 217 "po/*.header" \ 218 "po/*.mo" \ 219 "po/*.sed" \ 220 "po/*.sin" \ 221 po/$(GETTEXT_PACKAGE).pot \ 222 intltool-extract.in \ 223 intltool-merge.in \ 224 intltool-update.in \ 225 ; do echo "/$$x"; done; \ 226 fi; \ 227 if test -f $(srcdir)/configure; then \ 228 for x in \ 229 autom4te.cache \ 230 configure \ 231 config.h \ 232 stamp-h1 \ 233 libtool \ 234 config.lt \ 235 ; do echo "/$$x"; done; \ 236 fi; \ 237 if test "x$(DEJATOOL)" = x; then :; else \ 238 for x in \ 239 $(DEJATOOL) \ 240 ; do echo "/$$x.sum"; echo "/$$x.log"; done; \ 241 echo /site.exp; \ 242 fi; \ 243 if test "x$(am__dirstamp)" = x; then :; else \ 244 echo "$(am__dirstamp)"; \ 245 fi; \ 246 if test "x$(LTCOMPILE)" = x -a "x$(GTKDOC_RUN)" = x; then :; else \ 247 for x in \ 248 "*.lo" \ 249 ".libs" "_libs" \ 250 ; do echo "$$x"; done; \ 251 fi; \ 252 for x in \ 253 .gitignore \ 254 $(GITIGNOREFILES) \ 255 $(CLEANFILES) \ 256 $(PROGRAMS) $(check_PROGRAMS) $(EXTRA_PROGRAMS) \ 257 $(LIBRARIES) $(check_LIBRARIES) $(EXTRA_LIBRARIES) \ 258 $(LTLIBRARIES) $(check_LTLIBRARIES) $(EXTRA_LTLIBRARIES) \ 259 so_locations \ 260 $(MOSTLYCLEANFILES) \ 261 $(TEST_LOGS) \ 262 $(TEST_LOGS:.log=.trs) \ 263 $(TEST_SUITE_LOG) \ 264 "*.$(OBJEXT)" \ 265 $(DISTCLEANFILES) \ 266 $(am__CONFIG_DISTCLEAN_FILES) \ 267 $(CONFIG_CLEAN_FILES) \ 268 TAGS ID GTAGS GRTAGS GSYMS GPATH tags \ 269 "*.tab.c" \ 270 $(MAINTAINERCLEANFILES) \ 271 $(BUILT_SOURCES) \ 272 $(DEPDIR) \ 273 $(patsubst %.vala,%.c,$(filter %.vala,$(SOURCES))) \ 274 $(filter %_vala.stamp,$(DIST_COMMON)) \ 275 $(filter %.vapi,$(DIST_COMMON)) \ 276 $(filter %$(patsubst %.vapi,%.h,$(filter %.vapi,$(DIST_COMMON))),$(DIST_COMMON)) \ 277 Makefile \ 278 Makefile.in \ 279 "*.orig" \ 280 "*.rej" \ 281 "*.bak" \ 282 "*~" \ 283 ".*.sw[nop]" \ 284 ".dirstamp" \ 285 ; do echo "/$$x"; done; \ 286 } | \ 287 sed "s@^/`echo "$(srcdir)" | sed 's/\(.\)/[\1]/g'`/@/@" | \ 288 sed 's@/[.]/@/@g' | \ 289 LC_ALL=C sort | uniq > $@.tmp && \ 290 mv $@.tmp $@; 291 292all: $(srcdir)/.gitignore gitignore-recurse-maybe 293gitignore: $(srcdir)/.gitignore gitignore-recurse 294 295gitignore-recurse-maybe: 296 @for subdir in $(DIST_SUBDIRS); do \ 297 case " $(SUBDIRS) " in \ 298 *" $$subdir "*) :;; \ 299 *) test "$$subdir" = . -o -e "$$subdir/.git" || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) gitignore || echo "Skipping $$subdir");; \ 300 esac; \ 301 done 302gitignore-recurse: 303 @for subdir in $(DIST_SUBDIRS); do \ 304 test "$$subdir" = . -o -e "$$subdir/.git" || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) gitignore || echo "Skipping $$subdir"); \ 305 done 306 307maintainer-clean: gitignore-clean 308gitignore-clean: 309 -rm -f $(srcdir)/.gitignore 310 311.PHONY: gitignore-clean gitignore gitignore-recurse gitignore-recurse-maybe 312