worktree.c: get_worktrees() takes a new flag argument
[git/git.git] / builtin / branch.c
CommitLineData
c31820c2
LH
1/*
2 * Builtin "git branch"
3 *
d972cce0 4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
c31820c2
LH
5 * Based on git-branch.sh by Junio C Hamano.
6 */
7
8#include "cache.h"
85023577 9#include "color.h"
c31820c2
LH
10#include "refs.h"
11#include "commit.h"
12#include "builtin.h"
6f084a56 13#include "remote.h"
a8dfd5ea 14#include "parse-options.h"
e496c003 15#include "branch.h"
68067ca1
JH
16#include "diff.h"
17#include "revision.h"
ebe31ef2
NTND
18#include "string-list.h"
19#include "column.h"
1452bd64 20#include "utf8.h"
c8183cd2 21#include "wt-status.h"
1511b22d 22#include "ref-filter.h"
f292244c 23#include "worktree.h"
a8dfd5ea
PH
24
25static const char * const builtin_branch_usage[] = {
9c9b4f2f
AH
26 N_("git branch [<options>] [-r | -a] [--merged | --no-merged]"),
27 N_("git branch [<options>] [-l] [-f] <branch-name> [<start-point>]"),
28 N_("git branch [<options>] [-r] (-d | -D) <branch-name>..."),
29 N_("git branch [<options>] (-m | -M) [<old-branch>] <new-branch>"),
aa3bc55e 30 N_("git branch [<options>] [-r | -a] [--points-at]"),
a8dfd5ea
PH
31 NULL
32};
c31820c2 33
c31820c2
LH
34static const char *head;
35static unsigned char head_sha1[20];
36
6b2f2d98 37static int branch_use_color = -1;
a1158cae 38static char branch_colors[][COLOR_MAXLEN] = {
dc6ebd4c
AL
39 GIT_COLOR_RESET,
40 GIT_COLOR_NORMAL, /* PLAIN */
41 GIT_COLOR_RED, /* REMOTE */
42 GIT_COLOR_NORMAL, /* LOCAL */
43 GIT_COLOR_GREEN, /* CURRENT */
dbda21fa 44 GIT_COLOR_BLUE, /* UPSTREAM */
a1158cae
AP
45};
46enum color_branch {
74bb2dfb
AL
47 BRANCH_COLOR_RESET = 0,
48 BRANCH_COLOR_PLAIN = 1,
49 BRANCH_COLOR_REMOTE = 2,
50 BRANCH_COLOR_LOCAL = 3,
dbda21fa
FC
51 BRANCH_COLOR_CURRENT = 4,
52 BRANCH_COLOR_UPSTREAM = 5
a1158cae
AP
53};
54
ebe31ef2
NTND
55static struct string_list output = STRING_LIST_INIT_DUP;
56static unsigned int colopts;
57
8852117a 58static int parse_branch_color_slot(const char *slot)
a1158cae 59{
8852117a 60 if (!strcasecmp(slot, "plain"))
74bb2dfb 61 return BRANCH_COLOR_PLAIN;
8852117a 62 if (!strcasecmp(slot, "reset"))
74bb2dfb 63 return BRANCH_COLOR_RESET;
8852117a 64 if (!strcasecmp(slot, "remote"))
74bb2dfb 65 return BRANCH_COLOR_REMOTE;
8852117a 66 if (!strcasecmp(slot, "local"))
74bb2dfb 67 return BRANCH_COLOR_LOCAL;
8852117a 68 if (!strcasecmp(slot, "current"))
74bb2dfb 69 return BRANCH_COLOR_CURRENT;
8852117a 70 if (!strcasecmp(slot, "upstream"))
dbda21fa 71 return BRANCH_COLOR_UPSTREAM;
8b8e8624 72 return -1;
a1158cae
AP
73}
74
ef90d6d4 75static int git_branch_config(const char *var, const char *value, void *cb)
a1158cae 76{
e3f1da98
RS
77 const char *slot_name;
78
59556548 79 if (starts_with(var, "column."))
ebe31ef2 80 return git_column_config(var, value, "branch", &colopts);
a1158cae 81 if (!strcmp(var, "color.branch")) {
e269eb79 82 branch_use_color = git_config_colorbool(var, value);
a1158cae
AP
83 return 0;
84 }
e3f1da98 85 if (skip_prefix(var, "color.branch.", &slot_name)) {
b9465768 86 int slot = parse_branch_color_slot(slot_name);
8b8e8624
JK
87 if (slot < 0)
88 return 0;
5768c98a
JH
89 if (!value)
90 return config_error_nonbool(var);
f6c5a296 91 return color_parse(value, branch_colors[slot]);
a1158cae 92 }
ef90d6d4 93 return git_color_default_config(var, value, cb);
a1158cae
AP
94}
95
52fae7de 96static const char *branch_get_color(enum color_branch ix)
a1158cae 97{
daa0c3d9 98 if (want_color(branch_use_color))
a1158cae
AP
99 return branch_colors[ix];
100 return "";
101}
102
99c419c9
JH
103static int branch_merged(int kind, const char *name,
104 struct commit *rev, struct commit *head_rev)
105{
106 /*
107 * This checks whether the merge bases of branch and HEAD (or
108 * the other branch this branch builds upon) contains the
109 * branch, which means that the branch has already been merged
110 * safely to HEAD (or the other branch).
111 */
112 struct commit *reference_rev = NULL;
113 const char *reference_name = NULL;
96ec7b1e 114 void *reference_name_to_free = NULL;
99c419c9
JH
115 int merged;
116
1511b22d 117 if (kind == FILTER_REFS_BRANCHES) {
99c419c9 118 struct branch *branch = branch_get(name);
3a429d0a 119 const char *upstream = branch_get_upstream(branch, NULL);
99c419c9
JH
120 unsigned char sha1[20];
121
a9f9f8cc 122 if (upstream &&
96ec7b1e 123 (reference_name = reference_name_to_free =
a9f9f8cc 124 resolve_refdup(upstream, RESOLVE_REF_READING,
7695d118 125 sha1, NULL)) != NULL)
99c419c9
JH
126 reference_rev = lookup_commit_reference(sha1);
127 }
128 if (!reference_rev)
129 reference_rev = head_rev;
130
a20efee9 131 merged = in_merge_bases(rev, reference_rev);
99c419c9
JH
132
133 /*
134 * After the safety valve is fully redefined to "check with
135 * upstream, if any, otherwise with HEAD", we should just
136 * return the result of the in_merge_bases() above without
137 * any of the following code, but during the transition period,
138 * a gentle reminder is in order.
139 */
140 if ((head_rev != reference_rev) &&
a20efee9 141 in_merge_bases(rev, head_rev) != merged) {
99c419c9 142 if (merged)
49df4b02 143 warning(_("deleting branch '%s' that has been merged to\n"
6c80cd29 144 " '%s', but not yet merged to HEAD."),
99c419c9
JH
145 name, reference_name);
146 else
49df4b02
ÆAB
147 warning(_("not deleting branch '%s' that is not yet merged to\n"
148 " '%s', even though it is merged to HEAD."),
99c419c9
JH
149 name, reference_name);
150 }
96ec7b1e 151 free(reference_name_to_free);
99c419c9
JH
152 return merged;
153}
154
f5d0e162 155static int check_branch_commit(const char *branchname, const char *refname,
4eaa4bd8 156 const unsigned char *sha1, struct commit *head_rev,
f5d0e162
RS
157 int kinds, int force)
158{
159 struct commit *rev = lookup_commit_reference(sha1);
160 if (!rev) {
161 error(_("Couldn't look up commit object for '%s'"), refname);
162 return -1;
163 }
164 if (!force && !branch_merged(kinds, branchname, rev, head_rev)) {
165 error(_("The branch '%s' is not fully merged.\n"
166 "If you are sure you want to delete it, "
167 "run 'git branch -D %s'."), branchname, branchname);
168 return -1;
169 }
170 return 0;
171}
172
22ed7927
RS
173static void delete_branch_config(const char *branchname)
174{
175 struct strbuf buf = STRBUF_INIT;
176 strbuf_addf(&buf, "branch.%s", branchname);
177 if (git_config_rename_section(buf.buf, NULL) < 0)
178 warning(_("Update of config-file failed"));
179 strbuf_release(&buf);
180}
181
d65ddf19
JK
182static int delete_branches(int argc, const char **argv, int force, int kinds,
183 int quiet)
c31820c2 184{
f5d0e162 185 struct commit *head_rev = NULL;
c31820c2 186 unsigned char sha1[20];
b8e9a00d 187 char *name = NULL;
c179837c 188 const char *fmt;
c31820c2 189 int i;
b8e9a00d 190 int ret = 0;
c179837c 191 int remote_branch = 0;
8415d5c7 192 struct strbuf bname = STRBUF_INIT;
c31820c2 193
f3d985c3 194 switch (kinds) {
1511b22d 195 case FILTER_REFS_REMOTES:
f3d985c3 196 fmt = "refs/remotes/%s";
c179837c
ÆAB
197 /* For subsequent UI messages */
198 remote_branch = 1;
199
f3d985c3
JH
200 force = 1;
201 break;
1511b22d 202 case FILTER_REFS_BRANCHES:
f3d985c3 203 fmt = "refs/heads/%s";
f3d985c3
JH
204 break;
205 default:
49df4b02 206 die(_("cannot use -a with -d"));
f3d985c3 207 }
c31820c2 208
67affd51
JH
209 if (!force) {
210 head_rev = lookup_commit_reference(head_sha1);
211 if (!head_rev)
49df4b02 212 die(_("Couldn't look up commit object for HEAD"));
67affd51 213 }
8415d5c7 214 for (i = 0; i < argc; i++, strbuf_release(&bname)) {
8bb04553 215 char *target = NULL;
0fe700e3
RS
216 int flags = 0;
217
a552de75 218 strbuf_branchname(&bname, argv[i]);
8e0f7003 219 free(name);
4e2d094d 220 name = mkpathdup(fmt, bname.buf);
f292244c
KY
221
222 if (kinds == FILTER_REFS_BRANCHES) {
d3b9ac07
NTND
223 const struct worktree *wt =
224 find_shared_symref("HEAD", name);
225 if (wt) {
f292244c
KY
226 error(_("Cannot delete branch '%s' "
227 "checked out at '%s'"),
d3b9ac07 228 bname.buf, wt->path);
f292244c
KY
229 ret = 1;
230 continue;
231 }
232 }
233
8bb04553
MH
234 target = resolve_refdup(name,
235 RESOLVE_REF_READING
236 | RESOLVE_REF_NO_RECURSE
237 | RESOLVE_REF_ALLOW_BAD_NAME,
238 sha1, &flags);
18f29fc6 239 if (!target) {
c179837c 240 error(remote_branch
ccd593cf 241 ? _("remote-tracking branch '%s' not found.")
c179837c 242 : _("branch '%s' not found."), bname.buf);
b8e9a00d
QT
243 ret = 1;
244 continue;
245 }
c31820c2 246
d0f810f0 247 if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
0fe700e3 248 check_branch_commit(bname.buf, name, sha1, head_rev, kinds,
f5d0e162 249 force)) {
b8e9a00d 250 ret = 1;
8bb04553 251 goto next;
c31820c2
LH
252 }
253
1c03c4d3
MH
254 if (delete_ref(name, is_null_sha1(sha1) ? NULL : sha1,
255 REF_NODEREF)) {
c179837c 256 error(remote_branch
ccd593cf 257 ? _("Error deleting remote-tracking branch '%s'")
c179837c 258 : _("Error deleting branch '%s'"),
8415d5c7 259 bname.buf);
b8e9a00d 260 ret = 1;
8bb04553 261 goto next;
13baa9fe
RS
262 }
263 if (!quiet) {
264 printf(remote_branch
ccd593cf 265 ? _("Deleted remote-tracking branch %s (was %s).\n")
13baa9fe
RS
266 : _("Deleted branch %s (was %s).\n"),
267 bname.buf,
d0f810f0
RS
268 (flags & REF_ISBROKEN) ? "broken"
269 : (flags & REF_ISSYMREF) ? target
13baa9fe 270 : find_unique_abbrev(sha1, DEFAULT_ABBREV));
f1eccbab 271 }
13baa9fe 272 delete_branch_config(bname.buf);
8bb04553
MH
273
274 next:
275 free(target);
c31820c2 276 }
c31820c2 277
8e0f7003 278 free(name);
b8e9a00d
QT
279
280 return(ret);
c31820c2 281}
c31820c2 282
2d8a7f0b
JK
283static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
284 int show_upstream_ref)
94fcb730
JH
285{
286 int ours, theirs;
21dfc09d 287 char *ref = NULL;
94fcb730 288 struct branch *branch = branch_get(branch_name);
979cb245 289 const char *upstream;
dbda21fa 290 struct strbuf fancy = STRBUF_INIT;
f2e08739 291 int upstream_is_gone = 0;
6b364d48 292 int added_decoration = 1;
94fcb730 293
979cb245
JK
294 if (stat_tracking_info(branch, &ours, &theirs, &upstream) < 0) {
295 if (!upstream)
296 return;
f2e08739 297 upstream_is_gone = 1;
2d8a7f0b
JK
298 }
299
dbda21fa 300 if (show_upstream_ref) {
979cb245 301 ref = shorten_unambiguous_ref(upstream, 0);
dbda21fa
FC
302 if (want_color(branch_use_color))
303 strbuf_addf(&fancy, "%s%s%s",
304 branch_get_color(BRANCH_COLOR_UPSTREAM),
305 ref, branch_get_color(BRANCH_COLOR_RESET));
306 else
307 strbuf_addstr(&fancy, ref);
308 }
309
f2e08739
JX
310 if (upstream_is_gone) {
311 if (show_upstream_ref)
312 strbuf_addf(stat, _("[%s: gone]"), fancy.buf);
6b364d48
TH
313 else
314 added_decoration = 0;
f2e08739
JX
315 } else if (!ours && !theirs) {
316 if (show_upstream_ref)
317 strbuf_addf(stat, _("[%s]"), fancy.buf);
6b364d48
TH
318 else
319 added_decoration = 0;
f2e08739
JX
320 } else if (!ours) {
321 if (show_upstream_ref)
dbda21fa 322 strbuf_addf(stat, _("[%s: behind %d]"), fancy.buf, theirs);
21dfc09d
NTND
323 else
324 strbuf_addf(stat, _("[behind %d]"), theirs);
325
326 } else if (!theirs) {
f2e08739 327 if (show_upstream_ref)
dbda21fa 328 strbuf_addf(stat, _("[%s: ahead %d]"), fancy.buf, ours);
21dfc09d
NTND
329 else
330 strbuf_addf(stat, _("[ahead %d]"), ours);
331 } else {
f2e08739 332 if (show_upstream_ref)
21dfc09d 333 strbuf_addf(stat, _("[%s: ahead %d, behind %d]"),
dbda21fa 334 fancy.buf, ours, theirs);
21dfc09d
NTND
335 else
336 strbuf_addf(stat, _("[ahead %d, behind %d]"),
337 ours, theirs);
338 }
dbda21fa 339 strbuf_release(&fancy);
6b364d48
TH
340 if (added_decoration)
341 strbuf_addch(stat, ' ');
21dfc09d 342 free(ref);
94fcb730
JH
343}
344
1511b22d 345static void add_verbose_info(struct strbuf *out, struct ref_array_item *item,
aedcb7dc 346 struct ref_filter *filter, const char *refname)
6e0332ec
JN
347{
348 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
045e3884 349 const char *sub = _(" **** invalid ref ****");
6e0332ec
JN
350 struct commit *commit = item->commit;
351
5e7d4d3e 352 if (!parse_commit(commit)) {
f67d2e82 353 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
6e0332ec
JN
354 sub = subject.buf;
355 }
356
1511b22d 357 if (item->kind == FILTER_REFS_BRANCHES)
aedcb7dc 358 fill_tracking_info(&stat, refname, filter->verbose > 1);
6e0332ec
JN
359
360 strbuf_addf(out, " %s %s%s",
ed1c9977 361 find_unique_abbrev(item->commit->object.oid.hash, filter->abbrev),
6e0332ec
JN
362 stat.buf, sub);
363 strbuf_release(&stat);
364 strbuf_release(&subject);
365}
366
2dad24a5
KN
367static char *get_head_description(void)
368{
369 struct strbuf desc = STRBUF_INIT;
370 struct wt_status_state state;
371 memset(&state, 0, sizeof(state));
372 wt_status_get_state(&state, 1);
373 if (state.rebase_in_progress ||
374 state.rebase_interactive_in_progress)
375 strbuf_addf(&desc, _("(no branch, rebasing %s)"),
376 state.branch);
377 else if (state.bisect_in_progress)
378 strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
379 state.branch);
380 else if (state.detached_from) {
2dad24a5 381 if (state.detached_at)
60ea78b8
VA
382 /* TRANSLATORS: make sure this matches
383 "HEAD detached at " in wt-status.c */
2dad24a5
KN
384 strbuf_addf(&desc, _("(HEAD detached at %s)"),
385 state.detached_from);
386 else
60ea78b8
VA
387 /* TRANSLATORS: make sure this matches
388 "HEAD detached from " in wt-status.c */
2dad24a5
KN
389 strbuf_addf(&desc, _("(HEAD detached from %s)"),
390 state.detached_from);
391 }
392 else
393 strbuf_addstr(&desc, _("(no branch)"));
394 free(state.branch);
395 free(state.onto);
396 free(state.detached_from);
397 return strbuf_detach(&desc, NULL);
398}
399
aedcb7dc
KN
400static void format_and_print_ref_item(struct ref_array_item *item, int maxwidth,
401 struct ref_filter *filter, const char *remote_prefix)
75e6e213 402{
af0e4ac0 403 char c;
f65f1391 404 int current = 0;
af0e4ac0 405 int color;
209d336a 406 struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
95c38fb0
JK
407 const char *prefix_to_show = "";
408 const char *prefix_to_skip = NULL;
1511b22d 409 const char *desc = item->refname;
23e714df 410 char *to_free = NULL;
75e6e213 411
af0e4ac0 412 switch (item->kind) {
1511b22d 413 case FILTER_REFS_BRANCHES:
95c38fb0
JK
414 prefix_to_skip = "refs/heads/";
415 skip_prefix(desc, prefix_to_skip, &desc);
aedcb7dc 416 if (!filter->detached && !strcmp(desc, head))
f65f1391
KN
417 current = 1;
418 else
419 color = BRANCH_COLOR_LOCAL;
af0e4ac0 420 break;
1511b22d 421 case FILTER_REFS_REMOTES:
95c38fb0
JK
422 prefix_to_skip = "refs/remotes/";
423 skip_prefix(desc, prefix_to_skip, &desc);
74bb2dfb 424 color = BRANCH_COLOR_REMOTE;
95c38fb0 425 prefix_to_show = remote_prefix;
af0e4ac0 426 break;
1511b22d 427 case FILTER_REFS_DETACHED_HEAD:
23e714df 428 desc = to_free = get_head_description();
f65f1391 429 current = 1;
af0e4ac0
LH
430 break;
431 default:
74bb2dfb 432 color = BRANCH_COLOR_PLAIN;
af0e4ac0
LH
433 break;
434 }
75e6e213 435
af0e4ac0
LH
436 c = ' ';
437 if (current) {
438 c = '*';
74bb2dfb 439 color = BRANCH_COLOR_CURRENT;
af0e4ac0 440 }
75e6e213 441
95c38fb0 442 strbuf_addf(&name, "%s%s", prefix_to_show, desc);
1511b22d 443 if (filter->verbose) {
1452bd64 444 int utf8_compensation = strlen(name.buf) - utf8_strwidth(name.buf);
209d336a 445 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
1452bd64 446 maxwidth + utf8_compensation, name.buf,
81474267 447 branch_get_color(BRANCH_COLOR_RESET));
1452bd64 448 } else
209d336a 449 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
81474267 450 name.buf, branch_get_color(BRANCH_COLOR_RESET));
209d336a 451
aedcb7dc 452 if (item->symref) {
95c38fb0
JK
453 const char *symref = item->symref;
454 if (prefix_to_skip)
455 skip_prefix(symref, prefix_to_skip, &symref);
456 strbuf_addf(&out, " -> %s", symref);
aedcb7dc 457 }
1511b22d 458 else if (filter->verbose)
6e0332ec 459 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
aedcb7dc 460 add_verbose_info(&out, item, filter, desc);
ebe31ef2 461 if (column_active(colopts)) {
1511b22d 462 assert(!filter->verbose && "--column and --verbose are incompatible");
ebe31ef2
NTND
463 string_list_append(&output, out.buf);
464 } else {
465 printf("%s\n", out.buf);
466 }
209d336a
JS
467 strbuf_release(&name);
468 strbuf_release(&out);
23e714df 469 free(to_free);
75e6e213
LH
470}
471
1511b22d 472static int calc_maxwidth(struct ref_array *refs, int remote_bonus)
7e9ff00b 473{
1051e40d 474 int i, max = 0;
1511b22d
KN
475 for (i = 0; i < refs->nr; i++) {
476 struct ref_array_item *it = refs->items[i];
aedcb7dc 477 const char *desc = it->refname;
1051e40d
KN
478 int w;
479
aedcb7dc
KN
480 skip_prefix(it->refname, "refs/heads/", &desc);
481 skip_prefix(it->refname, "refs/remotes/", &desc);
482 w = utf8_strwidth(desc);
483
1511b22d 484 if (it->kind == FILTER_REFS_REMOTES)
1051e40d
KN
485 w += remote_bonus;
486 if (w > max)
487 max = w;
7e9ff00b 488 }
1051e40d 489 return max;
7e9ff00b
LT
490}
491
aedcb7dc 492static void print_ref_list(struct ref_filter *filter, struct ref_sorting *sorting)
c31820c2
LH
493{
494 int i;
1511b22d 495 struct ref_array array;
1051e40d
KN
496 int maxwidth = 0;
497 const char *remote_prefix = "";
498
35257aa0 499 /*
1051e40d
KN
500 * If we are listing more than just remote branches,
501 * then remote branches will have a "remotes/" prefix.
502 * We need to account for this in the width.
35257aa0 503 */
1511b22d 504 if (filter->kind != FILTER_REFS_REMOTES)
1051e40d 505 remote_prefix = "remotes/";
8376a704 506
1511b22d 507 memset(&array, 0, sizeof(array));
8376a704 508
aedcb7dc
KN
509 verify_ref_format("%(refname)%(symref)");
510 filter_refs(&array, filter, filter->kind | FILTER_REFS_INCLUDE_BROKEN);
c31820c2 511
1511b22d
KN
512 if (filter->verbose)
513 maxwidth = calc_maxwidth(&array, strlen(remote_prefix));
bfcc9214 514
aedcb7dc
KN
515 /*
516 * If no sorting parameter is given then we default to sorting
517 * by 'refname'. This would give us an alphabetically sorted
518 * array with the 'HEAD' ref at the beginning followed by
519 * local branches 'refs/heads/...' and finally remote-tacking
520 * branches 'refs/remotes/...'.
521 */
522 if (!sorting)
523 sorting = ref_default_sorting();
524 ref_array_sort(sorting, &array);
1603ade8 525
1511b22d 526 for (i = 0; i < array.nr; i++)
aedcb7dc 527 format_and_print_ref_item(array.items[i], maxwidth, filter, remote_prefix);
0e9716e6 528
1511b22d 529 ref_array_clear(&array);
c31820c2
LH
530}
531
14ace5b7
NTND
532static void reject_rebase_or_bisect_branch(const char *target)
533{
4fff1ef7 534 struct worktree **worktrees = get_worktrees(0);
14ace5b7
NTND
535 int i;
536
537 for (i = 0; worktrees[i]; i++) {
538 struct worktree *wt = worktrees[i];
539
540 if (!wt->is_detached)
541 continue;
542
543 if (is_worktree_being_rebased(wt, target))
544 die(_("Branch %s is being rebased at %s"),
545 target, wt->path);
546
547 if (is_worktree_being_bisected(wt, target))
548 die(_("Branch %s is being bisected at %s"),
549 target, wt->path);
550 }
551
552 free_worktrees(worktrees);
553}
554
c976d415
LH
555static void rename_branch(const char *oldname, const char *newname, int force)
556{
da3f78a2 557 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
da3f78a2 558 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
cbdffe40 559 int recovery = 0;
3f59481e 560 int clobber_head_ok;
c976d415 561
c847f537 562 if (!oldname)
49df4b02 563 die(_("cannot rename the current branch while not on any."));
c847f537 564
cbdffe40
JH
565 if (strbuf_check_branch_ref(&oldref, oldname)) {
566 /*
567 * Bad name --- this could be an attempt to rename a
568 * ref that we used to allow to be created by accident.
569 */
c6893323 570 if (ref_exists(oldref.buf))
cbdffe40
JH
571 recovery = 1;
572 else
49df4b02 573 die(_("Invalid branch name: '%s'"), oldname);
cbdffe40 574 }
c976d415 575
3f59481e
JN
576 /*
577 * A command like "git branch -M currentbranch currentbranch" cannot
578 * cause the worktree to become inconsistent with HEAD, so allow it.
579 */
580 clobber_head_ok = !strcmp(oldname, newname);
581
582 validate_new_branchname(newname, &newref, force, clobber_head_ok);
c976d415 583
14ace5b7
NTND
584 reject_rebase_or_bisect_branch(oldref.buf);
585
da3f78a2
MV
586 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
587 oldref.buf, newref.buf);
678d0f4c 588
da3f78a2 589 if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
49df4b02 590 die(_("Branch rename failed"));
da3f78a2 591 strbuf_release(&logmsg);
c976d415 592
cbdffe40 593 if (recovery)
49df4b02 594 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
cbdffe40 595
70999e9c 596 if (replace_each_worktree_head_symref(oldref.buf, newref.buf))
49df4b02 597 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
19eba151 598
da3f78a2
MV
599 strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
600 strbuf_release(&oldref);
601 strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
602 strbuf_release(&newref);
603 if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
49df4b02 604 die(_("Branch is renamed, but update of config-file failed"));
da3f78a2
MV
605 strbuf_release(&oldsection);
606 strbuf_release(&newsection);
c976d415
LH
607}
608
b7200e83
JH
609static const char edit_description[] = "BRANCH_DESCRIPTION";
610
611static int edit_branch_description(const char *branch_name)
612{
b7200e83
JH
613 struct strbuf buf = STRBUF_INIT;
614 struct strbuf name = STRBUF_INIT;
615
616 read_branch_desc(&buf, branch_name);
617 if (!buf.len || buf.buf[buf.len-1] != '\n')
618 strbuf_addch(&buf, '\n');
eff80a9f 619 strbuf_commented_addf(&buf,
b18237f4
VA
620 _("Please edit the description for the branch\n"
621 " %s\n"
622 "Lines starting with '%c' will be stripped.\n"),
eff80a9f 623 branch_name, comment_line_char);
7eb6e10c 624 write_file_buf(git_path(edit_description), buf.buf, buf.len);
b7200e83
JH
625 strbuf_reset(&buf);
626 if (launch_editor(git_path(edit_description), &buf, NULL)) {
627 strbuf_release(&buf);
628 return -1;
629 }
63af4a84 630 strbuf_stripspace(&buf, 1);
b7200e83
JH
631
632 strbuf_addf(&name, "branch.%s.description", branch_name);
3d180648 633 git_config_set(name.buf, buf.len ? buf.buf : NULL);
b7200e83
JH
634 strbuf_release(&name);
635 strbuf_release(&buf);
636
bd25f890 637 return 0;
b7200e83
JH
638}
639
c31820c2
LH
640int cmd_branch(int argc, const char **argv, const char *prefix)
641{
356e91f2 642 int delete = 0, rename = 0, force = 0, list = 0;
b7200e83 643 int reflog = 0, edit_description = 0;
b84869ef 644 int quiet = 0, unset_upstream = 0;
6183d826 645 const char *new_upstream = NULL;
9ed36cfa 646 enum branch_track track;
1511b22d 647 struct ref_filter filter;
aedcb7dc 648 static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
a8dfd5ea
PH
649
650 struct option options[] = {
24a85214 651 OPT_GROUP(N_("Generic options")),
1511b22d 652 OPT__VERBOSE(&filter.verbose,
24a85214
NTND
653 N_("show hash and subject, give twice for upstream branch")),
654 OPT__QUIET(&quiet, N_("suppress informational messages")),
655 OPT_SET_INT('t', "track", &track, N_("set up tracking mode (see git-pull(1))"),
9ed36cfa 656 BRANCH_TRACK_EXPLICIT),
24a85214 657 OPT_SET_INT( 0, "set-upstream", &track, N_("change upstream info"),
4fc50066 658 BRANCH_TRACK_OVERRIDE),
ab86885a 659 OPT_STRING('u', "set-upstream-to", &new_upstream, N_("upstream"), N_("change the upstream info")),
fb4cc6a9 660 OPT_BOOL(0, "unset-upstream", &unset_upstream, N_("Unset the upstream info")),
24a85214 661 OPT__COLOR(&branch_use_color, N_("use colored output")),
1511b22d
KN
662 OPT_SET_INT('r', "remotes", &filter.kind, N_("act on remote-tracking branches"),
663 FILTER_REFS_REMOTES),
664 OPT_CONTAINS(&filter.with_commit, N_("print only branches that contain the commit")),
665 OPT_WITH(&filter.with_commit, N_("print only branches that contain the commit")),
666 OPT__ABBREV(&filter.abbrev),
a8dfd5ea 667
24a85214 668 OPT_GROUP(N_("Specific git-branch actions:")),
1511b22d
KN
669 OPT_SET_INT('a', "all", &filter.kind, N_("list both remote-tracking and local branches"),
670 FILTER_REFS_REMOTES | FILTER_REFS_BRANCHES),
24a85214
NTND
671 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
672 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
673 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
674 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
d5d09d47
SB
675 OPT_BOOL(0, "list", &list, N_("list branch names")),
676 OPT_BOOL('l', "create-reflog", &reflog, N_("create the branch's reflog")),
677 OPT_BOOL(0, "edit-description", &edit_description,
678 N_("edit the description for the branch")),
356e91f2 679 OPT__FORCE(&force, N_("force creation, move/rename, deletion")),
1511b22d
KN
680 OPT_MERGED(&filter, N_("print only branches that are merged")),
681 OPT_NO_MERGED(&filter, N_("print only branches that are not merged")),
24a85214 682 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
aedcb7dc
KN
683 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
684 N_("field name to sort on"), &parse_opt_ref_sorting),
049716b3 685 {
aa3bc55e
KN
686 OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
687 N_("print only branches of the object"), 0, parse_opt_object_name
049716b3 688 },
a8dfd5ea
PH
689 OPT_END(),
690 };
c31820c2 691
1511b22d
KN
692 memset(&filter, 0, sizeof(filter));
693 filter.kind = FILTER_REFS_BRANCHES;
694 filter.abbrev = -1;
695
1dacfbcf
NTND
696 if (argc == 2 && !strcmp(argv[1], "-h"))
697 usage_with_options(builtin_branch_usage, options);
698
ef90d6d4 699 git_config(git_branch_config, NULL);
6b2f2d98 700
9ed36cfa 701 track = git_branch_track;
c976d415 702
7695d118 703 head = resolve_refdup("HEAD", 0, head_sha1, NULL);
c31820c2 704 if (!head)
49df4b02 705 die(_("Failed to resolve HEAD as a valid ref."));
e3f1da98 706 if (!strcmp(head, "HEAD"))
1511b22d 707 filter.detached = 1;
e3f1da98
RS
708 else if (!skip_prefix(head, "refs/heads/", &head))
709 die(_("HEAD not found below refs/heads!"));
ebe31ef2 710
37782920
SB
711 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
712 0);
cddd127b 713
b84869ef 714 if (!delete && !rename && !edit_description && !new_upstream && !unset_upstream && argc == 0)
cddd127b
MG
715 list = 1;
716
aa3bc55e 717 if (filter.with_commit || filter.merge != REF_FILTER_MERGED_NONE || filter.points_at.nr)
d0403508
JK
718 list = 1;
719
356e91f2 720 if (!!delete + !!rename + !!new_upstream +
05efb7b7 721 list + unset_upstream > 1)
049716b3 722 usage_with_options(builtin_branch_usage, options);
c31820c2 723
1511b22d
KN
724 if (filter.abbrev == -1)
725 filter.abbrev = DEFAULT_ABBREV;
ebe31ef2 726 finalize_colopts(&colopts, -1);
1511b22d 727 if (filter.verbose) {
ebe31ef2
NTND
728 if (explicitly_enable_column(colopts))
729 die(_("--column and --verbose are incompatible"));
730 colopts = 0;
731 }
b792c067 732
356e91f2
MG
733 if (force) {
734 delete *= 2;
735 rename *= 2;
736 }
737
640d0401
NTND
738 if (delete) {
739 if (!argc)
740 die(_("branch name required"));
1511b22d 741 return delete_branches(argc, argv, delete > 1, filter.kind, quiet);
640d0401 742 } else if (list) {
23e714df 743 /* git branch --local also shows HEAD when it is detached */
1511b22d
KN
744 if ((filter.kind & FILTER_REFS_BRANCHES) && filter.detached)
745 filter.kind |= FILTER_REFS_DETACHED_HEAD;
746 filter.name_patterns = argv;
aedcb7dc 747 print_ref_list(&filter, sorting);
ebe31ef2
NTND
748 print_columns(&output, colopts, NULL);
749 string_list_clear(&output, 0);
ca417990 750 return 0;
ebe31ef2 751 }
b7200e83
JH
752 else if (edit_description) {
753 const char *branch_name;
c2d17ba3
JH
754 struct strbuf branch_ref = STRBUF_INIT;
755
75135b23 756 if (!argc) {
1511b22d 757 if (filter.detached)
045e3884 758 die(_("Cannot give description to detached HEAD"));
b7200e83 759 branch_name = head;
75135b23 760 } else if (argc == 1)
b7200e83
JH
761 branch_name = argv[0];
762 else
43722c4d 763 die(_("cannot edit description of more than one branch"));
c2d17ba3
JH
764
765 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
766 if (!ref_exists(branch_ref.buf)) {
767 strbuf_release(&branch_ref);
768
769 if (!argc)
045e3884 770 return error(_("No commit on branch '%s' yet."),
c2d17ba3
JH
771 branch_name);
772 else
045e3884
NTND
773 return error(_("No branch named '%s'."),
774 branch_name);
c2d17ba3
JH
775 }
776 strbuf_release(&branch_ref);
777
b7200e83
JH
778 if (edit_branch_description(branch_name))
779 return 1;
a4043aea 780 } else if (rename) {
d1520c4b
JM
781 if (!argc)
782 die(_("branch name required"));
783 else if (argc == 1)
3706ed29
TRC
784 rename_branch(head, argv[0], rename > 1);
785 else if (argc == 2)
786 rename_branch(argv[0], argv[1], rename > 1);
787 else
43722c4d 788 die(_("too many branches for a rename operation"));
6183d826
CMN
789 } else if (new_upstream) {
790 struct branch *branch = branch_get(argv[0]);
791
8efb8899
NTND
792 if (argc > 1)
793 die(_("too many branches to set new upstream"));
794
795 if (!branch) {
796 if (!argc || !strcmp(argv[0], "HEAD"))
797 die(_("could not set upstream of HEAD to %s when "
798 "it does not point to any branch."),
799 new_upstream);
800 die(_("no such branch '%s'"), argv[0]);
801 }
802
6183d826
CMN
803 if (!ref_exists(branch->refname))
804 die(_("branch '%s' does not exist"), branch->name);
805
806 /*
807 * create_branch takes care of setting up the tracking
808 * info and making sure new_upstream is correct
809 */
4bd488ea 810 create_branch(branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
b84869ef
CMN
811 } else if (unset_upstream) {
812 struct branch *branch = branch_get(argv[0]);
813 struct strbuf buf = STRBUF_INIT;
814
8efb8899
NTND
815 if (argc > 1)
816 die(_("too many branches to unset upstream"));
817
818 if (!branch) {
819 if (!argc || !strcmp(argv[0], "HEAD"))
820 die(_("could not unset upstream of HEAD when "
821 "it does not point to any branch."));
822 die(_("no such branch '%s'"), argv[0]);
823 }
824
54d07f2e 825 if (!branch_has_merge_config(branch))
b84869ef 826 die(_("Branch '%s' has no upstream information"), branch->name);
b84869ef
CMN
827
828 strbuf_addf(&buf, "branch.%s.remote", branch->name);
3d180648 829 git_config_set_multivar(buf.buf, NULL, NULL, 1);
b84869ef
CMN
830 strbuf_reset(&buf);
831 strbuf_addf(&buf, "branch.%s.merge", branch->name);
3d180648 832 git_config_set_multivar(buf.buf, NULL, NULL, 1);
b84869ef 833 strbuf_release(&buf);
5cd75c7d 834 } else if (argc > 0 && argc <= 2) {
b347d06b
CMN
835 struct branch *branch = branch_get(argv[0]);
836 int branch_existed = 0, remote_tracking = 0;
837 struct strbuf buf = STRBUF_INIT;
838
8efb8899
NTND
839 if (!strcmp(argv[0], "HEAD"))
840 die(_("it does not make sense to create 'HEAD' manually"));
841
842 if (!branch)
843 die(_("no such branch '%s'"), argv[0]);
844
1511b22d 845 if (filter.kind != FILTER_REFS_BRANCHES)
49df4b02 846 die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
b347d06b
CMN
847
848 if (track == BRANCH_TRACK_OVERRIDE)
849 fprintf(stderr, _("The --set-upstream flag is deprecated and will be removed. Consider using --track or --set-upstream-to\n"));
850
851 strbuf_addf(&buf, "refs/remotes/%s", branch->name);
852 remote_tracking = ref_exists(buf.buf);
853 strbuf_release(&buf);
854
855 branch_existed = ref_exists(branch->refname);
4bd488ea 856 create_branch(argv[0], (argc == 2) ? argv[1] : head,
356e91f2 857 force, reflog, 0, quiet, track);
b347d06b
CMN
858
859 /*
860 * We only show the instructions if the user gave us
861 * one branch which doesn't exist locally, but is the
862 * name of a remote-tracking branch.
863 */
864 if (argc == 1 && track == BRANCH_TRACK_OVERRIDE &&
865 !branch_existed && remote_tracking) {
866 fprintf(stderr, _("\nIf you wanted to make '%s' track '%s', do this:\n\n"), head, branch->name);
2010aabd
VA
867 fprintf(stderr, " git branch -d %s\n", branch->name);
868 fprintf(stderr, " git branch --set-upstream-to %s\n", branch->name);
b347d06b
CMN
869 }
870
6e8f993a 871 } else
a8dfd5ea 872 usage_with_options(builtin_branch_usage, options);
c31820c2
LH
873
874 return 0;
875}