git.mk 10.5 KB
Newer Older
1 2
# git.mk, a small Makefile to autogenerate .gitignore files
# for autotools-based projects.
Behdad Esfahbod's avatar
Behdad Esfahbod committed
3
#
4
# Copyright 2009, Red Hat, Inc.
5
# Copyright 2010,2011,2012,2013 Behdad Esfahbod
Behdad Esfahbod's avatar
Behdad Esfahbod committed
6 7
# Written by Behdad Esfahbod
#
8
# Copying and distribution of this file, with or without modification,
9
# is permitted in any medium without royalty provided the copyright
10 11
# notice and this notice are preserved.
#
12
# The latest version of this file can be downloaded from:
13 14
GIT_MK_URL = https://raw.githubusercontent.com/behdad/git.mk/master/git.mk
#
15 16
# Bugs, etc, should be reported upstream at:
#   https://github.com/behdad/git.mk
Behdad Esfahbod's avatar
Behdad Esfahbod committed
17 18 19
#
# To use in your project, import this file in your git repo's toplevel,
# then do "make -f git.mk".  This modifies all Makefile.am files in
20 21 22
# your project to -include git.mk.  Remember to add that line to new
# Makefile.am files you create in your project, or just rerun the
# "make -f git.mk".
Behdad Esfahbod's avatar
Behdad Esfahbod committed
23 24 25 26 27 28 29 30 31
#
# This enables automatic .gitignore generation.  If you need to ignore
# more files, add them to the GITIGNOREFILES variable in your Makefile.am.
# But think twice before doing that.  If a file has to be in .gitignore,
# chances are very high that it's a generated file and should be in one
# of MOSTLYCLEANFILES, CLEANFILES, DISTCLEANFILES, or MAINTAINERCLEANFILES.
#
# The only case that you need to manually add a file to GITIGNOREFILES is
# when remove files in one of mostlyclean-local, clean-local, distclean-local,
32
# or maintainer-clean-local make targets.
Behdad Esfahbod's avatar
Behdad Esfahbod committed
33 34 35 36 37
#
# Note that for files like editor backup, etc, there are better places to
# ignore them.  See "man gitignore".
#
# If "make maintainer-clean" removes the files but they are not recognized
Behdad Esfahbod's avatar
Behdad Esfahbod committed
38 39
# by this script (that is, if "git status" shows untracked files still), send
# me the output of "git status" as well as your Makefile.am and Makefile for
40
# the directories involved and I'll diagnose.
Behdad Esfahbod's avatar
Behdad Esfahbod committed
41 42
#
# For a list of toplevel files that should be in MAINTAINERCLEANFILES, see
43
# Makefile.am.sample in the git.mk git repo.
Behdad Esfahbod's avatar
Behdad Esfahbod committed
44 45 46 47 48
#
# Don't EXTRA_DIST this file.  It is supposed to only live in git clones,
# not tarballs.  It serves no useful purpose in tarballs and clutters the
# build dir.
#
49
# This file knows how to handle autoconf, automake, libtool, gtk-doc,
50 51
# gnome-doc-utils, yelp.m4, mallard, intltool, gsettings, dejagnu, appdata,
# appstream.
52
#
53 54 55 56 57 58
# This makefile provides the following targets:
#
# - all: "make all" will build all gitignore files.
# - gitignore: makes all gitignore files in the current dir and subdirs.
# - .gitignore: make gitignore file for the current dir.
# - gitignore-recurse: makes all gitignore files in the subdirs.
Behdad Esfahbod's avatar
Behdad Esfahbod committed
59 60 61 62 63 64 65 66 67 68 69
#
# KNOWN ISSUES:
#
# - Recursive configure doesn't work as $(top_srcdir)/git.mk inside the
#   submodule doesn't find us.  If you have configure.{in,ac} files in
#   subdirs, add a proxy git.mk file in those dirs that simply does:
#   "include $(top_srcdir)/../git.mk".  Add more ..'s to your taste.
#   And add those files to git.  See vte/gnome-pty-helper/git.mk for
#   example.
#

70 71 72 73 74 75 76 77 78 79 80 81 82


###############################################################################
# Variables user modules may want to add to toplevel MAINTAINERCLEANFILES:
###############################################################################

