From 81c2c3bfec32f0a83abe6b938db11418d71a22db Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Fri, 30 Mar 2012 02:43:26 +0200 Subject: build-sys: use git.mk to generate gitignore This makefile is just fantastic, it forces you into good practices, support various build targets (my windows builddir ignore the right files etc..) The more I use it, the more I like it. --- .gitignore | 40 --------- Makefile.am | 24 ++++-- configure.ac | 1 + data/Makefile.am | 2 + git.mk | 212 ++++++++++++++++++++++++++++++++++++++++++++++ icons/16x16/Makefile.am | 2 + icons/22x22/Makefile.am | 2 + icons/24x24/Makefile.am | 2 + icons/256x256/Makefile.am | 2 + icons/32x32/Makefile.am | 2 + icons/48x48/Makefile.am | 2 + icons/Makefile.am | 2 + m4/.gitignore | 0 man/Makefile.am | 2 + plugin/Makefile.am | 2 + src/Makefile.am | 2 + 16 files changed, 254 insertions(+), 45 deletions(-) delete mode 100644 .gitignore create mode 100644 git.mk create mode 100644 m4/.gitignore diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 59219bb..0000000 --- a/.gitignore +++ /dev/null @@ -1,40 +0,0 @@ -po/*.gmo -m4/*.m4 -Makefile -Makefile.in -Makefile.in.in -*~ -aclocal.m4 -autom4te.cache/ -compile -config.guess -config.h -config.h.in -config.log -config.status -config.sub -configure -depcomp -install-sh -libtool -ltmain.sh -man/*.1 -*.spec -missing -.deps/ -.libs -src/remote-viewer -src/virt-viewer -po/POTFILES -po/stamp-it -*.o -*.lo -*.orig -*/.#* -*/#*# -stamp-h1 -INSTALL -*.lo -*.la -data/virt-viewer.nsis -build/ diff --git a/Makefile.am b/Makefile.am index 4792b42..f307c06 100644 --- a/Makefile.am +++ b/Makefile.am @@ -25,11 +25,23 @@ DISTCLEAN_FILES = \ $(NULL) MAINTAINERCLEANFILES = \ - m4/libtool.m4 \ - m4/ltoptions.m4 \ - m4/ltsugar.m4 \ - m4/ltversion.m4 \ - m4/lt~obsolete.m4 \ + $(srcdir)/INSTALL \ + $(srcdir)/aclocal.m4 \ + $(srcdir)/autoscan.log \ + $(srcdir)/config.h.in \ + $(srcdir)/build-aux/compile \ + $(srcdir)/build-aux/config.guess \ + $(srcdir)/build-aux/config.sub \ + $(srcdir)/build-aux/depcomp \ + $(srcdir)/build-aux/install-sh \ + $(srcdir)/build-aux/ltmain.sh \ + $(srcdir)/build-aux/missing \ + $(srcdir)/m4/intltool.m4 \ + $(srcdir)/m4/libtool.m4 \ + $(srcdir)/m4/ltoptions.m4 \ + $(srcdir)/m4/ltsugar.m4 \ + $(srcdir)/m4/ltversion.m4 \ + $(srcdir)/m4/lt~obsolete.m4 \ $(NULL) dist-hook: gen-ChangeLog @@ -44,3 +56,5 @@ gen-ChangeLog: rm -f $(distdir)/ChangeLog; \ mv $(distdir)/cl-t $(distdir)/ChangeLog; \ fi + +-include $(top_srcdir)/git.mk diff --git a/configure.ac b/configure.ac index 9276334..d35e887 100644 --- a/configure.ac +++ b/configure.ac @@ -2,6 +2,7 @@ AC_INIT(virt-viewer, 0.5.2) AC_CONFIG_SRCDIR(src/virt-viewer-main.c) AC_CONFIG_MACRO_DIR([m4]) +AC_CONFIG_AUX_DIR([build-aux]) AM_CONFIG_HEADER(config.h) dnl Make automake keep quiet about wildcards & other GNUmake-isms AM_INIT_AUTOMAKE([-Wno-portability]) diff --git a/data/Makefile.am b/data/Makefile.am index 50c9571..ea2bb0a 100644 --- a/data/Makefile.am +++ b/data/Makefile.am @@ -4,3 +4,5 @@ EXTRA_DIST = \ spice-xpi-client-remote-viewer \ virt-viewer.nsis.in \ $(NULL) + +-include $(top_srcdir)/git.mk diff --git a/git.mk b/git.mk new file mode 100644 index 0000000..8aebb8d --- /dev/null +++ b/git.mk @@ -0,0 +1,212 @@ +# git.mk +# +# Copyright 2009, Red Hat, Inc. +# Copyright 2010,2011 Behdad Esfahbod +# Written by Behdad Esfahbod +# +# Copying and distribution of this file, with or without modification, +# is permitted in any medium without royalty provided the copyright +# notice and this notice are preserved. +# +# The canonical source for this file is https://github.com/behdad/git.mk. +# +# 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 +# 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". +# +# 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, +# or maintainer-clean-local make targets. +# +# 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 +# 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 +# the directories involved and I'll diagnose. +# +# For a list of toplevel files that should be in MAINTAINERCLEANFILES, see +# Makefile.am.sample in the git.mk git repo. +# +# 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. +# +# This file knows how to handle autoconf, automake, libtool, gtk-doc, +# gnome-doc-utils, yelp.m4, mallard, intltool, gsettings, dejagnu. +# +# +# 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. +# + +git-all: git-mk-install + +git-mk-install: + @echo Installing git makefile + @any_failed=; \ + find "`test -z "$(top_srcdir)" && echo . || echo "$(top_srcdir)"`" -name Makefile.am | while read x; do \ + if grep 'include .*/git.mk' $$x >/dev/null; then \ + echo $$x already includes git.mk; \ + 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 \ + echo Failed updating $$x; >&2 \ + any_failed=1; \ + fi; \ + fi; done; test -z "$$any_failed" + +.PHONY: git-all git-mk-install + + +### .gitignore generation + +$(srcdir)/.gitignore: Makefile.am $(top_srcdir)/git.mk + $(AM_V_GEN) \ + { \ + 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 \ + ; do echo /$$x; done; \ + fi; \ + if test "x$(DOC_MODULE)$(DOC_ID)" = x -o "x$(DOC_LINGUAS)" = x; then :; else \ + for x in \ + $(_DOC_C_DOCS) \ + $(_DOC_LC_DOCS) \ + $(_DOC_OMF_ALL) \ + $(_DOC_DSK_ALL) \ + $(_DOC_HTML_ALL) \ + $(_DOC_MOFILES) \ + $(_DOC_POFILES) \ + $(DOC_H_FILE) \ + "*/.xml2po.mo" \ + "*/*.omf.out" \ + ; do echo /$$x; done; \ + fi; \ + if test "x$(HELP_ID)" = x -o "x$(HELP_LINGUAS)" = x; then :; else \ + for x in \ + $(_HELP_LC_FILES) \ + $(_HELP_LC_STAMPS) \ + $(_HELP_MOFILES) \ + ; do echo /$$x; 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; \ + if test -f $(srcdir)/po/Makefile.in.in; then \ + for x in \ + po/Makefile.in.in \ + po/Makefile.in \ + po/Makefile \ + po/POTFILES \ + po/stamp-it \ + po/.intltool-merge-cache \ + "po/*.gmo" \ + "po/*.mo" \ + po/$(GETTEXT_PACKAGE).pot \ + intltool-extract.in \ + intltool-merge.in \ + intltool-update.in \ + ; do echo /$$x; done; \ + fi; \ + if test -f $(srcdir)/configure; then \ + for x in \ + autom4te.cache \ + configure \ + config.h \ + stamp-h1 \ + libtool \ + config.lt \ + ; 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; \ + for x in \ + .gitignore \ + $(GITIGNOREFILES) \ + $(CLEANFILES) \ + $(PROGRAMS) \ + $(check_PROGRAMS) \ + $(EXTRA_PROGRAMS) \ + $(LTLIBRARIES) \ + so_locations \ + .libs _libs \ + $(MOSTLYCLEANFILES) \ + "*.$(OBJEXT)" \ + "*.lo" \ + $(DISTCLEANFILES) \ + $(am__CONFIG_DISTCLEAN_FILES) \ + $(CONFIG_CLEAN_FILES) \ + TAGS ID GTAGS GRTAGS GSYMS GPATH tags \ + "*.tab.c" \ + $(MAINTAINERCLEANFILES) \ + $(BUILT_SOURCES) \ + $(DEPDIR) \ + Makefile \ + Makefile.in \ + "*.orig" \ + "*.rej" \ + "*.bak" \ + "*~" \ + ".*.sw[nop]" \ + ".dirstamp" \ + ; do echo /$$x; done; \ + } | \ + sed "s@^/`echo "$(srcdir)" | sed 's/\(.\)/[\1]/g'`/@/@" | \ + sed 's@/[.]/@/@g' | \ + LC_ALL=C sort | uniq > $@.tmp && \ + mv $@.tmp $@; + +all: $(srcdir)/.gitignore gitignore-recurse-maybe +gitignore-recurse-maybe: + @if test "x$(SUBDIRS)" = "x$(DIST_SUBDIRS)"; then :; else \ + $(MAKE) $(AM_MAKEFLAGS) gitignore-recurse; \ + fi; +gitignore-recurse: + @for subdir in $(DIST_SUBDIRS); do \ + case " $(SUBDIRS) " in \ + *" $$subdir "*) :;; \ + *) test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) .gitignore gitignore-recurse || echo "Skipping $$subdir");; \ + esac; \ + done +gitignore: $(srcdir)/.gitignore gitignore-recurse + +maintainer-clean: gitignore-clean +gitignore-clean: + -rm -f $(srcdir)/.gitignore + +.PHONY: gitignore-clean gitignore gitignore-recurse gitignore-recurse-maybe diff --git a/icons/16x16/Makefile.am b/icons/16x16/Makefile.am index 355b4d1..ba7d6aa 100644 --- a/icons/16x16/Makefile.am +++ b/icons/16x16/Makefile.am @@ -3,3 +3,5 @@ icondir = $(datadir)/icons/hicolor/$(size)/apps/ icon_DATA = $(PACKAGE).png EXTRA_DIST = $(icon_DATA) + +-include $(top_srcdir)/git.mk diff --git a/icons/22x22/Makefile.am b/icons/22x22/Makefile.am index 355b4d1..ba7d6aa 100644 --- a/icons/22x22/Makefile.am +++ b/icons/22x22/Makefile.am @@ -3,3 +3,5 @@ icondir = $(datadir)/icons/hicolor/$(size)/apps/ icon_DATA = $(PACKAGE).png EXTRA_DIST = $(icon_DATA) + +-include $(top_srcdir)/git.mk diff --git a/icons/24x24/Makefile.am b/icons/24x24/Makefile.am index 355b4d1..ba7d6aa 100644 --- a/icons/24x24/Makefile.am +++ b/icons/24x24/Makefile.am @@ -3,3 +3,5 @@ icondir = $(datadir)/icons/hicolor/$(size)/apps/ icon_DATA = $(PACKAGE).png EXTRA_DIST = $(icon_DATA) + +-include $(top_srcdir)/git.mk diff --git a/icons/256x256/Makefile.am b/icons/256x256/Makefile.am index 355b4d1..ba7d6aa 100644 --- a/icons/256x256/Makefile.am +++ b/icons/256x256/Makefile.am @@ -3,3 +3,5 @@ icondir = $(datadir)/icons/hicolor/$(size)/apps/ icon_DATA = $(PACKAGE).png EXTRA_DIST = $(icon_DATA) + +-include $(top_srcdir)/git.mk diff --git a/icons/32x32/Makefile.am b/icons/32x32/Makefile.am index 355b4d1..ba7d6aa 100644 --- a/icons/32x32/Makefile.am +++ b/icons/32x32/Makefile.am @@ -3,3 +3,5 @@ icondir = $(datadir)/icons/hicolor/$(size)/apps/ icon_DATA = $(PACKAGE).png EXTRA_DIST = $(icon_DATA) + +-include $(top_srcdir)/git.mk diff --git a/icons/48x48/Makefile.am b/icons/48x48/Makefile.am index 355b4d1..ba7d6aa 100644 --- a/icons/48x48/Makefile.am +++ b/icons/48x48/Makefile.am @@ -3,3 +3,5 @@ icondir = $(datadir)/icons/hicolor/$(size)/apps/ icon_DATA = $(PACKAGE).png EXTRA_DIST = $(icon_DATA) + +-include $(top_srcdir)/git.mk diff --git a/icons/Makefile.am b/icons/Makefile.am index cf355ff..699d36d 100644 --- a/icons/Makefile.am +++ b/icons/Makefile.am @@ -10,3 +10,5 @@ ico_sizes = 16 32 48 256 $(AM_V_GEN)$(ICOTOOL) -c -o $@ $^ CLEANFILES = virt-viewer.ico + +-include $(top_srcdir)/git.mk diff --git a/m4/.gitignore b/m4/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/man/Makefile.am b/man/Makefile.am index 09ca502..d6f709c 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -14,3 +14,5 @@ DISTCLEANFILES = $(man_MANS) %.1: %.pod pod2man $< > $@ + +-include $(top_srcdir)/git.mk diff --git a/plugin/Makefile.am b/plugin/Makefile.am index 9c00853..2c1e38c 100644 --- a/plugin/Makefile.am +++ b/plugin/Makefile.am @@ -40,3 +40,5 @@ install-data-hook: CLEANFILES = virt-viewer-plugin.so endif + +-include $(top_srcdir)/git.mk diff --git a/src/Makefile.am b/src/Makefile.am index 5349c17..ba0a8bf 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -122,3 +122,5 @@ virt-viewer_rc.$(OBJEXT): $(VIRT_VIEWER_RES) $(top_builddir)/icons/virt-viewer.i LDADD += virt-viewer_rc.$(OBJEXT) MAINTAINERCLEANFILES += virt-viewer_rc.$(OBJEXT) endif + +-include $(top_srcdir)/git.mk -- cgit