Update draft release notes for 1.5.4.5
[git/dscho.git] / git-submodule.sh
blob67d3224c8c4c7106287aeb095ea545fe7a26b726
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 case "$repo" in
157 ./*|../*)
158 # dereference source url relative to parent's url
159 realrepo="$(resolve_relative_url $repo)" ;;
161 # Turn the source into an absolute path if
162 # it is local
163 if base=$(get_repo_base "$repo"); then
164 repo="$base"
166 realrepo=$repo
168 esac
170 # Guess path from repo if not specified or strip trailing slashes
171 if test -z "$path"; then
172 path=$(echo "$repo" | sed -e 's|/*$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
173 else
174 path=$(echo "$path" | sed -e 's|/*$||')
177 test -e "$path" &&
178 die "'$path' already exists"
180 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
181 die "'$path' already exists in the index"
183 module_clone "$path" "$realrepo" || exit
184 (unset GIT_DIR; cd "$path" && git checkout -q ${branch:+-b "$branch" "origin/$branch"}) ||
185 die "Unable to checkout submodule '$path'"
186 git add "$path" ||
187 die "Failed to add submodule '$path'"
189 GIT_CONFIG=.gitmodules git config submodule."$path".path "$path" &&
190 GIT_CONFIG=.gitmodules git config submodule."$path".url "$repo" &&
191 git add .gitmodules ||
192 die "Failed to register submodule '$path'"
196 # Register submodules in .git/config
198 # $@ = requested paths (default to all)
200 cmd_init()
202 # parse $args after "submodule ... init".
203 while test $# -ne 0
205 case "$1" in
206 -q|--quiet)
207 quiet=1
210 shift
211 break
214 usage
217 break
219 esac
220 shift
221 done
223 git ls-files --stage -- "$@" | grep -e '^160000 ' |
224 while read mode sha1 stage path
226 # Skip already registered paths
227 name=$(module_name "$path") || exit
228 url=$(git config submodule."$name".url)
229 test -z "$url" || continue
231 url=$(GIT_CONFIG=.gitmodules git config submodule."$name".url)
232 test -z "$url" &&
233 die "No url found for submodule path '$path' in .gitmodules"
235 # Possibly a url relative to parent
236 case "$url" in
237 ./*|../*)
238 url="$(resolve_relative_url "$url")"
240 esac
242 git config submodule."$name".url "$url" ||
243 die "Failed to register url for submodule path '$path'"
245 say "Submodule '$name' ($url) registered for path '$path'"
246 done
250 # Update each submodule path to correct revision, using clone and checkout as needed
252 # $@ = requested paths (default to all)
254 cmd_update()
256 # parse $args after "submodule ... update".
257 while test $# -ne 0
259 case "$1" in
260 -q|--quiet)
261 quiet=1
264 shift
265 break
268 usage
271 break
273 esac
274 shift
275 done
277 git ls-files --stage -- "$@" | grep -e '^160000 ' |
278 while read mode sha1 stage path
280 name=$(module_name "$path") || exit
281 url=$(git config submodule."$name".url)
282 if test -z "$url"
283 then
284 # Only mention uninitialized submodules when its
285 # path have been specified
286 test "$#" != "0" &&
287 say "Submodule path '$path' not initialized"
288 continue
291 if ! test -d "$path"/.git
292 then
293 module_clone "$path" "$url" || exit
294 subsha1=
295 else
296 subsha1=$(unset GIT_DIR; cd "$path" &&
297 git rev-parse --verify HEAD) ||
298 die "Unable to find current revision in submodule path '$path'"
301 if test "$subsha1" != "$sha1"
302 then
303 (unset GIT_DIR; cd "$path" && git-fetch &&
304 git-checkout -q "$sha1") ||
305 die "Unable to checkout '$sha1' in submodule path '$path'"
307 say "Submodule path '$path': checked out '$sha1'"
309 done
312 set_name_rev () {
313 revname=$( (
314 unset GIT_DIR
315 cd "$1" && {
316 git describe "$2" 2>/dev/null ||
317 git describe --tags "$2" 2>/dev/null ||
318 git describe --contains --tags "$2"
321 test -z "$revname" || revname=" ($revname)"
325 # List all submodules, prefixed with:
326 # - submodule not initialized
327 # + different revision checked out
329 # If --cached was specified the revision in the index will be printed
330 # instead of the currently checked out revision.
332 # $@ = requested paths (default to all)
334 cmd_status()
336 # parse $args after "submodule ... status".
337 while test $# -ne 0
339 case "$1" in
340 -q|--quiet)
341 quiet=1
343 --cached)
344 cached=1
347 shift
348 break
351 usage
354 break
356 esac
357 shift
358 done
360 git ls-files --stage -- "$@" | grep -e '^160000 ' |
361 while read mode sha1 stage path
363 name=$(module_name "$path") || exit
364 url=$(git config submodule."$name".url)
365 if test -z "$url" || ! test -d "$path"/.git
366 then
367 say "-$sha1 $path"
368 continue;
370 set_name_rev "$path" "$sha1"
371 if git diff-files --quiet -- "$path"
372 then
373 say " $sha1 $path$revname"
374 else
375 if test -z "$cached"
376 then
377 sha1=$(unset GIT_DIR; cd "$path" && git rev-parse --verify HEAD)
378 set_name_rev "$path" "$sha1"
380 say "+$sha1 $path$revname"
382 done
385 # This loop parses the command line arguments to find the
386 # subcommand name to dispatch. Parsing of the subcommand specific
387 # options are primarily done by the subcommand implementations.
388 # Subcommand specific options such as --branch and --cached are
389 # parsed here as well, for backward compatibility.
391 while test $# != 0 && test -z "$command"
393 case "$1" in
394 add | init | update | status)
395 command=$1
397 -q|--quiet)
398 quiet=1
400 -b|--branch)
401 case "$2" in
403 usage
405 esac
406 branch="$2"; shift
408 --cached)
409 cached=1
412 break
415 usage
418 break
420 esac
421 shift
422 done
424 # No command word defaults to "status"
425 test -n "$command" || command=status
427 # "-b branch" is accepted only by "add"
428 if test -n "$branch" && test "$command" != add
429 then
430 usage
433 # "--cached" is accepted only by "status"
434 if test -n "$cached" && test "$command" != status
435 then
436 usage
439 "cmd_$command" "$@"