diff mbox

[COMMIT] Add a .gitattributes file for use with git-merge-changelog

Message ID 87r4195ag3.fsf_-_@naesten.mooo.com
State Committed
Headers show

Commit Message

Samuel Bronson July 25, 2014, 10:40 p.m. UTC
Individual users will still have to:

 1. Install git-merge-changelog

 2. Set up the merge driver in their git config

See gnulib's lib/git-merge-changelog.c [1] for details.

For example, I:

 1. Patched Debian's gnulib package to build git-merge-changelog, and
    sent the patch to the Debian maintainer, who then proceeded to not
    only accept my patch but even write a *manpage* for
    git-merge-changelog! (Let's hear it for Ian Beckwith.)

    So now, I can install it simply by running "apt-get install
    git-merge-changelog".  (Except, of course, that I already have it
    installed from when I was testing my patch.)

 2. Did step (2) from .gitattributes

With this patch applied and the above two steps done by whatever means
you deem best, you can say goodbye to merge conflicts in ChangeLog
files -- at least *IF* people stop renaming the danged things, anyway.

If you don't do step 2, you will continue to suffer from ChangeLog
merge conflicts exactly as before, whether or not you did step 1.

If you do step 2 but not step 1, git will likely start complaining
that it can't find any "git-merge-changelog" to run.

[1]: http://git.savannah.gnu.org/gitweb/?p=gnulib.git;a=blob;f=lib/git-merge-changelog.c

[Note: The docs for git-merge-changelog (the comments at the top) say
that you need a .gitattributes in every directory.  The docs are wrong.
Ignore the docs.  Well, not the whole docs; just that part.

You really only need one at the top level, since .gitattributes uses
the same pattern matching rules as .gitignore, which match files in
any subdirectory unless you prefix the pattern with a "/", as
explained in the gitignore(5) manpage.]
 .gitattributes | 20 ++++++++++++++++++++
 ChangeLog      |  4 ++++
 2 files changed, 24 insertions(+)
 create mode 100644 .gitattributes
diff mbox


diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..06d51d2
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,20 @@ 
+# -*- conf -*-
+## Set merge driver for ChangeLog files 
+# See gnulib's lib/git-merge-changelog.c (or git-merge-changelog(1))
+# for per-user setup instructions.
+# The short version of this (optional) procedure is:
+# (1) Install git-merge-changelog (this is the tricky part!)
+# (2) Add something like the following to your ~/.gitconfig:
+# [merge "merge-changelog"]
+#         name = GNU-style ChangeLog merge driver
+#         driver = git-merge-changelog %O %A %B
+# (3) Enjoy mostly effortless ChangeLog merges, at least until the
+#     file gets renamed again ...
+ChangeLog       merge=merge-changelog
diff --git a/ChangeLog b/ChangeLog
index 16047d3..5c8fe15 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@ 
+2014-07-25  Samuel Bronson  <naesten@gmail.com>
+	* .gitattributes: New file for use with git-merge-changelog.
 2014-07-21  Joel Sherrill  <joel.sherrill@oarcorp.com>
 	Disable gdb for or1k*-*-* until supported