[git.mk] Document

diff --git a/Makefile.am b/Makefile.am
index fb96351..a440d4f 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -53,6 +53,8 @@ MAINTAINERCLEANFILES = \
        $(srcdir)/ChangeLog \
        `find "$(srcdir)" -type f -name Makefile.in -print`
 
+### ChangeLog generation
+
 ChangeLog: $(srcdir)/ChangeLog
 $(srcdir)/ChangeLog:
        @echo Creating $@
@@ -69,6 +71,7 @@ $(srcdir)/ChangeLog:
        fi
 .PHONY: $(srcdir)/ChangeLog
 
+
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = pango.pc
 

diff --git a/git.mk b/git.mk
index 773b5d1..e6606bc 100644 (file)
--- a/git.mk
+++ b/git.mk
@@ -1,7 +1,21 @@
+# git.mk
+#
+# Copyright 2009 Red Hat, Inc.
+# Written by Behdad Esfahbod
+#
+# 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.
+#
+# This enables automatic .gitignore generation.  If you need to ignore
+# more files, add them to the GITIGNOREFILES variable in your Makefile.am.
+# Note that for files like editor backup, etc, there are better places to
+# ignore them.  See "man gitignore".
+#
 
-git-all: gitignore-install
+git-all: git-mk-install
 
-gitignore-install:
+git-mk-install:
        @echo Installing git makefile
        @any_failed=; find $(top_srcdir) -name Makefile.am | while read x; do \
                if grep 'include .*/git.mk' $$x >/dev/null; then \
@@ -22,6 +36,9 @@ gitignore-install:
                        fi; \
        fi; done; test x$$any_failed = x
 
+
+### .gitignore generation
+
 .gitignore: Makefile.am $(top_srcdir)/git.mk
        @echo Generating $@
        @GTKDOCIGNOREFILES=; test "x$(DOC_MODULE)" = x || \
@@ -70,3 +87,4 @@ maintainer-clean-local: gitignore-clean
 gitignore-clean:
        rm -f .gitignore
 .PHONY: gitignore-clean
+