Documentation/git-commit: rewrite to make it more end-user friendly.
[git/dscho.git] / git-checkout.sh
blob737abd0c094ae6cfb201fb46c28f4962a9826a02
1 #!/bin/sh
3 USAGE='[-f] [-b <new_branch>] [-m] [<branch>] [<paths>...]'
4 SUBDIRECTORY_OK=Sometimes
5 . git-sh-setup
7 old_name=HEAD
8 old=$(git-rev-parse --verify $old_name 2>/dev/null)
9 new=
10 new_name=
11 force=
12 branch=
13 newbranch=
14 newbranch_log=
15 merge=
16 while [ "$#" != "0" ]; do
17 arg="$1"
18 shift
19 case "$arg" in
20 "-b")
21 newbranch="$1"
22 shift
23 [ -z "$newbranch" ] &&
24 die "git checkout: -b needs a branch name"
25 git-show-ref --verify --quiet -- "refs/heads/$newbranch" &&
26 die "git checkout: branch $newbranch already exists"
27 git-check-ref-format "heads/$newbranch" ||
28 die "git checkout: we do not like '$newbranch' as a branch name."
30 "-l")
31 newbranch_log=1
33 "-f")
34 force=1
36 -m)
37 merge=1
39 --)
40 break
42 -*)
43 usage
46 if rev=$(git-rev-parse --verify "$arg^0" 2>/dev/null)
47 then
48 if [ -z "$rev" ]; then
49 echo "unknown flag $arg"
50 exit 1
52 new="$rev"
53 new_name="$arg^0"
54 if git-show-ref --verify --quiet -- "refs/heads/$arg"
55 then
56 branch="$arg"
58 elif rev=$(git-rev-parse --verify "$arg^{tree}" 2>/dev/null)
59 then
60 # checking out selected paths from a tree-ish.
61 new="$rev"
62 new_name="$arg^{tree}"
63 branch=
64 else
65 new=
66 new_name=
67 branch=
68 set x "$arg" "$@"
69 shift
71 case "$1" in
72 --)
73 shift ;;
74 esac
75 break
77 esac
78 done
80 case "$force$merge" in
81 11)
82 die "git checkout: -f and -m are incompatible"
83 esac
85 # The behaviour of the command with and without explicit path
86 # parameters is quite different.
88 # Without paths, we are checking out everything in the work tree,
89 # possibly switching branches. This is the traditional behaviour.
91 # With paths, we are _never_ switching branch, but checking out
92 # the named paths from either index (when no rev is given),
93 # or the named tree-ish (when rev is given).
95 if test "$#" -ge 1
96 then
97 hint=
98 if test "$#" -eq 1
99 then
100 hint="
101 Did you intend to checkout '$@' which can not be resolved as commit?"
103 if test '' != "$newbranch$force$merge"
104 then
105 die "git checkout: updating paths is incompatible with switching branches/forcing$hint"
107 if test '' != "$new"
108 then
109 # from a specific tree-ish; note that this is for
110 # rescuing paths and is never meant to remove what
111 # is not in the named tree-ish.
112 git-ls-tree --full-name -r "$new" "$@" |
113 git-update-index --index-info || exit $?
116 # Make sure the request is about existing paths.
117 git-ls-files --error-unmatch -- "$@" >/dev/null || exit
118 git-ls-files -- "$@" |
119 git-checkout-index -f -u --stdin
120 exit $?
121 else
122 # Make sure we did not fall back on $arg^{tree} codepath
123 # since we are not checking out from an arbitrary tree-ish,
124 # but switching branches.
125 if test '' != "$new"
126 then
127 git-rev-parse --verify "$new^{commit}" >/dev/null 2>&1 ||
128 die "Cannot switch branch to a non-commit."
132 # We are switching branches and checking out trees, so
133 # we *NEED* to be at the toplevel.
134 cdup=$(git-rev-parse --show-cdup)
135 if test ! -z "$cdup"
136 then
137 cd "$cdup"
140 [ -z "$new" ] && new=$old && new_name="$old_name"
142 # If we don't have an old branch that we're switching to,
143 # and we don't have a new branch name for the target we
144 # are switching to, then we'd better just be checking out
145 # what we already had
147 [ -z "$branch$newbranch" ] &&
148 [ "$new" != "$old" ] &&
149 die "git checkout: to checkout the requested commit you need to specify
150 a name for a new branch which is created and switched to"
152 if [ "X$old" = X ]
153 then
154 echo "warning: You do not appear to currently be on a branch." >&2
155 echo "warning: Forcing checkout of $new_name." >&2
156 force=1
159 if [ "$force" ]
160 then
161 git-read-tree --reset -u $new
162 else
163 git-update-index --refresh >/dev/null
164 merge_error=$(git-read-tree -m -u $old $new 2>&1) || (
165 case "$merge" in
167 echo >&2 "$merge_error"
168 exit 1 ;;
169 esac
171 # Match the index to the working tree, and do a three-way.
172 git diff-files --name-only | git update-index --remove --stdin &&
173 work=`git write-tree` &&
174 git read-tree --reset -u $new &&
175 git read-tree -m -u --aggressive $old $new $work || exit
177 if result=`git write-tree 2>/dev/null`
178 then
179 echo >&2 "Trivially automerged."
180 else
181 git merge-index -o git-merge-one-file -a
184 # Do not register the cleanly merged paths in the index yet.
185 # this is not a real merge before committing, but just carrying
186 # the working tree changes along.
187 unmerged=`git ls-files -u`
188 git read-tree --reset $new
189 case "$unmerged" in
190 '') ;;
193 z40=0000000000000000000000000000000000000000
194 echo "$unmerged" |
195 sed -e 's/^[0-7]* [0-9a-f]* /'"0 $z40 /"
196 echo "$unmerged"
197 ) | git update-index --index-info
199 esac
200 exit 0
202 saved_err=$?
203 if test "$saved_err" = 0
204 then
205 test "$new" = "$old" || git diff-index --name-status "$new"
207 (exit $saved_err)
211 # Switch the HEAD pointer to the new branch if we
212 # checked out a branch head, and remove any potential
213 # old MERGE_HEAD's (subsequent commits will clearly not
214 # be based on them, since we re-set the index)
216 if [ "$?" -eq 0 ]; then
217 if [ "$newbranch" ]; then
218 if [ "$newbranch_log" ]; then
219 mkdir -p $(dirname "$GIT_DIR/logs/refs/heads/$newbranch")
220 touch "$GIT_DIR/logs/refs/heads/$newbranch"
222 git-update-ref -m "checkout: Created from $new_name" "refs/heads/$newbranch" $new || exit
223 branch="$newbranch"
225 [ "$branch" ] &&
226 GIT_DIR="$GIT_DIR" git-symbolic-ref HEAD "refs/heads/$branch"
227 rm -f "$GIT_DIR/MERGE_HEAD"
228 else
229 exit 1