Document where configuration files are in config.txt
[git/gitweb.git] / git-checkout.sh
blobe02d4d87f622bf73ad04c356ff15ac6e0a626aa6
1 #!/bin/sh
3 USAGE='[-f] [-b <new_branch>] [-m] [<branch>] [<paths>...]'
4 SUBDIRECTORY_OK=Sometimes
5 . git-sh-setup
6 require_work_tree
8 old_name=HEAD
9 old=$(git-rev-parse --verify $old_name 2>/dev/null)
10 oldbranch=$(git-symbolic-ref $old_name 2>/dev/null)
11 new=
12 new_name=
13 force=
14 branch=
15 newbranch=
16 newbranch_log=
17 merge=
18 LF='
20 while [ "$#" != "0" ]; do
21 arg="$1"
22 shift
23 case "$arg" in
24 "-b")
25 newbranch="$1"
26 shift
27 [ -z "$newbranch" ] &&
28 die "git checkout: -b needs a branch name"
29 git-show-ref --verify --quiet -- "refs/heads/$newbranch" &&
30 die "git checkout: branch $newbranch already exists"
31 git-check-ref-format "heads/$newbranch" ||
32 die "git checkout: we do not like '$newbranch' as a branch name."
34 "-l")
35 newbranch_log=1
37 "-f")
38 force=1
40 -m)
41 merge=1
43 --)
44 break
46 -*)
47 usage
50 if rev=$(git-rev-parse --verify "$arg^0" 2>/dev/null)
51 then
52 if [ -z "$rev" ]; then
53 echo "unknown flag $arg"
54 exit 1
56 new="$rev"
57 new_name="$arg"
58 if git-show-ref --verify --quiet -- "refs/heads/$arg"
59 then
60 branch="$arg"
62 elif rev=$(git-rev-parse --verify "$arg^{tree}" 2>/dev/null)
63 then
64 # checking out selected paths from a tree-ish.
65 new="$rev"
66 new_name="$arg^{tree}"
67 branch=
68 else
69 new=
70 new_name=
71 branch=
72 set x "$arg" "$@"
73 shift
75 case "$1" in
76 --)
77 shift ;;
78 esac
79 break
81 esac
82 done
84 case "$force$merge" in
85 11)
86 die "git checkout: -f and -m are incompatible"
87 esac
89 # The behaviour of the command with and without explicit path
90 # parameters is quite different.
92 # Without paths, we are checking out everything in the work tree,
93 # possibly switching branches. This is the traditional behaviour.
95 # With paths, we are _never_ switching branch, but checking out
96 # the named paths from either index (when no rev is given),
97 # or the named tree-ish (when rev is given).
99 if test "$#" -ge 1
100 then
101 hint=
102 if test "$#" -eq 1
103 then
104 hint="
105 Did you intend to checkout '$@' which can not be resolved as commit?"
107 if test '' != "$newbranch$force$merge"
108 then
109 die "git checkout: updating paths is incompatible with switching branches/forcing$hint"
111 if test '' != "$new"
112 then
113 # from a specific tree-ish; note that this is for
114 # rescuing paths and is never meant to remove what
115 # is not in the named tree-ish.
116 git-ls-tree --full-name -r "$new" "$@" |
117 git-update-index --index-info || exit $?
120 # Make sure the request is about existing paths.
121 git-ls-files --error-unmatch -- "$@" >/dev/null || exit
122 git-ls-files -- "$@" |
123 git-checkout-index -f -u --stdin
124 exit $?
125 else
126 # Make sure we did not fall back on $arg^{tree} codepath
127 # since we are not checking out from an arbitrary tree-ish,
128 # but switching branches.
129 if test '' != "$new"
130 then
131 git-rev-parse --verify "$new^{commit}" >/dev/null 2>&1 ||
132 die "Cannot switch branch to a non-commit."
136 # We are switching branches and checking out trees, so
137 # we *NEED* to be at the toplevel.
138 cd_to_toplevel
140 [ -z "$new" ] && new=$old && new_name="$old_name"
142 # If we don't have an existing 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 are detaching our HEAD from any
145 # branch. However, if "git checkout HEAD" detaches the HEAD
146 # from the current branch, even though that may be logically
147 # correct, it feels somewhat funny. More importantly, we do not
148 # want "git checkout" nor "git checkout -f" to detach HEAD.
150 detached=
151 detach_warn=
153 if test -z "$branch$newbranch" && test "$new" != "$old"
154 then
155 detached="$new"
156 if test -n "$oldbranch"
157 then
158 detach_warn="warning: you are not on ANY branch anymore.
159 If you meant to create a new branch from the commit, you need -b to
160 associate a new branch with the wanted checkout. Example:
161 git checkout -b <new_branch_name> $arg"
163 elif test -z "$oldbranch" && test -n "$branch"
164 then
165 # Coming back...
166 if test -z "$force"
167 then
168 git show-ref -d -s | grep "$old" >/dev/null || {
169 echo >&2 \
170 "You are not on any branch and switching to branch '$new_name'
171 may lose your changes. At this point, you can do one of two things:
172 (1) Decide it is Ok and say 'git checkout -f $new_name';
173 (2) Start a new branch from the current commit, by saying
174 'git checkout -b <branch-name>'.
175 Leaving your HEAD detached; not switching to branch '$new_name'."
176 exit 1;
181 if [ "X$old" = X ]
182 then
183 echo >&2 "warning: You appear to be on a branch yet to be born."
184 echo >&2 "warning: Forcing checkout of $new_name."
185 force=1
188 if [ "$force" ]
189 then
190 git-read-tree --reset -u $new
191 else
192 git-update-index --refresh >/dev/null
193 merge_error=$(git-read-tree -m -u --exclude-per-directory=.gitignore $old $new 2>&1) || (
194 case "$merge" in
196 echo >&2 "$merge_error"
197 exit 1 ;;
198 esac
200 # Match the index to the working tree, and do a three-way.
201 git diff-files --name-only | git update-index --remove --stdin &&
202 work=`git write-tree` &&
203 git read-tree --reset -u $new &&
204 eval GITHEAD_$new=${new_name:-${branch:-$new}} GITHEAD_$work=local &&
205 export GITHEAD_$new GITHEAD_$work &&
206 git merge-recursive $old -- $new $work || exit
208 if result=`git write-tree 2>/dev/null`
209 then
210 echo >&2 "Trivially automerged."
211 else
212 git merge-index -o git-merge-one-file -a
215 # Do not register the cleanly merged paths in the index yet.
216 # this is not a real merge before committing, but just carrying
217 # the working tree changes along.
218 unmerged=`git ls-files -u`
219 git read-tree --reset $new
220 case "$unmerged" in
221 '') ;;
224 z40=0000000000000000000000000000000000000000
225 echo "$unmerged" |
226 sed -e 's/^[0-7]* [0-9a-f]* /'"0 $z40 /"
227 echo "$unmerged"
228 ) | git update-index --index-info
230 esac
231 exit 0
233 saved_err=$?
234 if test "$saved_err" = 0
235 then
236 test "$new" = "$old" || git diff-index --name-status "$new"
238 (exit $saved_err)
242 # Switch the HEAD pointer to the new branch if we
243 # checked out a branch head, and remove any potential
244 # old MERGE_HEAD's (subsequent commits will clearly not
245 # be based on them, since we re-set the index)
247 if [ "$?" -eq 0 ]; then
248 if [ "$newbranch" ]; then
249 if [ "$newbranch_log" ]; then
250 mkdir -p $(dirname "$GIT_DIR/logs/refs/heads/$newbranch")
251 touch "$GIT_DIR/logs/refs/heads/$newbranch"
253 git-update-ref -m "checkout: Created from $new_name" "refs/heads/$newbranch" $new || exit
254 branch="$newbranch"
256 if test -n "$branch"
257 then
258 GIT_DIR="$GIT_DIR" git-symbolic-ref HEAD "refs/heads/$branch"
259 elif test -n "$detached"
260 then
261 # NEEDSWORK: we would want a command to detach the HEAD
262 # atomically, instead of this handcrafted command sequence.
263 # Perhaps:
264 # git update-ref --detach HEAD $new
265 # or something like that...
267 echo "$detached" >"$GIT_DIR/HEAD.new" &&
268 mv "$GIT_DIR/HEAD.new" "$GIT_DIR/HEAD" ||
269 die "Cannot detach HEAD"
270 if test -n "$detach_warn"
271 then
272 echo >&2 "$detach_warn"
275 rm -f "$GIT_DIR/MERGE_HEAD"
276 else
277 exit 1