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