[thirdparty/git.git] / git-submodule.sh

#!/bin/sh
#
# git-submodules.sh: add, init, update or list git submodules
#
# Copyright (c) 2007 Lars Hjemli

USAGE="[--quiet] [--cached] \
[add [-b branch] <repo> <path>]|[status|init|update [-i|--init] [-N|--no-fetch]|summary [-n|--summary-limit <n>] [<commit>]] \
[--] [<path>...]|[foreach <command>]|[sync [--] [<path>...]]"
OPTIONS_SPEC=
. git-sh-setup
. git-parse-remote
require_work_tree

command=
branch=
quiet=
cached=
nofetch=

#
# print stuff on stdout unless -q was specified
#
say()
{
	if test -z "$quiet"
	then
		echo "$@"
	fi
}

# Resolve relative url by appending to parent's url
resolve_relative_url ()
{
	remote=$(get_default_remote)
	remoteurl=$(git config "remote.$remote.url") ||
		die "remote ($remote) does not have a url defined in .git/config"
	url="$1"
	remoteurl=${remoteurl%/}
	while test -n "$url"
	do
		case "$url" in
		../*)
			url="${url#../}"
			remoteurl="${remoteurl%/*}"
			;;
		./*)
			url="${url#./}"
			;;
		*)
			break;;
		esac
	done
	echo "$remoteurl/${url%/}"
}

#
# Get submodule info for registered submodules
# $@ = path to limit submodule list
#
module_list()
{
	git ls-files --error-unmatch --stage -- "$@" | grep '^160000 '
}

#
# Map submodule path to submodule name
#
# $1 = path
#
module_name()
{
	# Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
	re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
	name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
		sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
       test -z "$name" &&
       die "No submodule mapping found in .gitmodules for path '$path'"
       echo "$name"
}

#
# Clone a submodule
#
# Prior to calling, cmd_update checks that a possibly existing
# path is not a git repository.
# Likewise, cmd_add checks that path does not exist at all,
# since it is the location of a new submodule.
#
module_clone()
{
	path=$1
	url=$2

	# If there already is a directory at the submodule path,
	# expect it to be empty (since that is the default checkout
	# action) and try to remove it.
	# Note: if $path is a symlink to a directory the test will
	# succeed but the rmdir will fail. We might want to fix this.
	if test -d "$path"
	then
		rmdir "$path" 2>/dev/null ||
		die "Directory '$path' exist, but is neither empty nor a git repository"
	fi

	test -e "$path" &&
	die "A file already exist at path '$path'"

	git-clone -n "$url" "$path" ||
	die "Clone of '$url' into submodule path '$path' failed"
}

#
# Add a new submodule to the working tree, .gitmodules and the index
#
# $@ = repo path
#
# optional branch is stored in global branch variable
#
cmd_add()
{
	# parse $args after "submodule ... add".
	while test $# -ne 0
	do
		case "$1" in
		-b | --branch)
			case "$2" in '') usage ;; esac
			branch=$2
			shift
			;;
		-q|--quiet)
			quiet=1
			;;
		--)
			shift
			break
			;;
		-*)
			usage
			;;
		*)
			break
			;;
		esac
		shift
	done

	repo=$1
	path=$2

	if test -z "$repo" -o -z "$path"; then
		usage
	fi

	# assure repo is absolute or relative to parent
	case "$repo" in
	./*|../*)
		# dereference source url relative to parent's url
		realrepo=$(resolve_relative_url "$repo") || exit
		;;
	*:*|/*)
		# absolute url
		realrepo=$repo
		;;
	*)
		die "repo URL: '$repo' must be absolute or begin with ./|../"
	;;
	esac

	# normalize path:
	# multiple //; leading ./; /./; /../; trailing /
	path=$(printf '%s/\n' "$path" |
		sed -e '
			s|//*|/|g
			s|^\(\./\)*||
			s|/\./|/|g
			:start
			s|\([^/]*\)/\.\./||
			tstart
			s|/*$||
		')
	git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
	die "'$path' already exists in the index"

	# perhaps the path exists and is already a git repo, else clone it
	if test -e "$path"
	then
		if test -d "$path"/.git -o -f "$path"/.git
		then
			echo "Adding existing repo at '$path' to the index"
		else
			die "'$path' already exists and is not a valid git repo"
		fi

		case "$repo" in
		./*|../*)
			url=$(resolve_relative_url "$repo") || exit
		    ;;
		*)
			url="$repo"
			;;
		esac
		git config submodule."$path".url "$url"
	else

		module_clone "$path" "$realrepo" || exit
		(unset GIT_DIR; cd "$path" && git checkout -f -q ${branch:+-b "$branch" "origin/$branch"}) ||
		die "Unable to checkout submodule '$path'"
	fi

	git add "$path" ||
	die "Failed to add submodule '$path'"

	git config -f .gitmodules submodule."$path".path "$path" &&
	git config -f .gitmodules submodule."$path".url "$repo" &&
	git add .gitmodules ||
	die "Failed to register submodule '$path'"
}

#
# Execute an arbitrary command sequence in each checked out
# submodule
#
# $@ = command to execute
#
cmd_foreach()
{
	module_list |
	while read mode sha1 stage path
	do
		if test -e "$path"/.git
		then
			say "Entering '$path'"
			(cd "$path" && eval "$@") ||
			die "Stopping at '$path'; script returned non-zero status."
		fi
	done
}

#
# Register submodules in .git/config
#
# $@ = requested paths (default to all)
#
cmd_init()
{
	# parse $args after "submodule ... init".
	while test $# -ne 0
	do
		case "$1" in
		-q|--quiet)
			quiet=1
			;;
		--)
			shift
			break
			;;
		-*)
			usage
			;;
		*)
			break
			;;
		esac
		shift
	done

	module_list "$@" |
	while read mode sha1 stage path
	do
		# Skip already registered paths
		name=$(module_name "$path") || exit
		url=$(git config submodule."$name".url)
		test -z "$url" || continue

		url=$(git config -f .gitmodules submodule."$name".url)
		test -z "$url" &&
		die "No url found for submodule path '$path' in .gitmodules"

		# Possibly a url relative to parent
		case "$url" in
		./*|../*)
			url=$(resolve_relative_url "$url") || exit
			;;
		esac

		git config submodule."$name".url "$url" ||
		die "Failed to register url for submodule path '$path'"

		say "Submodule '$name' ($url) registered for path '$path'"
	done
}

#
# Update each submodule path to correct revision, using clone and checkout as needed
#
# $@ = requested paths (default to all)
#
cmd_update()
{
	# parse $args after "submodule ... update".
	while test $# -ne 0
	do
		case "$1" in
		-q|--quiet)
			shift
			quiet=1
			;;
		-i|--init)
			shift
			cmd_init "$@" || return
			;;
		-N|--no-fetch)
			shift
			nofetch=1
			;;
		--)
			shift
			break
			;;
		-*)
			usage
			;;
		*)
			break
			;;
		esac
	done

	module_list "$@" |
	while read mode sha1 stage path
	do
		name=$(module_name "$path") || exit
		url=$(git config submodule."$name".url)
		if test -z "$url"
		then
			# Only mention uninitialized submodules when its
			# path have been specified
			test "$#" != "0" &&
			say "Submodule path '$path' not initialized" &&
			say "Maybe you want to use 'update --init'?"
			continue
		fi

		if ! test -d "$path"/.git -o -f "$path"/.git
		then
			module_clone "$path" "$url" || exit
			subsha1=
		else
			subsha1=$(unset GIT_DIR; cd "$path" &&
				git rev-parse --verify HEAD) ||
			die "Unable to find current revision in submodule path '$path'"
		fi

		if test "$subsha1" != "$sha1"
		then
			force=
			if test -z "$subsha1"
			then
				force="-f"
			fi

			if test -z "$nofetch"
			then
				(unset GIT_DIR; cd "$path" &&
					git-fetch) ||
				die "Unable to fetch in submodule path '$path'"
			fi

			(unset GIT_DIR; cd "$path" &&
				  git-checkout $force -q "$sha1") ||
			die "Unable to checkout '$sha1' in submodule path '$path'"

			say "Submodule path '$path': checked out '$sha1'"
		fi
	done
}

set_name_rev () {
	revname=$( (
		unset GIT_DIR
		cd "$1" && {
			git describe "$2" 2>/dev/null ||
			git describe --tags "$2" 2>/dev/null ||
			git describe --contains "$2" 2>/dev/null ||
			git describe --all --always "$2"
		}
	) )
	test -z "$revname" || revname=" ($revname)"
}
#
# Show commit summary for submodules in index or working tree
#
# If '--cached' is given, show summary between index and given commit,
# or between working tree and given commit
#
# $@ = [commit (default 'HEAD'),] requested paths (default all)
#
cmd_summary() {
	summary_limit=-1
	for_status=

	# parse $args after "submodule ... summary".
	while test $# -ne 0
	do
		case "$1" in
		--cached)
			cached="$1"
			;;
		--for-status)
			for_status="$1"
			;;
		-n|--summary-limit)
			if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
			then
				:
			else
				usage
			fi
			shift
			;;
		--)
			shift
			break
			;;
		-*)
			usage
			;;
		*)
			break
			;;
		esac
		shift
	done

	test $summary_limit = 0 && return

	if rev=$(git rev-parse -q --verify "$1^0")
	then
		head=$rev
		shift
	else
		head=HEAD
	fi

	cd_to_toplevel
	# Get modified modules cared by user
	modules=$(git diff-index $cached --raw $head -- "$@" |
		egrep '^:([0-7]* )?160000' |
		while read mod_src mod_dst sha1_src sha1_dst status name
		do
			# Always show modules deleted or type-changed (blob<->module)
			test $status = D -o $status = T && echo "$name" && continue
			# Also show added or modified modules which are checked out
			GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
			echo "$name"
		done
	)

	test -z "$modules" && return

	git diff-index $cached --raw $head -- $modules |
	egrep '^:([0-7]* )?160000' |
	cut -c2- |
	while read mod_src mod_dst sha1_src sha1_dst status name
	do
		if test -z "$cached" &&
			test $sha1_dst = 0000000000000000000000000000000000000000
		then
			case "$mod_dst" in
			160000)
				sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
				;;
			100644 | 100755 | 120000)
				sha1_dst=$(git hash-object $name)
				;;
			000000)
				;; # removed
			*)
				# unexpected type
				echo >&2 "unexpected mode $mod_dst"
				continue ;;
			esac
		fi
		missing_src=
		missing_dst=

		test $mod_src = 160000 &&
		! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
		missing_src=t

		test $mod_dst = 160000 &&
		! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
		missing_dst=t

		total_commits=
		case "$missing_src,$missing_dst" in
		t,)
			errmsg="  Warn: $name doesn't contain commit $sha1_src"
			;;
		,t)
			errmsg="  Warn: $name doesn't contain commit $sha1_dst"
			;;
		t,t)
			errmsg="  Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
			;;
		*)
			errmsg=
			total_commits=$(
			if test $mod_src = 160000 -a $mod_dst = 160000
			then
				range="$sha1_src...$sha1_dst"
			elif test $mod_src = 160000
			then
				range=$sha1_src
			else
				range=$sha1_dst
			fi
			GIT_DIR="$name/.git" \
			git log --pretty=oneline --first-parent $range | wc -l
			)
			total_commits=" ($(($total_commits + 0)))"
			;;
		esac

		sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
		sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
		if test $status = T
		then
			if test $mod_dst = 160000
			then
				echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
			else
				echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
			fi
		else
			echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
		fi
		if test -n "$errmsg"
		then
			# Don't give error msg for modification whose dst is not submodule
			# i.e. deleted or changed to blob
			test $mod_dst = 160000 && echo "$errmsg"
		else
			if test $mod_src = 160000 -a $mod_dst = 160000
			then
				limit=
				test $summary_limit -gt 0 && limit="-$summary_limit"
				GIT_DIR="$name/.git" \
				git log $limit --pretty='format:  %m %s' \
				--first-parent $sha1_src...$sha1_dst
			elif test $mod_dst = 160000
			then
				GIT_DIR="$name/.git" \
				git log --pretty='format:  > %s' -1 $sha1_dst
			else
				GIT_DIR="$name/.git" \
				git log --pretty='format:  < %s' -1 $sha1_src
			fi
			echo
		fi
		echo
	done |
	if test -n "$for_status"; then
		echo "# Modified submodules:"
		echo "#"
		sed -e 's|^|# |' -e 's|^# $|#|'
	else
		cat
	fi
}
#
# List all submodules, prefixed with:
#  - submodule not initialized
#  + different revision checked out
#
# If --cached was specified the revision in the index will be printed
# instead of the currently checked out revision.
#
# $@ = requested paths (default to all)
#
cmd_status()
{
	# parse $args after "submodule ... status".
	while test $# -ne 0
	do
		case "$1" in
		-q|--quiet)
			quiet=1
			;;
		--cached)
			cached=1
			;;
		--)
			shift
			break
			;;
		-*)
			usage
			;;
		*)
			break
			;;
		esac
		shift
	done

	module_list "$@" |
	while read mode sha1 stage path
	do
		name=$(module_name "$path") || exit
		url=$(git config submodule."$name".url)
		if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
		then
			say "-$sha1 $path"
			continue;
		fi
		set_name_rev "$path" "$sha1"
		if git diff-files --quiet -- "$path"
		then
			say " $sha1 $path$revname"
		else
			if test -z "$cached"
			then
				sha1=$(unset GIT_DIR; cd "$path" && git rev-parse --verify HEAD)
				set_name_rev "$path" "$sha1"
			fi
			say "+$sha1 $path$revname"
		fi
	done
}
#
# Sync remote urls for submodules
# This makes the value for remote.$remote.url match the value
# specified in .gitmodules.
#
cmd_sync()
{
	while test $# -ne 0
	do
		case "$1" in
		-q|--quiet)
			quiet=1
			shift
			;;
		--)
			shift
			break
			;;
		-*)
			usage
			;;
		*)
			break
			;;
		esac
	done
	cd_to_toplevel
	module_list "$@" |
	while read mode sha1 stage path
	do
		name=$(module_name "$path")
		url=$(git config -f .gitmodules --get submodule."$name".url)

		# Possibly a url relative to parent
		case "$url" in
		./*|../*)
			url=$(resolve_relative_url "$url") || exit
			;;
		esac

		if test -e "$path"/.git
		then
		(
			unset GIT_DIR
			cd "$path"
			remote=$(get_default_remote)
			say "Synchronizing submodule url for '$name'"
			git config remote."$remote".url "$url"
		)
		fi
	done
}

# This loop parses the command line arguments to find the
# subcommand name to dispatch.  Parsing of the subcommand specific
# options are primarily done by the subcommand implementations.
# Subcommand specific options such as --branch and --cached are
# parsed here as well, for backward compatibility.

while test $# != 0 && test -z "$command"
do
	case "$1" in
	add | foreach | init | update | status | summary | sync)
		command=$1
		;;
	-q|--quiet)
		quiet=1
		;;
	-b|--branch)
		case "$2" in
		'')
			usage
			;;
		esac
		branch="$2"; shift
		;;
	--cached)
		cached="$1"
		;;
	--)
		break
		;;
	-*)
		usage
		;;
	*)
		break
		;;
	esac
	shift
done

# No command word defaults to "status"
test -n "$command" || command=status

# "-b branch" is accepted only by "add"
if test -n "$branch" && test "$command" != add
then
	usage
fi

# "--cached" is accepted only by "status" and "summary"
if test -n "$cached" && test "$command" != status -a "$command" != summary
then
	usage
fi

"cmd_$command" "$@"
Commit	Line	Data
70c7ac22 LH	1	#!/bin/sh
70c7ac22 LH	2	#
ecda0723	3	# git-submodules.sh: add, init, update or list git submodules
70c7ac22 LH	4	#
	5	# Copyright (c) 2007 Lars Hjemli
	6
f2dc06a3	7	USAGE="[--quiet] [--cached] \
835a3eea	8	[add [-b branch] <repo> <path>]\|[status\|init\|update [-i\|--init] [-N\|--no-fetch]\|summary [-n\|--summary-limit <n>] [<commit>]] \
2327f61e	9	[--] [<path>...]\|[foreach <command>]\|[sync [--] [<path>...]]"
8f321a39	10	OPTIONS_SPEC=
70c7ac22	11	. git-sh-setup
98fcf840	12	. git-parse-remote
70c7ac22 LH	13	require_work_tree
70c7ac22 LH	14
5c08dbbd	15	command=
ecda0723	16	branch=
70c7ac22 LH	17	quiet=
70c7ac22 LH	18	cached=
31ca3ac3	19	nofetch=
70c7ac22 LH	20
	21	#
	22	# print stuff on stdout unless -q was specified
	23	#
	24	say()
	25	{
	26	if test -z "$quiet"
	27	then
	28	echo "$@"
	29	fi
	30	}
	31
f31a522a ML	32	# Resolve relative url by appending to parent's url
	33	resolve_relative_url ()
	34	{
98fcf840	35	remote=$(get_default_remote)
8e7e6f39 ML	36	remoteurl=$(git config "remote.$remote.url") \|\|
8e7e6f39 ML	37	die "remote ($remote) does not have a url defined in .git/config"
f31a522a	38	url="$1"
99b120af	39	remoteurl=${remoteurl%/}
f31a522a ML	40	while test -n "$url"
	41	do
	42	case "$url" in
	43	../*)
	44	url="${url#../}"
	45	remoteurl="${remoteurl%/*}"
	46	;;
	47	./*)
	48	url="${url#./}"
	49	;;
	50	*)
	51	break;;
	52	esac
	53	done
99b120af	54	echo "$remoteurl/${url%/}"
f31a522a ML	55	}
f31a522a ML	56
a7b3269c DA	57	#
	58	# Get submodule info for registered submodules
	59	# $@ = path to limit submodule list
	60	#
	61	module_list()
	62	{
496917b7	63	git ls-files --error-unmatch --stage -- "$@" \| grep '^160000 '
a7b3269c DA	64	}
a7b3269c DA	65
941987a5 LH	66	#
	67	# Map submodule path to submodule name
	68	#
	69	# $1 = path
	70	#
	71	module_name()
	72	{
537601ac	73	# Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
fe22e542	74	re=$(printf '%s\n' "$1" \| sed -e 's/[].[^$\\*]/\\&/g')
a5099bb4	75	name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' \|
537601ac	76	sed -n -e 's\|^submodule\.\(.*\)\.path '"$re"'$\|\1\|p' )
941987a5 LH	77	test -z "$name" &&
	78	die "No submodule mapping found in .gitmodules for path '$path'"
	79	echo "$name"
	80	}
33aa6fff LH	81
	82	#
	83	# Clone a submodule
	84	#
23a485e3	85	# Prior to calling, cmd_update checks that a possibly existing
ecda0723	86	# path is not a git repository.
23a485e3	87	# Likewise, cmd_add checks that path does not exist at all,
ecda0723 SV	88	# since it is the location of a new submodule.
ecda0723 SV	89	#
33aa6fff LH	90	module_clone()
	91	{
	92	path=$1
	93	url=$2
	94
	95	# If there already is a directory at the submodule path,
	96	# expect it to be empty (since that is the default checkout
	97	# action) and try to remove it.
	98	# Note: if $path is a symlink to a directory the test will
	99	# succeed but the rmdir will fail. We might want to fix this.
	100	if test -d "$path"
	101	then
	102	rmdir "$path" 2>/dev/null \|\|
	103	die "Directory '$path' exist, but is neither empty nor a git repository"
	104	fi
	105
	106	test -e "$path" &&
	107	die "A file already exist at path '$path'"
	108
	109	git-clone -n "$url" "$path" \|\|
941987a5	110	die "Clone of '$url' into submodule path '$path' failed"
33aa6fff LH	111	}
33aa6fff LH	112
ecda0723 SV	113	#
	114	# Add a new submodule to the working tree, .gitmodules and the index
	115	#
ec05df35	116	# $@ = repo path
ecda0723 SV	117	#
	118	# optional branch is stored in global branch variable
	119	#
23a485e3	120	cmd_add()
ecda0723	121	{
5c08dbbd JH	122	# parse $args after "submodule ... add".
	123	while test $# -ne 0
	124	do
	125	case "$1" in
	126	-b \| --branch)
	127	case "$2" in '') usage ;; esac
	128	branch=$2
	129	shift
	130	;;
	131	-q\|--quiet)
	132	quiet=1
	133	;;
	134	--)
	135	shift
	136	break
	137	;;
	138	-*)
	139	usage
	140	;;
	141	*)
	142	break
	143	;;
	144	esac
	145	shift
	146	done
	147
ecda0723 SV	148	repo=$1
	149	path=$2
	150
ec05df35	151	if test -z "$repo" -o -z "$path"; then
ecda0723 SV	152	usage
	153	fi
	154
ec05df35 ML	155	# assure repo is absolute or relative to parent
	156	case "$repo" in
	157	./\|../)
	158	# dereference source url relative to parent's url
	159	realrepo=$(resolve_relative_url "$repo") \|\| exit
	160	;;
	161	:\|/*)
	162	# absolute url
	163	realrepo=$repo
	164	;;
	165	*)
	166	die "repo URL: '$repo' must be absolute or begin with ./\|../"
	167	;;
	168	esac
	169
db75ada5 MG	170	# normalize path:
	171	# multiple //; leading ./; /./; /../; trailing /
	172	path=$(printf '%s/\n' "$path" \|
	173	sed -e '
	174	s\|//*\|/\|g
	175	s\|^\(\./\)*\|\|
	176	s\|/\./\|/\|g
	177	:start
	178	s\|\([^/]*\)/\.\./\|\|
	179	tstart
	180	s\|/*$\|\|
	181	')
5be60078	182	git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
ecda0723 SV	183	die "'$path' already exists in the index"
ecda0723 SV	184
d4264ca3 ML	185	# perhaps the path exists and is already a git repo, else clone it
	186	if test -e "$path"
	187	then
e9656473	188	if test -d "$path"/.git -o -f "$path"/.git
d4264ca3 ML	189	then
	190	echo "Adding existing repo at '$path' to the index"
	191	else
	192	die "'$path' already exists and is not a valid git repo"
	193	fi
c2f93917 ML	194
	195	case "$repo" in
	196	./\|../)
	197	url=$(resolve_relative_url "$repo") \|\| exit
	198	;;
	199	*)
	200	url="$repo"
	201	;;
	202	esac
	203	git config submodule."$path".url "$url"
d4264ca3	204	else
d4264ca3 ML	205
d4264ca3 ML	206	module_clone "$path" "$realrepo" \|\| exit
b9b378a0	207	(unset GIT_DIR; cd "$path" && git checkout -f -q ${branch:+-b "$branch" "origin/$branch"}) \|\|
d4264ca3 ML	208	die "Unable to checkout submodule '$path'"
	209	fi
	210
ecda0723 SV	211	git add "$path" \|\|
	212	die "Failed to add submodule '$path'"
	213
a5099bb4 IY	214	git config -f .gitmodules submodule."$path".path "$path" &&
a5099bb4 IY	215	git config -f .gitmodules submodule."$path".url "$repo" &&
ecda0723 SV	216	git add .gitmodules \|\|
	217	die "Failed to register submodule '$path'"
	218	}
	219
19a31f9c ML	220	#
	221	# Execute an arbitrary command sequence in each checked out
	222	# submodule
	223	#
	224	# $@ = command to execute
	225	#
	226	cmd_foreach()
	227	{
a7b3269c	228	module_list \|
19a31f9c ML	229	while read mode sha1 stage path
	230	do
	231	if test -e "$path"/.git
	232	then
	233	say "Entering '$path'"
	234	(cd "$path" && eval "$@") \|\|
	235	die "Stopping at '$path'; script returned non-zero status."
	236	fi
	237	done
	238	}
	239
70c7ac22	240	#
211b7f19	241	# Register submodules in .git/config
70c7ac22 LH	242	#
	243	# $@ = requested paths (default to all)
	244	#
23a485e3	245	cmd_init()
70c7ac22	246	{
5c08dbbd JH	247	# parse $args after "submodule ... init".
	248	while test $# -ne 0
	249	do
	250	case "$1" in
	251	-q\|--quiet)
	252	quiet=1
	253	;;
	254	--)
	255	shift
	256	break
	257	;;
	258	-*)
	259	usage
	260	;;
	261	*)
	262	break
	263	;;
	264	esac
	265	shift
	266	done
	267
a7b3269c	268	module_list "$@" \|
70c7ac22 LH	269	while read mode sha1 stage path
70c7ac22 LH	270	do
211b7f19	271	# Skip already registered paths
941987a5	272	name=$(module_name "$path") \|\| exit
5be60078	273	url=$(git config submodule."$name".url)
211b7f19	274	test -z "$url" \|\| continue
70c7ac22	275
a5099bb4	276	url=$(git config -f .gitmodules submodule."$name".url)
70c7ac22	277	test -z "$url" &&
941987a5	278	die "No url found for submodule path '$path' in .gitmodules"
70c7ac22	279
f31a522a ML	280	# Possibly a url relative to parent
	281	case "$url" in
	282	./\|../)
8e7e6f39	283	url=$(resolve_relative_url "$url") \|\| exit
f31a522a ML	284	;;
	285	esac
	286
5be60078	287	git config submodule."$name".url "$url" \|\|
941987a5	288	die "Failed to register url for submodule path '$path'"
70c7ac22	289
941987a5	290	say "Submodule '$name' ($url) registered for path '$path'"
70c7ac22 LH	291	done
	292	}
	293
	294	#
211b7f19	295	# Update each submodule path to correct revision, using clone and checkout as needed
70c7ac22 LH	296	#
	297	# $@ = requested paths (default to all)
	298	#
23a485e3	299	cmd_update()
70c7ac22	300	{
5c08dbbd JH	301	# parse $args after "submodule ... update".
	302	while test $# -ne 0
	303	do
	304	case "$1" in
	305	-q\|--quiet)
d1f63a37	306	shift
5c08dbbd JH	307	quiet=1
5c08dbbd JH	308	;;
be4d2c83 JS	309	-i\|--init)
	310	shift
	311	cmd_init "$@" \|\| return
	312	;;
31ca3ac3 FF	313	-N\|--no-fetch)
	314	shift
	315	nofetch=1
	316	;;
5c08dbbd JH	317	--)
	318	shift
	319	break
	320	;;
	321	-*)
	322	usage
	323	;;
	324	*)
	325	break
	326	;;
	327	esac
5c08dbbd JH	328	done
5c08dbbd JH	329
a7b3269c	330	module_list "$@" \|
70c7ac22 LH	331	while read mode sha1 stage path
70c7ac22 LH	332	do
941987a5	333	name=$(module_name "$path") \|\| exit
5be60078	334	url=$(git config submodule."$name".url)
211b7f19	335	if test -z "$url"
70c7ac22 LH	336	then
	337	# Only mention uninitialized submodules when its
	338	# path have been specified
	339	test "$#" != "0" &&
989206f5	340	say "Submodule path '$path' not initialized" &&
be4d2c83	341	say "Maybe you want to use 'update --init'?"
211b7f19 LH	342	continue
	343	fi
	344
ba88a1fe	345	if ! test -d "$path"/.git -o -f "$path"/.git
211b7f19 LH	346	then
211b7f19 LH	347	module_clone "$path" "$url" \|\| exit
bf2d8246 LH	348	subsha1=
bf2d8246 LH	349	else
51884080	350	subsha1=$(unset GIT_DIR; cd "$path" &&
5be60078	351	git rev-parse --verify HEAD) \|\|
941987a5	352	die "Unable to find current revision in submodule path '$path'"
70c7ac22	353	fi
211b7f19	354
70c7ac22 LH	355	if test "$subsha1" != "$sha1"
70c7ac22 LH	356	then
b9b378a0 PY	357	force=
	358	if test -z "$subsha1"
	359	then
	360	force="-f"
	361	fi
31ca3ac3 FF	362
	363	if test -z "$nofetch"
	364	then
	365	(unset GIT_DIR; cd "$path" &&
	366	git-fetch) \|\|
	367	die "Unable to fetch in submodule path '$path'"
	368	fi
	369
	370	(unset GIT_DIR; cd "$path" &&
	371	git-checkout $force -q "$sha1") \|\|
941987a5	372	die "Unable to checkout '$sha1' in submodule path '$path'"
70c7ac22	373
941987a5	374	say "Submodule path '$path': checked out '$sha1'"
70c7ac22 LH	375	fi
	376	done
	377	}
	378
bffe71f4 EM	379	set_name_rev () {
bffe71f4 EM	380	revname=$( (
51884080	381	unset GIT_DIR
bffe71f4	382	cd "$1" && {
5be60078 JH	383	git describe "$2" 2>/dev/null \|\|
5be60078 JH	384	git describe --tags "$2" 2>/dev/null \|\|
f669ac0b ML	385	git describe --contains "$2" 2>/dev/null \|\|
f669ac0b ML	386	git describe --all --always "$2"
bffe71f4 EM	387	}
	388	) )
	389	test -z "$revname" \|\| revname=" ($revname)"
	390	}
28f9af5d PY	391	#
	392	# Show commit summary for submodules in index or working tree
	393	#
	394	# If '--cached' is given, show summary between index and given commit,
	395	# or between working tree and given commit
	396	#
	397	# $@ = [commit (default 'HEAD'),] requested paths (default all)
	398	#
	399	cmd_summary() {
f2dc06a3	400	summary_limit=-1
d0f64dd4	401	for_status=
f2dc06a3	402
28f9af5d PY	403	# parse $args after "submodule ... summary".
	404	while test $# -ne 0
	405	do
	406	case "$1" in
	407	--cached)
	408	cached="$1"
	409	;;
d0f64dd4 PY	410	--for-status)
	411	for_status="$1"
	412	;;
f2dc06a3 PY	413	-n\|--summary-limit)
	414	if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
	415	then
	416	:
	417	else
	418	usage
	419	fi
	420	shift
	421	;;
28f9af5d PY	422	--)
	423	shift
	424	break
	425	;;
	426	-*)
	427	usage
	428	;;
	429	*)
	430	break
	431	;;
	432	esac
	433	shift
	434	done
bffe71f4	435
f2dc06a3 PY	436	test $summary_limit = 0 && return
f2dc06a3 PY	437
30353a40	438	if rev=$(git rev-parse -q --verify "$1^0")
28f9af5d PY	439	then
	440	head=$rev
	441	shift
	442	else
	443	head=HEAD
	444	fi
	445
	446	cd_to_toplevel
	447	# Get modified modules cared by user
	448	modules=$(git diff-index $cached --raw $head -- "$@" \|
759ad19e	449	egrep '^:([0-7]* )?160000' \|
28f9af5d PY	450	while read mod_src mod_dst sha1_src sha1_dst status name
	451	do
	452	# Always show modules deleted or type-changed (blob<->module)
	453	test $status = D -o $status = T && echo "$name" && continue
	454	# Also show added or modified modules which are checked out
	455	GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
	456	echo "$name"
	457	done
	458	)
1cb639e6	459
d0f64dd4 PY	460	test -z "$modules" && return
d0f64dd4 PY	461
1cb639e6	462	git diff-index $cached --raw $head -- $modules \|
759ad19e	463	egrep '^:([0-7]* )?160000' \|
1cb639e6 PY	464	cut -c2- \|
	465	while read mod_src mod_dst sha1_src sha1_dst status name
	466	do
	467	if test -z "$cached" &&
	468	test $sha1_dst = 0000000000000000000000000000000000000000
	469	then
	470	case "$mod_dst" in
	471	160000)
	472	sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
	473	;;
	474	100644 \| 100755 \| 120000)
	475	sha1_dst=$(git hash-object $name)
	476	;;
	477	000000)
	478	;; # removed
	479	*)
	480	# unexpected type
	481	echo >&2 "unexpected mode $mod_dst"
	482	continue ;;
	483	esac
	484	fi
	485	missing_src=
	486	missing_dst=
	487
	488	test $mod_src = 160000 &&
30353a40	489	! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_src^0 >/dev/null &&
1cb639e6 PY	490	missing_src=t
	491
	492	test $mod_dst = 160000 &&
30353a40	493	! GIT_DIR="$name/.git" git-rev-parse -q --verify $sha1_dst^0 >/dev/null &&
1cb639e6	494	missing_dst=t
bffe71f4	495
1cb639e6 PY	496	total_commits=
	497	case "$missing_src,$missing_dst" in
	498	t,)
	499	errmsg=" Warn: $name doesn't contain commit $sha1_src"
	500	;;
	501	,t)
	502	errmsg=" Warn: $name doesn't contain commit $sha1_dst"
	503	;;
	504	t,t)
	505	errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
	506	;;
	507	*)
	508	errmsg=
	509	total_commits=$(
	510	if test $mod_src = 160000 -a $mod_dst = 160000
	511	then
	512	range="$sha1_src...$sha1_dst"
	513	elif test $mod_src = 160000
	514	then
	515	range=$sha1_src
	516	else
	517	range=$sha1_dst
	518	fi
	519	GIT_DIR="$name/.git" \
	520	git log --pretty=oneline --first-parent $range \| wc -l
	521	)
eed35595	522	total_commits=" ($(($total_commits + 0)))"
1cb639e6 PY	523	;;
	524	esac
	525
	526	sha1_abbr_src=$(echo $sha1_src \| cut -c1-7)
	527	sha1_abbr_dst=$(echo $sha1_dst \| cut -c1-7)
	528	if test $status = T
	529	then
	530	if test $mod_dst = 160000
	531	then
	532	echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
	533	else
	534	echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
	535	fi
	536	else
	537	echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
	538	fi
	539	if test -n "$errmsg"
	540	then
	541	# Don't give error msg for modification whose dst is not submodule
	542	# i.e. deleted or changed to blob
	543	test $mod_dst = 160000 && echo "$errmsg"
	544	else
	545	if test $mod_src = 160000 -a $mod_dst = 160000
	546	then
f2dc06a3 PY	547	limit=
f2dc06a3 PY	548	test $summary_limit -gt 0 && limit="-$summary_limit"
1cb639e6	549	GIT_DIR="$name/.git" \
f2dc06a3	550	git log $limit --pretty='format: %m %s' \
1cb639e6 PY	551	--first-parent $sha1_src...$sha1_dst
	552	elif test $mod_dst = 160000
	553	then
	554	GIT_DIR="$name/.git" \
	555	git log --pretty='format: > %s' -1 $sha1_dst
	556	else
	557	GIT_DIR="$name/.git" \
	558	git log --pretty='format: < %s' -1 $sha1_src
	559	fi
	560	echo
	561	fi
	562	echo
d0f64dd4 PY	563	done \|
	564	if test -n "$for_status"; then
	565	echo "# Modified submodules:"
	566	echo "#"
	567	sed -e 's\|^\|# \|' -e 's\|^# $\|#\|'
	568	else
	569	cat
	570	fi
28f9af5d	571	}
70c7ac22	572	#
941987a5	573	# List all submodules, prefixed with:
70c7ac22 LH	574	# - submodule not initialized
	575	# + different revision checked out
	576	#
	577	# If --cached was specified the revision in the index will be printed
	578	# instead of the currently checked out revision.
	579	#
	580	# $@ = requested paths (default to all)
	581	#
23a485e3	582	cmd_status()
70c7ac22	583	{
5c08dbbd JH	584	# parse $args after "submodule ... status".
	585	while test $# -ne 0
	586	do
	587	case "$1" in
	588	-q\|--quiet)
	589	quiet=1
	590	;;
	591	--cached)
	592	cached=1
	593	;;
	594	--)
	595	shift
	596	break
	597	;;
	598	-*)
	599	usage
	600	;;
	601	*)
	602	break
	603	;;
	604	esac
	605	shift
	606	done
	607
a7b3269c	608	module_list "$@" \|
70c7ac22 LH	609	while read mode sha1 stage path
70c7ac22 LH	610	do
941987a5	611	name=$(module_name "$path") \|\| exit
5be60078	612	url=$(git config submodule."$name".url)
ba88a1fe	613	if test -z "$url" \|\| ! test -d "$path"/.git -o -f "$path"/.git
70c7ac22 LH	614	then
	615	say "-$sha1 $path"
	616	continue;
	617	fi
41c7c1bd	618	set_name_rev "$path" "$sha1"
70c7ac22 LH	619	if git diff-files --quiet -- "$path"
70c7ac22 LH	620	then
bffe71f4	621	say " $sha1 $path$revname"
70c7ac22 LH	622	else
	623	if test -z "$cached"
	624	then
51884080	625	sha1=$(unset GIT_DIR; cd "$path" && git rev-parse --verify HEAD)
41c7c1bd	626	set_name_rev "$path" "$sha1"
70c7ac22	627	fi
bffe71f4	628	say "+$sha1 $path$revname"
70c7ac22 LH	629	fi
	630	done
	631	}
2327f61e DA	632	#
	633	# Sync remote urls for submodules
	634	# This makes the value for remote.$remote.url match the value
	635	# specified in .gitmodules.
	636	#
	637	cmd_sync()
	638	{
	639	while test $# -ne 0
	640	do
	641	case "$1" in
	642	-q\|--quiet)
	643	quiet=1
	644	shift
	645	;;
	646	--)
	647	shift
	648	break
	649	;;
	650	-*)
	651	usage
	652	;;
	653	*)
	654	break
	655	;;
	656	esac
	657	done
	658	cd_to_toplevel
	659	module_list "$@" \|
	660	while read mode sha1 stage path
	661	do
	662	name=$(module_name "$path")
	663	url=$(git config -f .gitmodules --get submodule."$name".url)
baede9f8 JH	664
	665	# Possibly a url relative to parent
	666	case "$url" in
	667	./\|../)
	668	url=$(resolve_relative_url "$url") \|\| exit
	669	;;
	670	esac
	671
2327f61e DA	672	if test -e "$path"/.git
	673	then
	674	(
	675	unset GIT_DIR
	676	cd "$path"
	677	remote=$(get_default_remote)
	678	say "Synchronizing submodule url for '$name'"
	679	git config remote."$remote".url "$url"
	680	)
	681	fi
	682	done
	683	}
70c7ac22	684
5c08dbbd JH	685	# This loop parses the command line arguments to find the
	686	# subcommand name to dispatch. Parsing of the subcommand specific
	687	# options are primarily done by the subcommand implementations.
	688	# Subcommand specific options such as --branch and --cached are
	689	# parsed here as well, for backward compatibility.
	690
	691	while test $# != 0 && test -z "$command"
70c7ac22 LH	692	do
70c7ac22 LH	693	case "$1" in
2327f61e	694	add \| foreach \| init \| update \| status \| summary \| sync)
5c08dbbd	695	command=$1
70c7ac22 LH	696	;;
	697	-q\|--quiet)
	698	quiet=1
	699	;;
ecda0723 SV	700	-b\|--branch)
	701	case "$2" in
	702	'')
	703	usage
	704	;;
	705	esac
	706	branch="$2"; shift
	707	;;
70c7ac22	708	--cached)
28f9af5d	709	cached="$1"
70c7ac22 LH	710	;;
	711	--)
	712	break
	713	;;
	714	-*)
	715	usage
	716	;;
	717	*)
	718	break
	719	;;
	720	esac
	721	shift
	722	done
	723
5c08dbbd JH	724	# No command word defaults to "status"
	725	test -n "$command" \|\| command=status
	726
	727	# "-b branch" is accepted only by "add"
	728	if test -n "$branch" && test "$command" != add
	729	then
ecda0723	730	usage
5c08dbbd JH	731	fi
5c08dbbd JH	732
28f9af5d PY	733	# "--cached" is accepted only by "status" and "summary"
28f9af5d PY	734	if test -n "$cached" && test "$command" != status -a "$command" != summary
5c08dbbd	735	then
70c7ac22	736	usage
5c08dbbd JH	737	fi
	738
	739	"cmd_$command" "$@"