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