checkout: move more parameters to struct checkout_opts
[git/git.git] / builtin / checkout.c
CommitLineData
782c2d65
DB
1#include "cache.h"
2#include "builtin.h"
3#include "parse-options.h"
4#include "refs.h"
5#include "commit.h"
6#include "tree.h"
7#include "tree-walk.h"
b9d37a54 8#include "cache-tree.h"
782c2d65
DB
9#include "unpack-trees.h"
10#include "dir.h"
11#include "run-command.h"
12#include "merge-recursive.h"
13#include "branch.h"
14#include "diff.h"
15#include "revision.h"
79a1e6b4 16#include "remote.h"
0cf8581e
JH
17#include "blob.h"
18#include "xdiff-interface.h"
19#include "ll-merge.h"
cfc5789a 20#include "resolve-undo.h"
175f6e59 21#include "submodule.h"
7bf0b017 22#include "argv-array.h"
782c2d65
DB
23
24static const char * const checkout_usage[] = {
25 "git checkout [options] <branch>",
26 "git checkout [options] [<branch>] -- <file>...",
27 NULL,
28};
29
db941099 30struct checkout_opts {
e51e3057 31 int patch_mode;
db941099
JH
32 int quiet;
33 int merge;
34 int force;
32669671 35 int force_detach;
38901a48 36 int writeout_stage;
c1d7036b 37 int overwrite_ignore;
db941099
JH
38
39 const char *new_branch;
02ac9837 40 const char *new_branch_force;
9db5ebf4 41 const char *new_orphan_branch;
db941099
JH
42 int new_branch_log;
43 enum branch_track track;
175f6e59 44 struct diff_options diff_options;
e51e3057
NTND
45
46 int branch_exists;
47 const char *prefix;
48 const char **pathspec;
49 struct tree *source_tree;
db941099
JH
50};
51
782c2d65
DB
52static int post_checkout_hook(struct commit *old, struct commit *new,
53 int changed)
54{
ae98a008
SB
55 return run_hook(NULL, "post-checkout",
56 sha1_to_hex(old ? old->object.sha1 : null_sha1),
57 sha1_to_hex(new ? new->object.sha1 : null_sha1),
58 changed ? "1" : "0", NULL);
2292ce47
SB
59 /* "new" can be NULL when checking out from the index before
60 a commit exists. */
ae98a008 61
782c2d65
DB
62}
63
64static int update_some(const unsigned char *sha1, const char *base, int baselen,
671f0707 65 const char *pathname, unsigned mode, int stage, void *context)
782c2d65
DB
66{
67 int len;
68 struct cache_entry *ce;
69
782c2d65
DB
70 if (S_ISDIR(mode))
71 return READ_TREE_RECURSIVE;
72
73 len = baselen + strlen(pathname);
74 ce = xcalloc(1, cache_entry_size(len));
75 hashcpy(ce->sha1, sha1);
76 memcpy(ce->name, base, baselen);
77 memcpy(ce->name + baselen, pathname, len - baselen);
b60e188c
TG
78 ce->ce_flags = create_ce_flags(0) | CE_UPDATE;
79 ce->ce_namelen = len;
782c2d65
DB
80 ce->ce_mode = create_ce_mode(mode);
81 add_cache_entry(ce, ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
82 return 0;
83}
84
85static int read_tree_some(struct tree *tree, const char **pathspec)
86{
f0096c06
NTND
87 struct pathspec ps;
88 init_pathspec(&ps, pathspec);
89 read_tree_recursive(tree, "", 0, 0, &ps, update_some, NULL);
90 free_pathspec(&ps);
782c2d65 91
782c2d65
DB
92 /* update the index with the given tree's info
93 * for all args, expanding wildcards, and exit
94 * with any non-zero return code.
95 */
96 return 0;
97}
98
8fdcf312
JH
99static int skip_same_name(struct cache_entry *ce, int pos)
100{
101 while (++pos < active_nr &&
102 !strcmp(active_cache[pos]->name, ce->name))
103 ; /* skip */
104 return pos;
105}
106
38901a48
JH
107static int check_stage(int stage, struct cache_entry *ce, int pos)
108{
109 while (pos < active_nr &&
110 !strcmp(active_cache[pos]->name, ce->name)) {
111 if (ce_stage(active_cache[pos]) == stage)
112 return 0;
113 pos++;
114 }
9f97ab08
ÆAB
115 if (stage == 2)
116 return error(_("path '%s' does not have our version"), ce->name);
117 else
118 return error(_("path '%s' does not have their version"), ce->name);
38901a48
JH
119}
120
fbbccd0a 121static int check_stages(unsigned stages, struct cache_entry *ce, int pos)
0cf8581e 122{
fbbccd0a
JH
123 unsigned seen = 0;
124 const char *name = ce->name;
125
126 while (pos < active_nr) {
127 ce = active_cache[pos];
128 if (strcmp(name, ce->name))
129 break;
130 seen |= (1 << ce_stage(ce));
131 pos++;
132 }
133 if ((stages & seen) != stages)
134 return error(_("path '%s' does not have all necessary versions"),
135 name);
0cf8581e
JH
136 return 0;
137}
138
38901a48
JH
139static int checkout_stage(int stage, struct cache_entry *ce, int pos,
140 struct checkout *state)
141{
142 while (pos < active_nr &&
143 !strcmp(active_cache[pos]->name, ce->name)) {
144 if (ce_stage(active_cache[pos]) == stage)
145 return checkout_entry(active_cache[pos], state, NULL);
146 pos++;
147 }
9f97ab08
ÆAB
148 if (stage == 2)
149 return error(_("path '%s' does not have our version"), ce->name);
150 else
151 return error(_("path '%s' does not have their version"), ce->name);
38901a48 152}
8fdcf312 153
0cf8581e
JH
154static int checkout_merged(int pos, struct checkout *state)
155{
156 struct cache_entry *ce = active_cache[pos];
157 const char *path = ce->name;
158 mmfile_t ancestor, ours, theirs;
159 int status;
160 unsigned char sha1[20];
161 mmbuffer_t result_buf;
fbbccd0a 162 unsigned char threeway[3][20];
335c6e40 163 unsigned mode = 0;
0cf8581e 164
fbbccd0a
JH
165 memset(threeway, 0, sizeof(threeway));
166 while (pos < active_nr) {
167 int stage;
168 stage = ce_stage(ce);
169 if (!stage || strcmp(path, ce->name))
170 break;
171 hashcpy(threeway[stage - 1], ce->sha1);
172 if (stage == 2)
173 mode = create_ce_mode(ce->ce_mode);
174 pos++;
175 ce = active_cache[pos];
176 }
177 if (is_null_sha1(threeway[1]) || is_null_sha1(threeway[2]))
178 return error(_("path '%s' does not have necessary versions"), path);
0cf8581e 179
fbbccd0a
JH
180 read_mmblob(&ancestor, threeway[0]);
181 read_mmblob(&ours, threeway[1]);
182 read_mmblob(&theirs, threeway[2]);
0cf8581e 183
18b037a5
JN
184 /*
185 * NEEDSWORK: re-create conflicts from merges with
186 * merge.renormalize set, too
187 */
f0531a29 188 status = ll_merge(&result_buf, path, &ancestor, "base",
712516bc 189 &ours, "ours", &theirs, "theirs", NULL);
0cf8581e
JH
190 free(ancestor.ptr);
191 free(ours.ptr);
192 free(theirs.ptr);
193 if (status < 0 || !result_buf.ptr) {
194 free(result_buf.ptr);
e8a8a4d7 195 return error(_("path '%s': cannot merge"), path);
0cf8581e
JH
196 }
197
198 /*
199 * NEEDSWORK:
200 * There is absolutely no reason to write this as a blob object
3ea3c215 201 * and create a phony cache entry just to leak. This hack is
0cf8581e
JH
202 * primarily to get to the write_entry() machinery that massages
203 * the contents to work-tree format and writes out which only
204 * allows it for a cache entry. The code in write_entry() needs
205 * to be refactored to allow us to feed a <buffer, size, mode>
206 * instead of a cache entry. Such a refactoring would help
207 * merge_recursive as well (it also writes the merge result to the
208 * object database even when it may contain conflicts).
209 */
210 if (write_sha1_file(result_buf.ptr, result_buf.size,
211 blob_type, sha1))
e8a8a4d7 212 die(_("Unable to add merge result for '%s'"), path);
fbbccd0a 213 ce = make_cache_entry(mode, sha1, path, 2, 0);
048f2762 214 if (!ce)
e8a8a4d7 215 die(_("make_cache_entry failed for path '%s'"), path);
0cf8581e
JH
216 status = checkout_entry(ce, state, NULL);
217 return status;
218}
8fdcf312 219
e51e3057 220static int checkout_paths(const struct checkout_opts *opts)
782c2d65
DB
221{
222 int pos;
223 struct checkout state;
224 static char *ps_matched;
225 unsigned char rev[20];
226 int flag;
227 struct commit *head;
d2b3691b 228 int errs = 0;
38901a48 229 int stage = opts->writeout_stage;
0cf8581e 230 int merge = opts->merge;
75336878
DB
231 int newfd;
232 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
233
234 newfd = hold_locked_index(lock_file, 1);
e51e3057 235 if (read_cache_preload(opts->pathspec) < 0)
e8a8a4d7 236 return error(_("corrupt index file"));
75336878 237
e51e3057
NTND
238 if (opts->source_tree)
239 read_tree_some(opts->source_tree, opts->pathspec);
75336878 240
e51e3057 241 for (pos = 0; opts->pathspec[pos]; pos++)
782c2d65
DB
242 ;
243 ps_matched = xcalloc(1, pos);
244
245 for (pos = 0; pos < active_nr; pos++) {
246 struct cache_entry *ce = active_cache[pos];
e51e3057 247 if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
0a1283bc 248 continue;
e51e3057 249 match_pathspec(opts->pathspec, ce->name, ce_namelen(ce), 0, ps_matched);
782c2d65
DB
250 }
251
e51e3057 252 if (report_path_error(ps_matched, opts->pathspec, opts->prefix))
782c2d65
DB
253 return 1;
254
4421a823
JH
255 /* "checkout -m path" to recreate conflicted state */
256 if (opts->merge)
e51e3057 257 unmerge_cache(opts->pathspec);
4421a823 258
8fdcf312
JH
259 /* Any unmerged paths? */
260 for (pos = 0; pos < active_nr; pos++) {
261 struct cache_entry *ce = active_cache[pos];
e51e3057 262 if (match_pathspec(opts->pathspec, ce->name, ce_namelen(ce), 0, NULL)) {
8fdcf312
JH
263 if (!ce_stage(ce))
264 continue;
db941099 265 if (opts->force) {
e8a8a4d7 266 warning(_("path '%s' is unmerged"), ce->name);
38901a48
JH
267 } else if (stage) {
268 errs |= check_stage(stage, ce, pos);
0cf8581e 269 } else if (opts->merge) {
fbbccd0a 270 errs |= check_stages((1<<2) | (1<<3), ce, pos);
db941099
JH
271 } else {
272 errs = 1;
e8a8a4d7 273 error(_("path '%s' is unmerged"), ce->name);
db941099 274 }
8fdcf312
JH
275 pos = skip_same_name(ce, pos) - 1;
276 }
277 }
278 if (errs)
279 return 1;
280
d2b3691b 281 /* Now we are committed to check them out */
782c2d65
DB
282 memset(&state, 0, sizeof(state));
283 state.force = 1;
284 state.refresh_cache = 1;
285 for (pos = 0; pos < active_nr; pos++) {
286 struct cache_entry *ce = active_cache[pos];
e51e3057 287 if (opts->source_tree && !(ce->ce_flags & CE_UPDATE))
0a1283bc 288 continue;
e51e3057 289 if (match_pathspec(opts->pathspec, ce->name, ce_namelen(ce), 0, NULL)) {
8fdcf312
JH
290 if (!ce_stage(ce)) {
291 errs |= checkout_entry(ce, &state, NULL);
292 continue;
293 }
38901a48
JH
294 if (stage)
295 errs |= checkout_stage(stage, ce, pos, &state);
0cf8581e
JH
296 else if (merge)
297 errs |= checkout_merged(pos, &state);
8fdcf312 298 pos = skip_same_name(ce, pos) - 1;
782c2d65
DB
299 }
300 }
301
75336878
DB
302 if (write_cache(newfd, active_cache, active_nr) ||
303 commit_locked_index(lock_file))
e8a8a4d7 304 die(_("unable to write new index file"));
75336878 305
c6893323 306 read_ref_full("HEAD", rev, 0, &flag);
782c2d65
DB
307 head = lookup_commit_reference_gently(rev, 1);
308
d2b3691b
JH
309 errs |= post_checkout_hook(head, head, 0);
310 return errs;
782c2d65
DB
311}
312
a2b4994c
NTND
313static void show_local_changes(struct object *head,
314 const struct diff_options *opts)
782c2d65
DB
315{
316 struct rev_info rev;
317 /* I think we want full paths, even if we're in a subdirectory. */
318 init_revisions(&rev, NULL);
175f6e59 319 rev.diffopt.flags = opts->flags;
782c2d65 320 rev.diffopt.output_format |= DIFF_FORMAT_NAME_STATUS;
28452655 321 diff_setup_done(&rev.diffopt);
782c2d65
DB
322 add_pending_object(&rev, head, NULL);
323 run_diff_index(&rev, 0);
324}
325
b3c0494a 326static void describe_detached_head(const char *msg, struct commit *commit)
782c2d65 327{
f285a2d7 328 struct strbuf sb = STRBUF_INIT;
782c2d65 329 parse_commit(commit);
8b8a5374 330 pp_commit_easy(CMIT_FMT_ONELINE, commit, &sb);
782c2d65
DB
331 fprintf(stderr, "%s %s... %s\n", msg,
332 find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV), sb.buf);
333 strbuf_release(&sb);
334}
335
a2b4994c
NTND
336static int reset_tree(struct tree *tree, const struct checkout_opts *o,
337 int worktree, int *writeout_error)
782c2d65
DB
338{
339 struct unpack_trees_options opts;
340 struct tree_desc tree_desc;
bc052d7f 341
782c2d65
DB
342 memset(&opts, 0, sizeof(opts));
343 opts.head_idx = -1;
6286a08d
JH
344 opts.update = worktree;
345 opts.skip_unmerged = !worktree;
782c2d65
DB
346 opts.reset = 1;
347 opts.merge = 1;
348 opts.fn = oneway_merge;
e9fc64c6 349 opts.verbose_update = !o->quiet && isatty(2);
34110cd4
LT
350 opts.src_index = &the_index;
351 opts.dst_index = &the_index;
782c2d65
DB
352 parse_tree(tree);
353 init_tree_desc(&tree_desc, tree->buffer, tree->size);
291d823e
JH
354 switch (unpack_trees(1, &tree_desc, &opts)) {
355 case -2:
a2b4994c 356 *writeout_error = 1;
291d823e
JH
357 /*
358 * We return 0 nevertheless, as the index is all right
359 * and more importantly we have made best efforts to
360 * update paths in the work tree, and we cannot revert
361 * them.
362 */
363 case 0:
364 return 0;
365 default:
84a5750b 366 return 128;
291d823e 367 }
782c2d65
DB
368}
369
782c2d65
DB
370struct branch_info {
371 const char *name; /* The short name used */
372 const char *path; /* The full name of a real branch */
373 struct commit *commit; /* The named commit */
374};
375
376static void setup_branch_path(struct branch_info *branch)
377{
f285a2d7 378 struct strbuf buf = STRBUF_INIT;
ae5a6c36 379
a552de75
JH
380 strbuf_branchname(&buf, branch->name);
381 if (strcmp(buf.buf, branch->name))
ae5a6c36 382 branch->name = xstrdup(buf.buf);
a552de75 383 strbuf_splice(&buf, 0, 0, "refs/heads/", 11);
782c2d65
DB
384 branch->path = strbuf_detach(&buf, NULL);
385}
386
a2b4994c
NTND
387static int merge_working_tree(const struct checkout_opts *opts,
388 struct branch_info *old,
389 struct branch_info *new,
390 int *writeout_error)
782c2d65
DB
391{
392 int ret;
393 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
394 int newfd = hold_locked_index(lock_file, 1);
b96524f8 395
53996fe5 396 if (read_cache_preload(NULL) < 0)
e8a8a4d7 397 return error(_("corrupt index file"));
782c2d65 398
cfc5789a 399 resolve_undo_clear();
782c2d65 400 if (opts->force) {
a2b4994c 401 ret = reset_tree(new->commit->tree, opts, 1, writeout_error);
782c2d65
DB
402 if (ret)
403 return ret;
404 } else {
405 struct tree_desc trees[2];
406 struct tree *tree;
407 struct unpack_trees_options topts;
bc052d7f 408
782c2d65
DB
409 memset(&topts, 0, sizeof(topts));
410 topts.head_idx = -1;
34110cd4
LT
411 topts.src_index = &the_index;
412 topts.dst_index = &the_index;
782c2d65 413
e294030f 414 setup_unpack_trees_porcelain(&topts, "checkout");
8ccba008 415
782c2d65
DB
416 refresh_cache(REFRESH_QUIET);
417
418 if (unmerged_cache()) {
e8a8a4d7 419 error(_("you need to resolve your current index first"));
04c9e11f 420 return 1;
782c2d65 421 }
04c9e11f
JH
422
423 /* 2-way merge to the new branch */
fa7b3c2f 424 topts.initial_checkout = is_cache_unborn();
04c9e11f
JH
425 topts.update = 1;
426 topts.merge = 1;
64da3ae5 427 topts.gently = opts->merge && old->commit;
e9fc64c6 428 topts.verbose_update = !opts->quiet && isatty(2);
04c9e11f 429 topts.fn = twoway_merge;
c1d7036b
NTND
430 if (opts->overwrite_ignore) {
431 topts.dir = xcalloc(1, sizeof(*topts.dir));
432 topts.dir->flags |= DIR_SHOW_IGNORED;
433 setup_standard_excludes(topts.dir);
434 }
cc580af8
JK
435 tree = parse_tree_indirect(old->commit ?
436 old->commit->object.sha1 :
dab0d410 437 EMPTY_TREE_SHA1_BIN);
04c9e11f
JH
438 init_tree_desc(&trees[0], tree->buffer, tree->size);
439 tree = parse_tree_indirect(new->commit->object.sha1);
440 init_tree_desc(&trees[1], tree->buffer, tree->size);
441
291d823e 442 ret = unpack_trees(2, trees, &topts);
49d833dc 443 if (ret == -1) {
782c2d65
DB
444 /*
445 * Unpack couldn't do a trivial merge; either
446 * give up or do a real merge, depending on
447 * whether the merge flag was used.
448 */
449 struct tree *result;
450 struct tree *work;
8a2fce18 451 struct merge_options o;
782c2d65
DB
452 if (!opts->merge)
453 return 1;
64da3ae5
JH
454
455 /*
456 * Without old->commit, the below is the same as
457 * the two-tree unpack we already tried and failed.
458 */
459 if (!old->commit)
460 return 1;
782c2d65
DB
461
462 /* Do more real merge */
463
464 /*
465 * We update the index fully, then write the
466 * tree from the index, then merge the new
467 * branch with the current tree, with the old
468 * branch as the base. Then we reset the index
469 * (but not the working tree) to the new
470 * branch, leaving the working tree as the
471 * merged version, but skipping unmerged
472 * entries in the index.
473 */
474
7ae02a30 475 add_files_to_cache(NULL, NULL, 0);
7610fa57
JN
476 /*
477 * NEEDSWORK: carrying over local changes
478 * when branches have different end-of-line
479 * normalization (or clean+smudge rules) is
480 * a pain; plumb in an option to set
481 * o.renormalize?
482 */
8a2fce18
MV
483 init_merge_options(&o);
484 o.verbosity = 0;
485 work = write_tree_from_memory(&o);
782c2d65 486
a2b4994c
NTND
487 ret = reset_tree(new->commit->tree, opts, 1,
488 writeout_error);
782c2d65
DB
489 if (ret)
490 return ret;
c4151629 491 o.ancestor = old->name;
8a2fce18
MV
492 o.branch1 = new->name;
493 o.branch2 = "local";
494 merge_trees(&o, new->commit->tree, work,
495 old->commit->tree, &result);
a2b4994c
NTND
496 ret = reset_tree(new->commit->tree, opts, 0,
497 writeout_error);
84a5750b
JH
498 if (ret)
499 return ret;
782c2d65
DB
500 }
501 }
502
503 if (write_cache(newfd, active_cache, active_nr) ||
504 commit_locked_index(lock_file))
e8a8a4d7 505 die(_("unable to write new index file"));
782c2d65 506
7fe4a728 507 if (!opts->force && !opts->quiet)
175f6e59 508 show_local_changes(&new->commit->object, &opts->diff_options);
782c2d65
DB
509
510 return 0;
511}
512
6d21bf96 513static void report_tracking(struct branch_info *new)
79a1e6b4 514{
6d21bf96 515 struct strbuf sb = STRBUF_INIT;
b56fca07 516 struct branch *branch = branch_get(new->name);
79a1e6b4 517
6d21bf96 518 if (!format_tracking_info(branch, &sb))
79a1e6b4 519 return;
6d21bf96
JH
520 fputs(sb.buf, stdout);
521 strbuf_release(&sb);
b0030db3 522}
79a1e6b4 523
a2b4994c 524static void update_refs_for_switch(const struct checkout_opts *opts,
782c2d65
DB
525 struct branch_info *old,
526 struct branch_info *new)
527{
f285a2d7 528 struct strbuf msg = STRBUF_INIT;
782c2d65
DB
529 const char *old_desc;
530 if (opts->new_branch) {
3631bf77
EM
531 if (opts->new_orphan_branch) {
532 if (opts->new_branch_log && !log_all_ref_updates) {
533 int temp;
157aaea5 534 char log_file[PATH_MAX];
3631bf77
EM
535 char *ref_name = mkpath("refs/heads/%s", opts->new_orphan_branch);
536
537 temp = log_all_ref_updates;
538 log_all_ref_updates = 1;
157aaea5 539 if (log_ref_setup(ref_name, log_file, sizeof(log_file))) {
e8a8a4d7 540 fprintf(stderr, _("Can not do reflog for '%s'\n"),
3631bf77
EM
541 opts->new_orphan_branch);
542 log_all_ref_updates = temp;
543 return;
544 }
545 log_all_ref_updates = temp;
546 }
547 }
548 else
02ac9837
TRC
549 create_branch(old->name, opts->new_branch, new->name,
550 opts->new_branch_force ? 1 : 0,
39bd6f72
JN
551 opts->new_branch_log,
552 opts->new_branch_force ? 1 : 0,
f9a482e6 553 opts->quiet,
39bd6f72 554 opts->track);
782c2d65
DB
555 new->name = opts->new_branch;
556 setup_branch_path(new);
557 }
558
782c2d65 559 old_desc = old->name;
323e00fd 560 if (!old_desc && old->commit)
782c2d65
DB
561 old_desc = sha1_to_hex(old->commit->object.sha1);
562 strbuf_addf(&msg, "checkout: moving from %s to %s",
323e00fd 563 old_desc ? old_desc : "(invalid)", new->name);
782c2d65 564
f8bd36a4
JN
565 if (!strcmp(new->name, "HEAD") && !new->path && !opts->force_detach) {
566 /* Nothing to do. */
567 } else if (opts->force_detach || !new->path) { /* No longer on any branch. */
568 update_ref(msg.buf, "HEAD", new->commit->object.sha1, NULL,
569 REF_NODEREF, DIE_ON_ERR);
570 if (!opts->quiet) {
571 if (old->path && advice_detached_head)
2857093b 572 detach_advice(new->name);
6c80cd29 573 describe_detached_head(_("HEAD is now at"), new->commit);
f8bd36a4
JN
574 }
575 } else if (new->path) { /* Switch branches. */
782c2d65
DB
576 create_symref("HEAD", new->path, msg.buf);
577 if (!opts->quiet) {
08eaa4be 578 if (old->path && !strcmp(new->path, old->path)) {
39bd6f72
JN
579 if (opts->new_branch_force)
580 fprintf(stderr, _("Reset branch '%s'\n"),
581 new->name);
582 else
583 fprintf(stderr, _("Already on '%s'\n"),
584 new->name);
08eaa4be
ÆAB
585 } else if (opts->new_branch) {
586 if (opts->branch_exists)
587 fprintf(stderr, _("Switched to and reset branch '%s'\n"), new->name);
588 else
589 fprintf(stderr, _("Switched to a new branch '%s'\n"), new->name);
590 } else {
e8a8a4d7 591 fprintf(stderr, _("Switched to branch '%s'\n"),
09a0ec58 592 new->name);
08eaa4be 593 }
782c2d65 594 }
3631bf77
EM
595 if (old->path && old->name) {
596 char log_file[PATH_MAX], ref_file[PATH_MAX];
597
598 git_snpath(log_file, sizeof(log_file), "logs/%s", old->path);
599 git_snpath(ref_file, sizeof(ref_file), "%s", old->path);
600 if (!file_exists(ref_file) && file_exists(log_file))
601 remove_path(log_file);
602 }
782c2d65
DB
603 }
604 remove_branch_state();
605 strbuf_release(&msg);
32669671
JH
606 if (!opts->quiet &&
607 (new->path || (!opts->force_detach && !strcmp(new->name, "HEAD"))))
6d21bf96 608 report_tracking(new);
782c2d65
DB
609}
610
468224e5
RS
611static int add_pending_uninteresting_ref(const char *refname,
612 const unsigned char *sha1,
613 int flags, void *cb_data)
8e2dc6ac 614{
add416a6 615 add_pending_sha1(cb_data, refname, sha1, UNINTERESTING);
5c08dc48
JK
616 return 0;
617}
8e2dc6ac
JH
618
619static void describe_one_orphan(struct strbuf *sb, struct commit *commit)
620{
8e2dc6ac 621 parse_commit(commit);
0be240cc
JK
622 strbuf_addstr(sb, " ");
623 strbuf_addstr(sb,
624 find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV));
625 strbuf_addch(sb, ' ');
f67d2e82 626 pp_commit_easy(CMIT_FMT_ONELINE, commit, sb);
8e2dc6ac
JH
627 strbuf_addch(sb, '\n');
628}
629
630#define ORPHAN_CUTOFF 4
631static void suggest_reattach(struct commit *commit, struct rev_info *revs)
632{
633 struct commit *c, *last = NULL;
634 struct strbuf sb = STRBUF_INIT;
635 int lost = 0;
636 while ((c = get_revision(revs)) != NULL) {
637 if (lost < ORPHAN_CUTOFF)
638 describe_one_orphan(&sb, c);
639 last = c;
640 lost++;
641 }
642 if (ORPHAN_CUTOFF < lost) {
643 int more = lost - ORPHAN_CUTOFF;
644 if (more == 1)
645 describe_one_orphan(&sb, last);
646 else
f06f08b7 647 strbuf_addf(&sb, _(" ... and %d more.\n"), more);
8e2dc6ac
JH
648 }
649
650 fprintf(stderr,
f06f08b7
ÆAB
651 Q_(
652 /* The singular version */
653 "Warning: you are leaving %d commit behind, "
654 "not connected to\n"
655 "any of your branches:\n\n"
0faf2474 656 "%s\n",
f06f08b7
ÆAB
657 /* The plural version */
658 "Warning: you are leaving %d commits behind, "
8e2dc6ac
JH
659 "not connected to\n"
660 "any of your branches:\n\n"
f807b3dc 661 "%s\n",
f06f08b7
ÆAB
662 /* Give ngettext() the count */
663 lost),
664 lost,
f807b3dc 665 sb.buf);
8e2dc6ac 666 strbuf_release(&sb);
f807b3dc
JH
667
668 if (advice_detached_head)
669 fprintf(stderr,
0faf2474 670 _(
f807b3dc
JH
671 "If you want to keep them by creating a new branch, "
672 "this may be a good time\nto do so with:\n\n"
0faf2474 673 " git branch new_branch_name %s\n\n"),
f807b3dc 674 sha1_to_hex(commit->object.sha1));
8e2dc6ac
JH
675}
676
677/*
678 * We are about to leave commit that was at the tip of a detached
679 * HEAD. If it is not reachable from any ref, this is the last chance
680 * for the user to do so without resorting to reflog.
681 */
5d886395 682static void orphaned_commit_warning(struct commit *old, struct commit *new)
8e2dc6ac 683{
8e2dc6ac 684 struct rev_info revs;
5d886395 685 struct object *object = &old->object;
10621419 686 struct object_array refs;
8e2dc6ac
JH
687
688 init_revisions(&revs, NULL);
468224e5
RS
689 setup_revisions(0, NULL, &revs, NULL);
690
691 object->flags &= ~UNINTERESTING;
692 add_pending_object(&revs, object, sha1_to_hex(object->sha1));
693
694 for_each_ref(add_pending_uninteresting_ref, &revs);
5d886395 695 add_pending_sha1(&revs, "HEAD", new->object.sha1, UNINTERESTING);
468224e5 696
10621419
RS
697 refs = revs.pending;
698 revs.leak_pending = 1;
699
8e2dc6ac 700 if (prepare_revision_walk(&revs))
6c80cd29 701 die(_("internal error in revision walk"));
5d886395
JS
702 if (!(old->object.flags & UNINTERESTING))
703 suggest_reattach(old, &revs);
8e2dc6ac 704 else
5d886395 705 describe_detached_head(_("Previous HEAD position was"), old);
5c08dc48 706
86a0a408 707 clear_commit_marks_for_object_array(&refs, ALL_REV_FLAGS);
10621419 708 free(refs.objects);
8e2dc6ac
JH
709}
710
e51e3057
NTND
711static int switch_branches(const struct checkout_opts *opts,
712 struct branch_info *new)
782c2d65
DB
713{
714 int ret = 0;
715 struct branch_info old;
96ec7b1e 716 void *path_to_free;
782c2d65 717 unsigned char rev[20];
a2b4994c 718 int flag, writeout_error = 0;
782c2d65 719 memset(&old, 0, sizeof(old));
96ec7b1e 720 old.path = path_to_free = resolve_refdup("HEAD", rev, 0, &flag);
782c2d65 721 old.commit = lookup_commit_reference_gently(rev, 1);
96ec7b1e 722 if (!(flag & REF_ISSYMREF))
782c2d65
DB
723 old.path = NULL;
724
725 if (old.path && !prefixcmp(old.path, "refs/heads/"))
726 old.name = old.path + strlen("refs/heads/");
727
728 if (!new->name) {
729 new->name = "HEAD";
730 new->commit = old.commit;
731 if (!new->commit)
e8a8a4d7 732 die(_("You are on a branch yet to be born"));
782c2d65
DB
733 parse_commit(new->commit);
734 }
735
a2b4994c 736 ret = merge_working_tree(opts, &old, new, &writeout_error);
96ec7b1e
NTND
737 if (ret) {
738 free(path_to_free);
782c2d65 739 return ret;
96ec7b1e 740 }
782c2d65 741
77ebd56d 742 if (!opts->quiet && !old.path && old.commit && new->commit != old.commit)
5d886395 743 orphaned_commit_warning(old.commit, new->commit);
77ebd56d 744
782c2d65
DB
745 update_refs_for_switch(opts, &old, new);
746
291d823e 747 ret = post_checkout_hook(old.commit, new->commit, 1);
96ec7b1e 748 free(path_to_free);
a2b4994c 749 return ret || writeout_error;
782c2d65
DB
750}
751
0cf8581e
JH
752static int git_checkout_config(const char *var, const char *value, void *cb)
753{
175f6e59
JS
754 if (!strcmp(var, "diff.ignoresubmodules")) {
755 struct checkout_opts *opts = cb;
756 handle_ignore_submodules_arg(&opts->diff_options, value);
757 return 0;
758 }
23b4c7bc
JL
759
760 if (!prefixcmp(var, "submodule."))
761 return parse_submodule_config_option(var, value);
762
175f6e59 763 return git_xmerge_config(var, value, NULL);
0cf8581e
JH
764}
765
e51e3057 766static int interactive_checkout(const char *revision, const char **pathspec)
4f353658
TR
767{
768 return run_add_interactive(revision, "--patch=checkout", pathspec);
769}
770
70c9ac2f
JH
771struct tracking_name_data {
772 const char *name;
773 char *remote;
774 int unique;
775};
776
777static int check_tracking_name(const char *refname, const unsigned char *sha1,
778 int flags, void *cb_data)
779{
780 struct tracking_name_data *cb = cb_data;
781 const char *slash;
782
783 if (prefixcmp(refname, "refs/remotes/"))
784 return 0;
785 slash = strchr(refname + 13, '/');
786 if (!slash || strcmp(slash + 1, cb->name))
787 return 0;
788 if (cb->remote) {
789 cb->unique = 0;
790 return 0;
791 }
792 cb->remote = xstrdup(refname);
793 return 0;
794}
795
796static const char *unique_tracking_name(const char *name)
797{
66dbfd55
GV
798 struct tracking_name_data cb_data = { NULL, NULL, 1 };
799 cb_data.name = name;
70c9ac2f
JH
800 for_each_ref(check_tracking_name, &cb_data);
801 if (cb_data.unique)
802 return cb_data.remote;
803 free(cb_data.remote);
804 return NULL;
805}
4f353658 806
09ebad6f
JN
807static int parse_branchname_arg(int argc, const char **argv,
808 int dwim_new_local_branch_ok,
809 struct branch_info *new,
810 struct tree **source_tree,
811 unsigned char rev[20],
812 const char **new_branch)
813{
814 int argcount = 0;
815 unsigned char branch_rev[20];
816 const char *arg;
817 int has_dash_dash;
818
819 /*
820 * case 1: git checkout <ref> -- [<paths>]
821 *
822 * <ref> must be a valid tree, everything after the '--' must be
823 * a path.
824 *
825 * case 2: git checkout -- [<paths>]
826 *
827 * everything after the '--' must be paths.
828 *
829 * case 3: git checkout <something> [<paths>]
830 *
831 * With no paths, if <something> is a commit, that is to
832 * switch to the branch or detach HEAD at it. As a special case,
833 * if <something> is A...B (missing A or B means HEAD but you can
834 * omit at most one side), and if there is a unique merge base
835 * between A and B, A...B names that merge base.
836 *
837 * With no paths, if <something> is _not_ a commit, no -t nor -b
838 * was given, and there is a tracking branch whose name is
839 * <something> in one and only one remote, then this is a short-hand
c0791f36 840 * to fork local <something> from that remote-tracking branch.
09ebad6f
JN
841 *
842 * Otherwise <something> shall not be ambiguous.
843 * - If it's *only* a reference, treat it like case (1).
844 * - If it's only a path, treat it like case (2).
845 * - else: fail.
846 *
847 */
848 if (!argc)
849 return 0;
850
851 if (!strcmp(argv[0], "--")) /* case (2) */
852 return 1;
853
854 arg = argv[0];
855 has_dash_dash = (argc > 1) && !strcmp(argv[1], "--");
856
857 if (!strcmp(arg, "-"))
858 arg = "@{-1}";
859
860 if (get_sha1_mb(arg, rev)) {
861 if (has_dash_dash) /* case (1) */
6c80cd29 862 die(_("invalid reference: %s"), arg);
09ebad6f
JN
863 if (dwim_new_local_branch_ok &&
864 !check_filename(NULL, arg) &&
865 argc == 1) {
866 const char *remote = unique_tracking_name(arg);
867 if (!remote || get_sha1(remote, rev))
868 return argcount;
869 *new_branch = arg;
870 arg = remote;
871 /* DWIMmed to create local branch */
872 } else {
873 return argcount;
874 }
875 }
876
877 /* we can't end up being in (2) anymore, eat the argument */
878 argcount++;
879 argv++;
880 argc--;
881
882 new->name = arg;
883 setup_branch_path(new);
884
8d9c5010 885 if (!check_refname_format(new->path, 0) &&
c6893323 886 !read_ref(new->path, branch_rev))
09ebad6f
JN
887 hashcpy(rev, branch_rev);
888 else
889 new->path = NULL; /* not an existing branch */
890
891 new->commit = lookup_commit_reference_gently(rev, 1);
892 if (!new->commit) {
893 /* not a commit */
894 *source_tree = parse_tree_indirect(rev);
895 } else {
896 parse_commit(new->commit);
897 *source_tree = new->commit->tree;
898 }
899
900 if (!*source_tree) /* case (1): want a tree */
6c80cd29 901 die(_("reference is not a tree: %s"), arg);
09ebad6f
JN
902 if (!has_dash_dash) {/* case (3 -> 1) */
903 /*
904 * Do not complain the most common case
905 * git checkout branch
906 * even if there happen to be a file called 'branch';
907 * it would be extremely annoying.
908 */
909 if (argc)
910 verify_non_filename(NULL, arg);
911 } else {
912 argcount++;
913 argv++;
914 argc--;
915 }
916
917 return argcount;
918}
919
a2b4994c 920static int switch_unborn_to_new_branch(const struct checkout_opts *opts)
abe19980
JH
921{
922 int status;
923 struct strbuf branch_ref = STRBUF_INIT;
924
8ced1aa0
CW
925 if (!opts->new_branch)
926 die(_("You are on a branch yet to be born"));
abe19980
JH
927 strbuf_addf(&branch_ref, "refs/heads/%s", opts->new_branch);
928 status = create_symref("HEAD", branch_ref.buf, "checkout -b");
929 strbuf_release(&branch_ref);
930 return status;
931}
932
782c2d65
DB
933int cmd_checkout(int argc, const char **argv, const char *prefix)
934{
935 struct checkout_opts opts;
782c2d65 936 struct branch_info new;
eac5a401 937 char *conflict_style = NULL;
46148dd7 938 int dwim_new_local_branch = 1;
782c2d65 939 struct option options[] = {
8c839683 940 OPT__QUIET(&opts.quiet, "suppress progress reporting"),
4c688751
TRC
941 OPT_STRING('b', NULL, &opts.new_branch, "branch",
942 "create and checkout a new branch"),
02ac9837
TRC
943 OPT_STRING('B', NULL, &opts.new_branch_force, "branch",
944 "create/reset and checkout a branch"),
3695dc0a 945 OPT_BOOLEAN('l', NULL, &opts.new_branch_log, "create reflog for new branch"),
32669671 946 OPT_BOOLEAN(0, "detach", &opts.force_detach, "detach the HEAD at named commit"),
3695dc0a 947 OPT_SET_INT('t', "track", &opts.track, "set upstream info for new branch",
9ed36cfa 948 BRANCH_TRACK_EXPLICIT),
9db5ebf4 949 OPT_STRING(0, "orphan", &opts.new_orphan_branch, "new branch", "new unparented branch"),
3695dc0a 950 OPT_SET_INT('2', "ours", &opts.writeout_stage, "checkout our version for unmerged files",
38901a48 951 2),
3695dc0a 952 OPT_SET_INT('3', "theirs", &opts.writeout_stage, "checkout their version for unmerged files",
38901a48 953 3),
76946b76 954 OPT__FORCE(&opts.force, "force checkout (throw away local modifications)"),
3695dc0a 955 OPT_BOOLEAN('m', "merge", &opts.merge, "perform a 3-way merge with the new branch"),
c1d7036b 956 OPT_BOOLEAN(0, "overwrite-ignore", &opts.overwrite_ignore, "update ignored files (default)"),
eac5a401
JH
957 OPT_STRING(0, "conflict", &conflict_style, "style",
958 "conflict style (merge or diff3)"),
e51e3057 959 OPT_BOOLEAN('p', "patch", &opts.patch_mode, "select hunks interactively"),
46148dd7
JH
960 { OPTION_BOOLEAN, 0, "guess", &dwim_new_local_branch, NULL,
961 "second guess 'git checkout no-such-branch'",
962 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
b249b552 963 OPT_END(),
782c2d65
DB
964 };
965
966 memset(&opts, 0, sizeof(opts));
967 memset(&new, 0, sizeof(new));
c1d7036b 968 opts.overwrite_ignore = 1;
e51e3057 969 opts.prefix = prefix;
782c2d65 970
23b4c7bc 971 gitmodules_config();
175f6e59 972 git_config(git_checkout_config, &opts);
782c2d65 973
9188ed89 974 opts.track = BRANCH_TRACK_UNSPECIFIED;
782c2d65 975
37782920 976 argc = parse_options(argc, argv, prefix, options, checkout_usage,
f5242ebf 977 PARSE_OPT_KEEP_DASHDASH);
859fdaba 978
02ac9837
TRC
979 /* we can assume from now on new_branch = !new_branch_force */
980 if (opts.new_branch && opts.new_branch_force)
e8a8a4d7 981 die(_("-B cannot be used with -b"));
02ac9837
TRC
982
983 /* copy -B over to -b, so that we can just check the latter */
984 if (opts.new_branch_force)
985 opts.new_branch = opts.new_branch_force;
986
e51e3057 987 if (opts.patch_mode && (opts.track > 0 || opts.new_branch
32669671
JH
988 || opts.new_branch_log || opts.merge || opts.force
989 || opts.force_detach))
e8a8a4d7 990 die (_("--patch is incompatible with all other options"));
4f353658 991
32669671 992 if (opts.force_detach && (opts.new_branch || opts.new_orphan_branch))
20fc73e3 993 die(_("--detach cannot be used with -b/-B/--orphan"));
32669671 994 if (opts.force_detach && 0 < opts.track)
20fc73e3 995 die(_("--detach cannot be used with -t"));
32669671 996
bb0ceb62 997 /* --track without -b should DWIM */
9188ed89
AR
998 if (0 < opts.track && !opts.new_branch) {
999 const char *argv0 = argv[0];
1000 if (!argc || !strcmp(argv0, "--"))
e8a8a4d7 1001 die (_("--track needs a branch name"));
9188ed89
AR
1002 if (!prefixcmp(argv0, "refs/"))
1003 argv0 += 5;
1004 if (!prefixcmp(argv0, "remotes/"))
1005 argv0 += 8;
1006 argv0 = strchr(argv0, '/');
1007 if (!argv0 || !argv0[1])
e8a8a4d7 1008 die (_("Missing branch name; try -b"));
9188ed89 1009 opts.new_branch = argv0 + 1;
bb0ceb62
JS
1010 }
1011
9db5ebf4
EM
1012 if (opts.new_orphan_branch) {
1013 if (opts.new_branch)
e8a8a4d7 1014 die(_("--orphan and -b|-B are mutually exclusive"));
3631bf77 1015 if (opts.track > 0)
e8a8a4d7 1016 die(_("--orphan cannot be used with -t"));
9db5ebf4
EM
1017 opts.new_branch = opts.new_orphan_branch;
1018 }
1019
eac5a401
JH
1020 if (conflict_style) {
1021 opts.merge = 1; /* implied */
1022 git_xmerge_config("merge.conflictstyle", conflict_style, NULL);
1023 }
1024
859fdaba 1025 if (opts.force && opts.merge)
e8a8a4d7 1026 die(_("git checkout: -f and -m are incompatible"));
859fdaba
PH
1027
1028 /*
09ebad6f
JN
1029 * Extract branch name from command line arguments, so
1030 * all that is left is pathspecs.
859fdaba 1031 *
09ebad6f 1032 * Handle
70c9ac2f 1033 *
09ebad6f
JN
1034 * 1) git checkout <tree> -- [<paths>]
1035 * 2) git checkout -- [<paths>]
1036 * 3) git checkout <something> [<paths>]
859fdaba 1037 *
09ebad6f
JN
1038 * including "last branch" syntax and DWIM-ery for names of
1039 * remote branches, erroring out for invalid or ambiguous cases.
859fdaba 1040 */
782c2d65 1041 if (argc) {
e51e3057 1042 unsigned char rev[20];
09ebad6f 1043 int dwim_ok =
e51e3057 1044 !opts.patch_mode &&
09ebad6f
JN
1045 dwim_new_local_branch &&
1046 opts.track == BRANCH_TRACK_UNSPECIFIED &&
1047 !opts.new_branch;
f8bd36a4 1048 int n = parse_branchname_arg(argc, argv, dwim_ok,
e51e3057
NTND
1049 &new, &opts.source_tree,
1050 rev, &opts.new_branch);
09ebad6f
JN
1051 argv += n;
1052 argc -= n;
782c2d65
DB
1053 }
1054
70c9ac2f
JH
1055 if (opts.track == BRANCH_TRACK_UNSPECIFIED)
1056 opts.track = git_branch_track;
1057
782c2d65 1058 if (argc) {
e51e3057 1059 opts.pathspec = get_pathspec(prefix, argv);
301e42ed 1060
e51e3057 1061 if (!opts.pathspec)
e8a8a4d7 1062 die(_("invalid path specification"));
301e42ed 1063
e51e3057
NTND
1064 if (opts.patch_mode)
1065 return interactive_checkout(new.name, opts.pathspec);
4f353658 1066
782c2d65 1067 /* Checkout paths */
0cf8581e 1068 if (opts.new_branch) {
782c2d65 1069 if (argc == 1) {
e8a8a4d7 1070 die(_("git checkout: updating paths is incompatible with switching branches.\nDid you intend to checkout '%s' which can not be resolved as commit?"), argv[0]);
782c2d65 1071 } else {
e8a8a4d7 1072 die(_("git checkout: updating paths is incompatible with switching branches."));
782c2d65
DB
1073 }
1074 }
1075
32669671 1076 if (opts.force_detach)
20fc73e3 1077 die(_("git checkout: --detach does not take a path argument"));
32669671 1078
0cf8581e 1079 if (1 < !!opts.writeout_stage + !!opts.force + !!opts.merge)
e8a8a4d7 1080 die(_("git checkout: --ours/--theirs, --force and --merge are incompatible when\nchecking out of the index."));
0cf8581e 1081
e51e3057 1082 return checkout_paths(&opts);
782c2d65
DB
1083 }
1084
e51e3057
NTND
1085 if (opts.patch_mode)
1086 return interactive_checkout(new.name, NULL);
4f353658 1087
352eadc4 1088 if (opts.new_branch) {
f285a2d7 1089 struct strbuf buf = STRBUF_INIT;
55c4a673 1090
fa799376 1091 opts.branch_exists = validate_new_branchname(opts.new_branch, &buf,
39bd6f72
JN
1092 !!opts.new_branch_force,
1093 !!opts.new_branch_force);
55c4a673 1094
352eadc4
DB
1095 strbuf_release(&buf);
1096 }
1097
782c2d65 1098 if (new.name && !new.commit) {
e8a8a4d7 1099 die(_("Cannot switch branch to a non-commit."));
782c2d65 1100 }
38901a48 1101 if (opts.writeout_stage)
e8a8a4d7 1102 die(_("--ours/--theirs is incompatible with switching branches."));
782c2d65 1103
8338f771 1104 if (!new.commit && opts.new_branch) {
abe19980
JH
1105 unsigned char rev[20];
1106 int flag;
1107
aa47ec99
JH
1108 if (!read_ref_full("HEAD", rev, 0, &flag) &&
1109 (flag & REF_ISSYMREF) && is_null_sha1(rev))
abe19980
JH
1110 return switch_unborn_to_new_branch(&opts);
1111 }
75ea38df 1112 return switch_branches(&opts, &new);
782c2d65 1113}