#
# Most autotools-using modules should be fine including this variable in their
# toplevel MAINTAINERCLEANFILES:
GITIGNORE_MAINTAINERCLEANFILES_TOPLEVEL = \
	$(srcdir)/aclocal.m4 \
	$(srcdir)/autoscan.log \
	$(srcdir)/configure.scan \
83 84 85
	`AUX_DIR=$(srcdir)/$$(cd $(top_srcdir); $(AUTOCONF) --trace 'AC_CONFIG_AUX_DIR:$$1' ./configure.ac); \
	 test "x$$AUX_DIR" = "x$(srcdir)/" && AUX_DIR=$(srcdir); \
	 for x in \
86 87 88 89 90 91 92 93 94
		ar-lib \
		compile \
		config.guess \
		config.sub \
		depcomp \
		install-sh \
		ltmain.sh \
		missing \
		mkinstalldirs \
95
		test-driver \
96
		ylwrap \
97
	 ; do echo "$$AUX_DIR/$$x"; done` \
98
	`cd $(top_srcdir); $(AUTOCONF) --trace 'AC_CONFIG_HEADERS:$$1' ./configure.ac | \
99 100 101 102 103
	head -n 1 | while read f; do echo "$(srcdir)/$$f.in"; done`
#
# All modules should also be fine including the following variable, which
# removes automake-generated Makefile.in files:
GITIGNORE_MAINTAINERCLEANFILES_MAKEFILE_IN = \
104
	`cd $(top_srcdir); $(AUTOCONF) --trace 'AC_CONFIG_FILES:$$1' ./configure.ac | \
105 106 107 108 109
	while read f; do \
	  case $$f in Makefile|*/Makefile) \
	    test -f "$(srcdir)/$$f.am" && echo "$(srcdir)/$$f.in";; esac; \
	done`
#
110 111
# Modules that use libtool and use  AC_CONFIG_MACRO_DIR() may also include this,
# though it's harmless to include regardless.
112
GITIGNORE_MAINTAINERCLEANFILES_M4_LIBTOOL = \
113 114 115 116 117 118 119 120 121 122
	`MACRO_DIR=$(srcdir)/$$(cd $(top_srcdir); $(AUTOCONF) --trace 'AC_CONFIG_MACRO_DIR:$$1' ./configure.ac); \
	 if test "x$$MACRO_DIR" != "x$(srcdir)/"; then \
		for x in \
			libtool.m4 \
			ltoptions.m4 \
			ltsugar.m4 \
			ltversion.m4 \
			lt~obsolete.m4 \
		; do echo "$$MACRO_DIR/$$x"; done; \
	 fi`
123 124 125 126 127 128 129



###############################################################################
# Default rule is to install ourselves in all Makefile.am files:
###############################################################################

Behdad Esfahbod's avatar
Behdad Esfahbod committed
130 131 132
git-all: git-mk-install

git-mk-install:
133 134 135
	@echo "Installing git makefile"
	@any_failed=; \
		find "`test -z "$(top_srcdir)" && echo . || echo "$(top_srcdir)"`" -name Makefile.am | while read x; do \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
136
		if grep 'include .*/git.mk' $$x >/dev/null; then \
137
			echo "$$x already includes git.mk"; \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
138 139 140 141 142 143 144 145 146 147 148
		else \
			failed=; \
			echo "Updating $$x"; \
			{ cat $$x; \
			  echo ''; \
			  echo '-include $$(top_srcdir)/git.mk'; \
			} > $$x.tmp || failed=1; \
			if test x$$failed = x; then \
				mv $$x.tmp $$x || failed=1; \
			fi; \
			if test x$$failed = x; then : else \
149
				echo "Failed updating $$x"; >&2 \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
150 151 152 153
				any_failed=1; \
			fi; \
	fi; done; test -z "$$any_failed"

154 155 156 157
git-mk-update:
	wget $(GIT_MK_URL) -O $(top_srcdir)/git.mk

.PHONY: git-all git-mk-install git-mk-update
Behdad Esfahbod's avatar
Behdad Esfahbod committed
158 159


160 161 162 163

###############################################################################
# Actual .gitignore generation:
###############################################################################
Behdad Esfahbod's avatar
Behdad Esfahbod committed
164

