grep portability fix: don't use "-e" or "-q"
[git/dscho.git] / git-submodule.sh
blobceb22952aa940e1a13f0b6ccbf30fdc19bd9eba2
1 #!/bin/sh
3 # git-submodules.sh: add, init, update or list git submodules
5 # Copyright (c) 2007 Lars Hjemli
7 USAGE='[--quiet] [--cached] [add <repo> [-b branch]|status|init|update] [--] [<path>...]'
8 OPTIONS_SPEC=
9 . git-sh-setup
10 require_work_tree
12 command=
13 branch=
14 quiet=
15 cached=
18 # print stuff on stdout unless -q was specified
20 say()
22 if test -z "$quiet"
23 then
24 echo "$@"
28 # NEEDSWORK: identical function exists in get_repo_base in clone.sh
29 get_repo_base() {
31 cd "`/bin/pwd`" &&
32 cd "$1" || cd "$1.git" &&
34 cd .git
35 pwd
37 ) 2>/dev/null
40 # Resolve relative url by appending to parent's url
41 resolve_relative_url ()
43 branch="$(git symbolic-ref HEAD 2>/dev/null)"
44 remote="$(git config branch.${branch#refs/heads/}.remote)"
45 remote="${remote:-origin}"
46 remoteurl="$(git config remote.$remote.url)" ||
47 die "remote ($remote) does not have a url in .git/config"
48 url="$1"
49 while test -n "$url"
51 case "$url" in
52 ../*)
53 url="${url#../}"
54 remoteurl="${remoteurl%/*}"
56 ./*)
57 url="${url#./}"
60 break;;
61 esac
62 done
63 echo "$remoteurl/$url"
67 # Map submodule path to submodule name
69 # $1 = path
71 module_name()
73 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
74 re=$(printf '%s' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
75 name=$( GIT_CONFIG=.gitmodules \
76 git config --get-regexp '^submodule\..*\.path$' |
77 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
78 test -z "$name" &&
79 die "No submodule mapping found in .gitmodules for path '$path'"
80 echo "$name"
84 # Clone a submodule
86 # Prior to calling, cmd_update checks that a possibly existing
87 # path is not a git repository.
88 # Likewise, cmd_add checks that path does not exist at all,
89 # since it is the location of a new submodule.
91 module_clone()
93 path=$1
94 url=$2
96 # If there already is a directory at the submodule path,
97 # expect it to be empty (since that is the default checkout
98 # action) and try to remove it.
99 # Note: if $path is a symlink to a directory the test will
100 # succeed but the rmdir will fail. We might want to fix this.
101 if test -d "$path"
102 then
103 rmdir "$path" 2>/dev/null ||
104 die "Directory '$path' exist, but is neither empty nor a git repository"
107 test -e "$path" &&
108 die "A file already exist at path '$path'"
110 git-clone -n "$url" "$path" ||
111 die "Clone of '$url' into submodule path '$path' failed"
115 # Add a new submodule to the working tree, .gitmodules and the index
117 # $@ = repo [path]
119 # optional branch is stored in global branch variable
121 cmd_add()
123 # parse $args after "submodule ... add".
124 while test $# -ne 0
126 case "$1" in
127 -b | --branch)
128 case "$2" in '') usage ;; esac
129 branch=$2
130 shift
132 -q|--quiet)
133 quiet=1
136 shift
137 break
140 usage
143 break
145 esac
146 shift
147 done
149 repo=$1
150 path=$2
152 if test -z "$repo"; then
153 usage
156 # Guess path from repo if not specified or strip trailing slashes
157 if test -z "$path"; then
158 path=$(echo "$repo" | sed -e 's|/*$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
159 else
160 path=$(echo "$path" | sed -e 's|/*$||')
163 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
164 die "'$path' already exists in the index"
166 # perhaps the path exists and is already a git repo, else clone it
167 if test -e "$path"
168 then
169 if test -d "$path/.git" &&
170 test "$(unset GIT_DIR; cd $path; git rev-parse --git-dir)" = ".git"
171 then
172 echo "Adding existing repo at '$path' to the index"
173 else
174 die "'$path' already exists and is not a valid git repo"
176 else
177 case "$repo" in
178 ./*|../*)
179 # dereference source url relative to parent's url
180 realrepo="$(resolve_relative_url $repo)" ;;
182 # Turn the source into an absolute path if
183 # it is local
184 if base=$(get_repo_base "$repo"); then
185 repo="$base"
187 realrepo=$repo
189 esac
191 module_clone "$path" "$realrepo" || exit
192 (unset GIT_DIR; cd "$path" && git checkout -q ${branch:+-b "$branch" "origin/$branch"}) ||
193 die "Unable to checkout submodule '$path'"
196 git add "$path" ||
197 die "Failed to add submodule '$path'"
199 GIT_CONFIG=.gitmodules git config submodule."$path".path "$path" &&
200 GIT_CONFIG=.gitmodules git config submodule."$path".url "$repo" &&
201 git add .gitmodules ||
202 die "Failed to register submodule '$path'"
206 # Register submodules in .git/config
208 # $@ = requested paths (default to all)
210 cmd_init()
212 # parse $args after "submodule ... init".
213 while test $# -ne 0
215 case "$1" in
216 -q|--quiet)
217 quiet=1
220 shift
221 break
224 usage
227 break
229 esac
230 shift
231 done
233 git ls-files --stage -- "$@" | grep '^160000 ' |
234 while read mode sha1 stage path
236 # Skip already registered paths
237 name=$(module_name "$path") || exit
238 url=$(git config submodule."$name".url)
239 test -z "$url" || continue
241 url=$(GIT_CONFIG=.gitmodules git config submodule."$name".url)
242 test -z "$url" &&
243 die "No url found for submodule path '$path' in .gitmodules"
245 # Possibly a url relative to parent
246 case "$url" in
247 ./*|../*)
248 url="$(resolve_relative_url "$url")"
250 esac
252 git config submodule."$name".url "$url" ||
253 die "Failed to register url for submodule path '$path'"
255 say "Submodule '$name' ($url) registered for path '$path'"
256 done
260 # Update each submodule path to correct revision, using clone and checkout as needed
262 # $@ = requested paths (default to all)
264 cmd_update()
266 # parse $args after "submodule ... update".
267 while test $# -ne 0
269 case "$1" in
270 -q|--quiet)
271 quiet=1
274 shift
275 break
278 usage
281 break
283 esac
284 shift
285 done
287 git ls-files --stage -- "$@" | grep '^160000 ' |
288 while read mode sha1 stage path
290 name=$(module_name "$path") || exit
291 url=$(git config submodule."$name".url)
292 if test -z "$url"
293 then
294 # Only mention uninitialized submodules when its
295 # path have been specified
296 test "$#" != "0" &&
297 say "Submodule path '$path' not initialized"
298 continue
301 if ! test -d "$path"/.git
302 then
303 module_clone "$path" "$url" || exit
304 subsha1=
305 else
306 subsha1=$(unset GIT_DIR; cd "$path" &&
307 git rev-parse --verify HEAD) ||
308 die "Unable to find current revision in submodule path '$path'"
311 if test "$subsha1" != "$sha1"
312 then
313 (unset GIT_DIR; cd "$path" && git-fetch &&
314 git-checkout -q "$sha1") ||
315 die "Unable to checkout '$sha1' in submodule path '$path'"
317 say "Submodule path '$path': checked out '$sha1'"
319 done
322 set_name_rev () {
323 revname=$( (
324 unset GIT_DIR
325 cd "$1" && {
326 git describe "$2" 2>/dev/null ||
327 git describe --tags "$2" 2>/dev/null ||
328 git describe --contains --tags "$2"
331 test -z "$revname" || revname=" ($revname)"
335 # List all submodules, prefixed with:
336 # - submodule not initialized
337 # + different revision checked out
339 # If --cached was specified the revision in the index will be printed
340 # instead of the currently checked out revision.
342 # $@ = requested paths (default to all)
344 cmd_status()
346 # parse $args after "submodule ... status".
347 while test $# -ne 0
349 case "$1" in
350 -q|--quiet)
351 quiet=1
353 --cached)
354 cached=1
357 shift
358 break
361 usage
364 break
366 esac
367 shift
368 done
370 git ls-files --stage -- "$@" | grep '^160000 ' |
371 while read mode sha1 stage path
373 name=$(module_name "$path") || exit
374 url=$(git config submodule."$name".url)
375 if test -z "$url" || ! test -d "$path"/.git
376 then
377 say "-$sha1 $path"
378 continue;
380 set_name_rev "$path" "$sha1"
381 if git diff-files --quiet -- "$path"
382 then
383 say " $sha1 $path$revname"
384 else
385 if test -z "$cached"
386 then
387 sha1=$(unset GIT_DIR; cd "$path" && git rev-parse --verify HEAD)
388 set_name_rev "$path" "$sha1"
390 say "+$sha1 $path$revname"
392 done
395 # This loop parses the command line arguments to find the
396 # subcommand name to dispatch. Parsing of the subcommand specific
397 # options are primarily done by the subcommand implementations.
398 # Subcommand specific options such as --branch and --cached are
399 # parsed here as well, for backward compatibility.
401 while test $# != 0 && test -z "$command"
403 case "$1" in
404 add | init | update | status)
405 command=$1
407 -q|--quiet)
408 quiet=1
410 -b|--branch)
411 case "$2" in
413 usage
415 esac
416 branch="$2"; shift
418 --cached)
419 cached=1
422 break
425 usage
428 break
430 esac
431 shift
432 done
434 # No command word defaults to "status"
435 test -n "$command" || command=status
437 # "-b branch" is accepted only by "add"
438 if test -n "$branch" && test "$command" != add
439 then
440 usage
443 # "--cached" is accepted only by "status"
444 if test -n "$cached" && test "$command" != status
445 then
446 usage
449 "cmd_$command" "$@"