[RFC PATCH] implement sample post-checkout hook to checkout new/unchanged submodules

From: Heiko Voigt <hvoigt@hvoigt.net>
Date: Oct 14, 2009, 20:12 UTC
Message-ID: <20091014201257.GA5788@book.hvoigt.net>
In-Reply-To: <4AD5F0B1.4000507@web.de>

Currently gits default behaviour is not to recursively update submodules when they are unchanged in the working copy. This hook implements this by comparing whether the current HEAD in the submodule is the same as recorded in the commit we are coming from. It then initializes or updates the submodule as necessary.

Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net>
---

On Wed, Oct 14, 2009 at 05:39:29PM +0200, Jens Lehmann wrote:

Show 17 quoted lines

> Peter Krefting schrieb:
> > Jens Lehmann:
> > 
> >> just calling "git submodule update" every time you want the submodule
> >> to be updated according to the state committed in the superproject
> >> will do the trick (but keep in mind that all referenced commits have
> >> to be accessible in the local clone of your submodule, so you might
> >> have to do a fetch there once in a while).
> 
> BTW: unless you use the -N or --no-fetch option, git submodule update
> will do the fetch for you.
> 
> 
> > Is it possible to automate this from a hook or something else?
> 
> Yep, you can use the post-checkout hook for that, just put a "git
> submodule update" in it.

Incidentially I have just been working on such a hook. Here is a patch that implements it as a sample hook.

I tested most cases, but I have not worked with it productively so it might have strange results in some cases. One I already found is that post-checkout is not called after a merge so you need to add a submodule update there as well.

cheers Heiko

 templates/hooks--post-checkout.sample |   50 +++++++++++++++++++++++++++++++++
 1 files changed, 50 insertions(+), 0 deletions(-)
 create mode 100644 templates/hooks--post-checkout.sample

diff --git a/templates/hooks--post-checkout.sample b/templates/hooks--post-checkout.sample
new file mode 100644
index 0000000..9ffffa0
--- /dev/null
+++ b/templates/hooks--post-checkout.sample
@@ -0,0 +1,50 @@
+#!/bin/sh
+
+# if this is a file checkout we do nothing
+flag=$3
+if [ ! $flag ]
+then
+	exit 0
+fi
+
+# if this is the initial checkout also intialize submodules
+if [ $1 == "0000000000000000000000000000000000000000" ]; then
+	git submodule init
+	git submodule update
+	# after initial checkout we are done now
+	exit 0
+fi
+
+# update all submodules that where not modified beforehand
+# or did not exist
+prev_sha1=$1
+new_sha1=$2
+
+git ls-tree $new_sha1 | grep ^160000 |cut -f2 |
+while read submodule
+do
+	prev_submodule_sha1=$(git ls-tree $prev_sha1 |
+		grep "	$submodule$" | cut -f1 | cut -d' ' -f3)
+	curr_submodule_sha1=$(cd "$submodule"; git rev-parse HEAD \
+		2>/dev/null)
+
+	if [ -z "$prev_submodule_sha1" ]
+	then
+		git submodule init "$submodule"
+		git submodule update "$submodule"
+		continue
+	fi
+
+	if [ "$prev_submodule_sha1" = "$curr_submodule_sha1" ]
+	then
+		if [ -z "$(git config submodule."$submodule".url)" ]
+		then
+			git submodule init "$submodule"
+		fi
+
+		if [ "$(git diff $prev_sha1 $new_sha1 -- "$submodule")" ]
+		then
+			git submodule update "$submodule"
+		fi
+	fi
+done

-- 
1.6.5.rc1.12.gc72fe