165
$(srcdir)/.gitignore: Makefile.am $(top_srcdir)/git.mk
166 167
	@echo "git.mk: Generating $@"
	@{ \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
168 169 170 171 172 173 174
		if test "x$(DOC_MODULE)" = x -o "x$(DOC_MAIN_SGML_FILE)" = x; then :; else \
			for x in \
				$(DOC_MODULE)-decl-list.txt \
				$(DOC_MODULE)-decl.txt \
				tmpl/$(DOC_MODULE)-unused.sgml \
				"tmpl/*.bak" \
				xml html \
175
			; do echo "/$$x"; done; \
176 177
			FLAVOR=$$(cd $(top_srcdir); $(AUTOCONF) --trace 'GTK_DOC_CHECK:$$2' ./configure.ac); \
			case $$FLAVOR in *no-tmpl*) echo /tmpl;; esac; \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
178
		fi; \
179 180 181 182 183 184 185 186
		if test "x$(DOC_MODULE)$(DOC_ID)" = x -o "x$(DOC_LINGUAS)" = x; then :; else \
			for lc in $(DOC_LINGUAS); do \
				for x in \
					$(if $(DOC_MODULE),$(DOC_MODULE).xml) \
					$(DOC_PAGES) \
					$(DOC_INCLUDES) \
				; do echo "/$$lc/$$x"; done; \
			done; \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
187 188 189 190
			for x in \
				$(_DOC_OMF_ALL) \
				$(_DOC_DSK_ALL) \
				$(_DOC_HTML_ALL) \
191 192
				$(_DOC_MOFILES) \
				$(DOC_H_FILE) \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
193 194 195 196
				"*/.xml2po.mo" \
				"*/*.omf.out" \
			; do echo /$$x; done; \
		fi; \
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
		if test "x$(HELP_ID)" = x -o "x$(HELP_LINGUAS)" = x; then :; else \
			for lc in $(HELP_LINGUAS); do \
				for x in \
					$(HELP_FILES) \
					"$$lc.stamp" \
					"$$lc.mo" \
				; do echo "/$$lc/$$x"; done; \
			done; \
		fi; \
		if test "x$(gsettings_SCHEMAS)" = x; then :; else \
			for x in \
				$(gsettings_SCHEMAS:.xml=.valid) \
				$(gsettings__enum_file) \
			; do echo "/$$x"; done; \
		fi; \
212 213 214 215 216
		if test "x$(appdata_XML)" = x; then :; else \
			for x in \
				$(appdata_XML:.xml=.valid) \
			; do echo "/$$x"; done; \
		fi; \
217 218 219 220 221
		if test "x$(appstream_XML)" = x; then :; else \
			for x in \
				$(appstream_XML:.xml=.valid) \
			; do echo "/$$x"; done; \
		fi; \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
222 223 224
		if test -f $(srcdir)/po/Makefile.in.in; then \
			for x in \
				po/Makefile.in.in \
225
				po/Makefile.in.in~ \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
226 227
				po/Makefile.in \
				po/Makefile \
228
				po/Makevars.template \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
229
				po/POTFILES \
230
				po/Rules-quot \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
231 232 233
				po/stamp-it \
				po/.intltool-merge-cache \
				"po/*.gmo" \
234
				"po/*.header" \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
235
				"po/*.mo" \
236 237
				"po/*.sed" \
				"po/*.sin" \
Christian Persch's avatar
Christian Persch committed
238
				po/$(GETTEXT_PACKAGE).pot \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
239 240 241
				intltool-extract.in \
				intltool-merge.in \
				intltool-update.in \
242
			; do echo "/$$x"; done; \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
243 244 245 246 247 248 249 250 251
		fi; \
		if test -f $(srcdir)/configure; then \
			for x in \
				autom4te.cache \
				configure \
				config.h \
				stamp-h1 \
				libtool \
				config.lt \
252 253 254 255 256 257 258 259 260 261 262
			; do echo "/$$x"; done; \
		fi; \
		if test "x$(DEJATOOL)" = x; then :; else \
			for x in \
				$(DEJATOOL) \
			; do echo "/$$x.sum"; echo "/$$x.log"; done; \
			echo /site.exp; \
		fi; \
		if test "x$(am__dirstamp)" = x; then :; else \
			echo "$(am__dirstamp)"; \
		fi; \
