#!/bin/sh # # git-submodules.sh: add, init, update or list git submodules # # Copyright (c) 2007 Lars Hjemli dashless=$(basename "$0" | sed -e 's/-/ /') USAGE="[--quiet] add [-b branch] [-f|--force] [--reference ] [--] [] or: $dashless [--quiet] status [--cached] [--recursive] [--] [...] or: $dashless [--quiet] init [--] [...] or: $dashless [--quiet] update [--init] [-N|--no-fetch] [-f|--force] [--rebase] [--reference ] [--merge] [--recursive] [--] [...] or: $dashless [--quiet] summary [--cached|--files] [--summary-limit ] [commit] [--] [...] or: $dashless [--quiet] foreach [--recursive] or: $dashless [--quiet] sync [--] [...]" OPTIONS_SPEC= . git-sh-setup . git-sh-i18n . git-parse-remote require_work_tree command= branch= force= reference= cached= recursive= init= files= nofetch= update= prefix= # Resolve relative url by appending to parent's url resolve_relative_url () { remote=$(get_default_remote) remoteurl=$(git config "remote.$remote.url") || remoteurl=$(pwd) # the repository is its own authoritative upstream url="$1" remoteurl=${remoteurl%/} sep=/ while test -n "$url" do case "$url" in ../*) url="${url#../}" case "$remoteurl" in */*) remoteurl="${remoteurl%/*}" ;; *:*) remoteurl="${remoteurl%:*}" sep=: ;; *) die "$(eval_gettext "cannot strip one component off url '\$remoteurl'")" ;; esac ;; ./*) url="${url#./}" ;; *) break;; esac done echo "$remoteurl$sep${url%/}" } # # Get submodule info for registered submodules # $@ = path to limit submodule list # module_list() { git ls-files --error-unmatch --stage -- "$@" | perl -e ' my %unmerged = (); my ($null_sha1) = ("0" x 40); while () { chomp; my ($mode, $sha1, $stage, $path) = /^([0-7]+) ([0-9a-f]{40}) ([0-3])\t(.*)$/; next unless $mode eq "160000"; if ($stage ne "0") { if (!$unmerged{$path}++) { print "$mode $null_sha1 U\t$path\n"; } next; } print "$_\n"; } ' } # # Map submodule path to submodule name # # $1 = path # module_name() { # Do we have "submodule..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 "$(eval_gettext "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 reference="$3" quiet= if test -n "$GIT_QUIET" then quiet=-q fi gitdir= gitdir_base= name=$(module_name "$path") base_path=$(dirname "$path") gitdir=$(git rev-parse --git-dir) gitdir_base="$gitdir/modules/$base_path" gitdir="$gitdir/modules/$path" case $gitdir in /*) a="$(cd_to_toplevel && pwd)/" b=$gitdir while [ "$b" ] && [ "${a%%/*}" = "${b%%/*}" ] do a=${a#*/} b=${b#*/}; done rel="$a$name" rel=`echo $rel | sed -e 's|[^/]*|..|g'` rel_gitdir="$rel/$b" ;; *) rel=`echo $name | sed -e 's|[^/]*|..|g'` rel_gitdir="$rel/$gitdir" ;; esac if test -d "$gitdir" then mkdir -p "$path" echo "gitdir: $rel_gitdir" >"$path/.git" rm -f "$gitdir/index" else mkdir -p "$gitdir_base" if test -n "$reference" then git-clone $quiet "$reference" -n "$url" "$path" --separate-git-dir "$gitdir" else git-clone $quiet -n "$url" "$path" --separate-git-dir "$gitdir" fi || die "$(eval_gettext "Clone of '\$url' into submodule path '\$path' failed")" fi } # # 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 ;; -f | --force) force=$1 ;; -q|--quiet) GIT_QUIET=1 ;; --reference) case "$2" in '') usage ;; esac reference="--reference=$2" shift ;; --reference=*) reference="$1" shift ;; --) shift break ;; -*) usage ;; *) break ;; esac shift done repo=$1 path=$2 if test -z "$path"; then path=$(echo "$repo" | sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g') fi 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 "$(eval_gettext "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 "$(eval_gettext "'\$path' already exists in the index")" if test -z "$force" && ! git add --dry-run --ignore-missing "$path" > /dev/null 2>&1 then cat >&2 <&2 "Skipping unmerged submodule $path" continue fi name=$(module_name "$path") || exit url=$(git config submodule."$name".url) if ! test -z "$update" then update_module=$update else update_module=$(git config submodule."$name".update) fi if test "$update_module" = "none" then echo "Skipping submodule '$path'" continue fi if test -z "$url" then # Only mention uninitialized submodules when its # path have been specified test "$#" != "0" && say "$(eval_gettext "Submodule path '\$path' not initialized Maybe you want to use 'update --init'?")" continue fi if ! test -d "$path"/.git -o -f "$path"/.git then module_clone "$path" "$url" "$reference"|| exit cloned_modules="$cloned_modules;$name" subsha1= else subsha1=$(clear_local_git_env; cd "$path" && git rev-parse --verify HEAD) || die "$(eval_gettext "Unable to find current revision in submodule path '\$path'")" fi if test "$subsha1" != "$sha1" then subforce=$force # If we don't already have a -f flag and the submodule has never been checked out if test -z "$subsha1" -a -z "$force" then subforce="-f" fi if test -z "$nofetch" then # Run fetch only if $sha1 isn't present or it # is not reachable from a ref. (clear_local_git_env; cd "$path" && ( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) && test -z "$rev") || git-fetch)) || die "$(eval_gettext "Unable to fetch in submodule path '\$path'")" fi # Is this something we just cloned? case ";$cloned_modules;" in *";$name;"*) # then there is no local change to integrate update_module= ;; esac must_die_on_failure= case "$update_module" in rebase) command="git rebase" die_msg="$(eval_gettext "Unable to rebase '\$sha1' in submodule path '\$path'")" say_msg="$(eval_gettext "Submodule path '\$path': rebased into '\$sha1'")" must_die_on_failure=yes ;; merge) command="git merge" die_msg="$(eval_gettext "Unable to merge '\$sha1' in submodule path '\$path'")" say_msg="$(eval_gettext "Submodule path '\$path': merged in '\$sha1'")" must_die_on_failure=yes ;; *) command="git checkout $subforce -q" die_msg="$(eval_gettext "Unable to checkout '\$sha1' in submodule path '\$path'")" say_msg="$(eval_gettext "Submodule path '\$path': checked out '\$sha1'")" ;; esac if (clear_local_git_env; cd "$path" && $command "$sha1") then say "$say_msg" elif test -n "$must_die_on_failure" then die_with_status 2 "$die_msg" else err="${err};$die_msg" continue fi fi if test -n "$recursive" then (clear_local_git_env; cd "$path" && eval cmd_update "$orig_flags") res=$? if test $res -gt 0 then die_msg="$(eval_gettext "Failed to recurse into submodule path '\$path'")" if test $res -eq 1 then err="${err};$die_msg" continue else die_with_status $res "$die_msg" fi fi fi done if test -n "$err" then OIFS=$IFS IFS=';' for e in $err do if test -n "$e" then echo >&2 "$e" fi done IFS=$OIFS exit 1 fi } } set_name_rev () { revname=$( ( clear_local_git_env 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= diff_cmd=diff-index # parse $args after "submodule ... summary". while test $# -ne 0 do case "$1" in --cached) cached="$1" ;; --files) files="$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 --default HEAD ${1+"$1"}) then head=$rev test $# = 0 || shift elif test -z "$1" -o "$1" = "HEAD" then # before the first commit: compare with an empty tree head=$(git hash-object -w -t tree --stdin 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_cmd $cached --ignore-submodules=dirty --raw $head -- $modules | sane_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 eval_gettextln "unexpected mode \$mod_dst" >&2 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="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_src")" ;; ,t) errmsg="$(eval_gettext " Warn: \$name doesn't contain commit \$sha1_dst")" ;; t,t) errmsg="$(eval_gettext " 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 rev-list --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 blob="$(gettext "blob")" submodule="$(gettext "submodule")" 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 if [ -n "$files" ]; then status_msg="$(gettextln "# Submodules changed but not updated:")" else status_msg="$(gettextln "# Submodule changes to be committed:")" fi status_sed=$(sed -e 's|^|# |' -e 's|^# $|#|') cat </dev/null 2>/dev/null then say "$(eval_gettext "Synchronizing submodule url for '\$name'")" git config submodule."$name".url "$url" if test -e "$path"/.git then ( clear_local_git_env cd "$path" remote=$(get_default_remote) git config remote."$remote".url "$url" ) fi 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) GIT_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" "$@"