263
		if test "x$(LTCOMPILE)" = x -a "x$(LTCXXCOMPILE)" = x -a "x$(GTKDOC_RUN)" = x; then :; else \
264 265 266 267
			for x in \
				"*.lo" \
				".libs" "_libs" \
			; do echo "$$x"; done; \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
268 269 270 271 272
		fi; \
		for x in \
			.gitignore \
			$(GITIGNOREFILES) \
			$(CLEANFILES) \
273 274 275
			$(PROGRAMS) $(check_PROGRAMS) $(EXTRA_PROGRAMS) \
			$(LIBRARIES) $(check_LIBRARIES) $(EXTRA_LIBRARIES) \
			$(LTLIBRARIES) $(check_LTLIBRARIES) $(EXTRA_LTLIBRARIES) \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
276 277
			so_locations \
			$(MOSTLYCLEANFILES) \
278 279 280
			$(TEST_LOGS) \
			$(TEST_LOGS:.log=.trs) \
			$(TEST_SUITE_LOG) \
281
			$(TESTS:=.test) \
282 283
			"*.gcda" \
			"*.gcno" \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
284 285 286 287 288 289 290
			$(DISTCLEANFILES) \
			$(am__CONFIG_DISTCLEAN_FILES) \
			$(CONFIG_CLEAN_FILES) \
			TAGS ID GTAGS GRTAGS GSYMS GPATH tags \
			"*.tab.c" \
			$(MAINTAINERCLEANFILES) \
			$(BUILT_SOURCES) \
291 292 293 294
			$(patsubst %.vala,%.c,$(filter %.vala,$(SOURCES))) \
			$(filter %_vala.stamp,$(DIST_COMMON)) \
			$(filter %.vapi,$(DIST_COMMON)) \
			$(filter $(addprefix %,$(notdir $(patsubst %.vapi,%.h,$(filter %.vapi,$(DIST_COMMON))))),$(DIST_COMMON)) \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
295 296 297 298 299 300 301
			Makefile \
			Makefile.in \
			"*.orig" \
			"*.rej" \
			"*.bak" \
			"*~" \
			".*.sw[nop]" \
302 303
			".dirstamp" \
		; do echo "/$$x"; done; \
304 305 306 307
		for x in \
			"*.$(OBJEXT)" \
			$(DEPDIR) \
		; do echo "$$x"; done; \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
308
	} | \
309
	sed "s@^/`echo "$(srcdir)" | sed 's/\(.\)/[\1]/g'`/@/@" | \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
310
	sed 's@/[.]/@/@g' | \
311
	LC_ALL=C sort | uniq > $@.tmp && \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
312 313
	mv $@.tmp $@;

Behdad Esfahbod's avatar
Behdad Esfahbod committed
314
all: $(srcdir)/.gitignore gitignore-recurse-maybe
315 316
gitignore: $(srcdir)/.gitignore gitignore-recurse

Behdad Esfahbod's avatar
Behdad Esfahbod committed
317
gitignore-recurse-maybe:
318 319 320
	@for subdir in $(DIST_SUBDIRS); do \
	  case " $(SUBDIRS) " in \
	    *" $$subdir "*) :;; \
321
	    *) test "$$subdir" = . -o -e "$$subdir/.git" || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) gitignore || echo "Skipping $$subdir");; \
322
	  esac; \
Behdad Esfahbod's avatar
Behdad Esfahbod committed
323
	done
324 325 326 327
gitignore-recurse:
	@for subdir in $(DIST_SUBDIRS); do \
	    test "$$subdir" = . -o -e "$$subdir/.git" || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) gitignore || echo "Skipping $$subdir"); \
	done
Behdad Esfahbod's avatar
Behdad Esfahbod committed
328

329
maintainer-clean: gitignore-clean
Behdad Esfahbod's avatar
Behdad Esfahbod committed
330
gitignore-clean:
331
	-rm -f $(srcdir)/.gitignore
Behdad Esfahbod's avatar
Behdad Esfahbod committed
332

Behdad Esfahbod's avatar
Behdad Esfahbod committed
333
.PHONY: gitignore-clean gitignore gitignore-recurse gitignore-recurse-maybe