remote.c: introduce branch_get_upstream helper
[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"
a8dfd5ea
PH
22
23static const char * const builtin_branch_usage[] = {
9c9b4f2f
AH
24 N_("git branch [<options>] [-r | -a] [--merged | --no-merged]"),
25 N_("git branch [<options>] [-l] [-f] <branch-name> [<start-point>]"),
26 N_("git branch [<options>] [-r] (-d | -D) <branch-name>..."),
27 N_("git branch [<options>] (-m | -M) [<old-branch>] <new-branch>"),
a8dfd5ea
PH
28 NULL
29};
c31820c2 30
f3d985c3
JH
31#define REF_LOCAL_BRANCH 0x01
32#define REF_REMOTE_BRANCH 0x02
c31820c2
LH
33
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
049716b3
JH
55static enum merge_filter {
56 NO_FILTER = 0,
57 SHOW_NOT_MERGED,
4b05548f 58 SHOW_MERGED
049716b3
JH
59} merge_filter;
60static unsigned char merge_filter_ref[20];
e8b404c2 61
ebe31ef2
NTND
62static struct string_list output = STRING_LIST_INIT_DUP;
63static unsigned int colopts;
64
8852117a 65static int parse_branch_color_slot(const char *slot)
a1158cae 66{
8852117a 67 if (!strcasecmp(slot, "plain"))
74bb2dfb 68 return BRANCH_COLOR_PLAIN;
8852117a 69 if (!strcasecmp(slot, "reset"))
74bb2dfb 70 return BRANCH_COLOR_RESET;
8852117a 71 if (!strcasecmp(slot, "remote"))
74bb2dfb 72 return BRANCH_COLOR_REMOTE;
8852117a 73 if (!strcasecmp(slot, "local"))
74bb2dfb 74 return BRANCH_COLOR_LOCAL;
8852117a 75 if (!strcasecmp(slot, "current"))
74bb2dfb 76 return BRANCH_COLOR_CURRENT;
8852117a 77 if (!strcasecmp(slot, "upstream"))
dbda21fa 78 return BRANCH_COLOR_UPSTREAM;
8b8e8624 79 return -1;
a1158cae
AP
80}
81
ef90d6d4 82static int git_branch_config(const char *var, const char *value, void *cb)
a1158cae 83{
e3f1da98
RS
84 const char *slot_name;
85
59556548 86 if (starts_with(var, "column."))
ebe31ef2 87 return git_column_config(var, value, "branch", &colopts);
a1158cae 88 if (!strcmp(var, "color.branch")) {
e269eb79 89 branch_use_color = git_config_colorbool(var, value);
a1158cae
AP
90 return 0;
91 }
e3f1da98 92 if (skip_prefix(var, "color.branch.", &slot_name)) {
b9465768 93 int slot = parse_branch_color_slot(slot_name);
8b8e8624
JK
94 if (slot < 0)
95 return 0;
5768c98a
JH
96 if (!value)
97 return config_error_nonbool(var);
f6c5a296 98 return color_parse(value, branch_colors[slot]);
a1158cae 99 }
ef90d6d4 100 return git_color_default_config(var, value, cb);
a1158cae
AP
101}
102
52fae7de 103static const char *branch_get_color(enum color_branch ix)
a1158cae 104{
daa0c3d9 105 if (want_color(branch_use_color))
a1158cae
AP
106 return branch_colors[ix];
107 return "";
108}
109
99c419c9
JH
110static int branch_merged(int kind, const char *name,
111 struct commit *rev, struct commit *head_rev)
112{
113 /*
114 * This checks whether the merge bases of branch and HEAD (or
115 * the other branch this branch builds upon) contains the
116 * branch, which means that the branch has already been merged
117 * safely to HEAD (or the other branch).
118 */
119 struct commit *reference_rev = NULL;
120 const char *reference_name = NULL;
96ec7b1e 121 void *reference_name_to_free = NULL;
99c419c9
JH
122 int merged;
123
124 if (kind == REF_LOCAL_BRANCH) {
125 struct branch *branch = branch_get(name);
a9f9f8cc 126 const char *upstream = branch_get_upstream(branch);
99c419c9
JH
127 unsigned char sha1[20];
128
a9f9f8cc 129 if (upstream &&
96ec7b1e 130 (reference_name = reference_name_to_free =
a9f9f8cc 131 resolve_refdup(upstream, RESOLVE_REF_READING,
7695d118 132 sha1, NULL)) != NULL)
99c419c9
JH
133 reference_rev = lookup_commit_reference(sha1);
134 }
135 if (!reference_rev)
136 reference_rev = head_rev;
137
a20efee9 138 merged = in_merge_bases(rev, reference_rev);
99c419c9
JH
139
140 /*
141 * After the safety valve is fully redefined to "check with
142 * upstream, if any, otherwise with HEAD", we should just
143 * return the result of the in_merge_bases() above without
144 * any of the following code, but during the transition period,
145 * a gentle reminder is in order.
146 */
147 if ((head_rev != reference_rev) &&
a20efee9 148 in_merge_bases(rev, head_rev) != merged) {
99c419c9 149 if (merged)
49df4b02 150 warning(_("deleting branch '%s' that has been merged to\n"
6c80cd29 151 " '%s', but not yet merged to HEAD."),
99c419c9
JH
152 name, reference_name);
153 else
49df4b02
ÆAB
154 warning(_("not deleting branch '%s' that is not yet merged to\n"
155 " '%s', even though it is merged to HEAD."),
99c419c9
JH
156 name, reference_name);
157 }
96ec7b1e 158 free(reference_name_to_free);
99c419c9
JH
159 return merged;
160}
161
f5d0e162
RS
162static int check_branch_commit(const char *branchname, const char *refname,
163 unsigned char *sha1, struct commit *head_rev,
164 int kinds, int force)
165{
166 struct commit *rev = lookup_commit_reference(sha1);
167 if (!rev) {
168 error(_("Couldn't look up commit object for '%s'"), refname);
169 return -1;
170 }
171 if (!force && !branch_merged(kinds, branchname, rev, head_rev)) {
172 error(_("The branch '%s' is not fully merged.\n"
173 "If you are sure you want to delete it, "
174 "run 'git branch -D %s'."), branchname, branchname);
175 return -1;
176 }
177 return 0;
178}
179
22ed7927
RS
180static void delete_branch_config(const char *branchname)
181{
182 struct strbuf buf = STRBUF_INIT;
183 strbuf_addf(&buf, "branch.%s", branchname);
184 if (git_config_rename_section(buf.buf, NULL) < 0)
185 warning(_("Update of config-file failed"));
186 strbuf_release(&buf);
187}
188
d65ddf19
JK
189static int delete_branches(int argc, const char **argv, int force, int kinds,
190 int quiet)
c31820c2 191{
f5d0e162 192 struct commit *head_rev = NULL;
c31820c2 193 unsigned char sha1[20];
b8e9a00d 194 char *name = NULL;
c179837c 195 const char *fmt;
c31820c2 196 int i;
b8e9a00d 197 int ret = 0;
c179837c 198 int remote_branch = 0;
8415d5c7 199 struct strbuf bname = STRBUF_INIT;
c31820c2 200
f3d985c3
JH
201 switch (kinds) {
202 case REF_REMOTE_BRANCH:
203 fmt = "refs/remotes/%s";
c179837c
ÆAB
204 /* For subsequent UI messages */
205 remote_branch = 1;
206
f3d985c3
JH
207 force = 1;
208 break;
209 case REF_LOCAL_BRANCH:
210 fmt = "refs/heads/%s";
f3d985c3
JH
211 break;
212 default:
49df4b02 213 die(_("cannot use -a with -d"));
f3d985c3 214 }
c31820c2 215
67affd51
JH
216 if (!force) {
217 head_rev = lookup_commit_reference(head_sha1);
218 if (!head_rev)
49df4b02 219 die(_("Couldn't look up commit object for HEAD"));
67affd51 220 }
8415d5c7 221 for (i = 0; i < argc; i++, strbuf_release(&bname)) {
0fe700e3
RS
222 const char *target;
223 int flags = 0;
224
a552de75 225 strbuf_branchname(&bname, argv[i]);
8415d5c7 226 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
49df4b02
ÆAB
227 error(_("Cannot delete the branch '%s' "
228 "which you are currently on."), bname.buf);
b8e9a00d
QT
229 ret = 1;
230 continue;
231 }
232
8e0f7003 233 free(name);
c31820c2 234
4e2d094d 235 name = mkpathdup(fmt, bname.buf);
18f29fc6
RS
236 target = resolve_ref_unsafe(name,
237 RESOLVE_REF_READING
d0f810f0
RS
238 | RESOLVE_REF_NO_RECURSE
239 | RESOLVE_REF_ALLOW_BAD_NAME,
62a2d525 240 sha1, &flags);
18f29fc6 241 if (!target) {
c179837c
ÆAB
242 error(remote_branch
243 ? _("remote branch '%s' not found.")
244 : _("branch '%s' not found."), bname.buf);
b8e9a00d
QT
245 ret = 1;
246 continue;
247 }
c31820c2 248
d0f810f0 249 if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
0fe700e3 250 check_branch_commit(bname.buf, name, sha1, head_rev, kinds,
f5d0e162 251 force)) {
b8e9a00d
QT
252 ret = 1;
253 continue;
c31820c2
LH
254 }
255
566c7707 256 if (delete_ref(name, sha1, REF_NODEREF)) {
c179837c
ÆAB
257 error(remote_branch
258 ? _("Error deleting remote branch '%s'")
259 : _("Error deleting branch '%s'"),
8415d5c7 260 bname.buf);
b8e9a00d 261 ret = 1;
13baa9fe
RS
262 continue;
263 }
264 if (!quiet) {
265 printf(remote_branch
266 ? _("Deleted remote branch %s (was %s).\n")
267 : _("Deleted branch %s (was %s).\n"),
268 bname.buf,
d0f810f0
RS
269 (flags & REF_ISBROKEN) ? "broken"
270 : (flags & REF_ISSYMREF) ? target
13baa9fe 271 : find_unique_abbrev(sha1, DEFAULT_ABBREV));
f1eccbab 272 }
13baa9fe 273 delete_branch_config(bname.buf);
c31820c2 274 }
c31820c2 275
8e0f7003 276 free(name);
b8e9a00d
QT
277
278 return(ret);
c31820c2 279}
c31820c2 280
bfcc9214
AP
281struct ref_item {
282 char *name;
209d336a 283 char *dest;
1452bd64 284 unsigned int kind, width;
68067ca1 285 struct commit *commit;
8376a704 286 int ignore;
bfcc9214
AP
287};
288
289struct ref_list {
68067ca1 290 struct rev_info revs;
7e9ff00b 291 int index, alloc, maxwidth, verbose, abbrev;
bfcc9214 292 struct ref_item *list;
694a5775 293 struct commit_list *with_commit;
bfcc9214
AP
294 int kinds;
295};
296
209d336a
JS
297static char *resolve_symref(const char *src, const char *prefix)
298{
299 unsigned char sha1[20];
300 int flag;
cf4fff57 301 const char *dst;
209d336a 302
7695d118 303 dst = resolve_ref_unsafe(src, 0, sha1, &flag);
209d336a
JS
304 if (!(dst && (flag & REF_ISSYMREF)))
305 return NULL;
cf4fff57
JK
306 if (prefix)
307 skip_prefix(dst, prefix, &dst);
209d336a
JS
308 return xstrdup(dst);
309}
310
1603ade8
SM
311struct append_ref_cb {
312 struct ref_list *ref_list;
d8d33736 313 const char **pattern;
1603ade8
SM
314 int ret;
315};
316
d8d33736
MG
317static int match_patterns(const char **pattern, const char *refname)
318{
319 if (!*pattern)
320 return 1; /* no pattern always matches */
321 while (*pattern) {
eb07894f 322 if (!wildmatch(*pattern, refname, 0, NULL))
d8d33736
MG
323 return 1;
324 pattern++;
325 }
326 return 0;
327}
328
bfcc9214 329static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
c31820c2 330{
1603ade8
SM
331 struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
332 struct ref_list *ref_list = cb->ref_list;
bfcc9214 333 struct ref_item *newitem;
68067ca1 334 struct commit *commit;
209d336a
JS
335 int kind, i;
336 const char *prefix, *orig_refname = refname;
337
338 static struct {
339 int kind;
340 const char *prefix;
209d336a 341 } ref_kind[] = {
e3f1da98
RS
342 { REF_LOCAL_BRANCH, "refs/heads/" },
343 { REF_REMOTE_BRANCH, "refs/remotes/" },
209d336a 344 };
bfcc9214
AP
345
346 /* Detect kind */
209d336a
JS
347 for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
348 prefix = ref_kind[i].prefix;
e3f1da98
RS
349 if (skip_prefix(refname, prefix, &refname)) {
350 kind = ref_kind[i].kind;
351 break;
352 }
209d336a
JS
353 }
354 if (ARRAY_SIZE(ref_kind) <= i)
0f31d680 355 return 0;
bfcc9214
AP
356
357 /* Don't add types the caller doesn't want */
358 if ((kind & ref_list->kinds) == 0)
359 return 0;
360
d8d33736
MG
361 if (!match_patterns(cb->pattern, refname))
362 return 0;
363
191d1ac4
LT
364 commit = NULL;
365 if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
366 commit = lookup_commit_reference_gently(sha1, 1);
1603ade8 367 if (!commit) {
49df4b02 368 cb->ret = error(_("branch '%s' does not point at a commit"), refname);
0e9716e6 369 return 0;
1603ade8 370 }
68067ca1 371
191d1ac4
LT
372 /* Filter with with_commit if specified */
373 if (!is_descendant_of(commit, ref_list->with_commit))
374 return 0;
694a5775 375
191d1ac4
LT
376 if (merge_filter != NO_FILTER)
377 add_pending_object(&ref_list->revs,
378 (struct object *)commit, refname);
379 }
e8b404c2 380
fcbc0d8e 381 ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
c31820c2 382
bfcc9214
AP
383 /* Record the new item */
384 newitem = &(ref_list->list[ref_list->index++]);
385 newitem->name = xstrdup(refname);
386 newitem->kind = kind;
68067ca1 387 newitem->commit = commit;
1452bd64 388 newitem->width = utf8_strwidth(refname);
209d336a 389 newitem->dest = resolve_symref(orig_refname, prefix);
8376a704 390 newitem->ignore = 0;
209d336a
JS
391 /* adjust for "remotes/" */
392 if (newitem->kind == REF_REMOTE_BRANCH &&
393 ref_list->kinds != REF_REMOTE_BRANCH)
1452bd64
NTND
394 newitem->width += 8;
395 if (newitem->width > ref_list->maxwidth)
396 ref_list->maxwidth = newitem->width;
c31820c2
LH
397
398 return 0;
399}
400
bfcc9214
AP
401static void free_ref_list(struct ref_list *ref_list)
402{
403 int i;
404
209d336a 405 for (i = 0; i < ref_list->index; i++) {
bfcc9214 406 free(ref_list->list[i].name);
209d336a
JS
407 free(ref_list->list[i].dest);
408 }
bfcc9214
AP
409 free(ref_list->list);
410}
411
c31820c2
LH
412static int ref_cmp(const void *r1, const void *r2)
413{
bfcc9214
AP
414 struct ref_item *c1 = (struct ref_item *)(r1);
415 struct ref_item *c2 = (struct ref_item *)(r2);
416
417 if (c1->kind != c2->kind)
418 return c1->kind - c2->kind;
419 return strcmp(c1->name, c2->name);
c31820c2
LH
420}
421
2d8a7f0b
JK
422static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
423 int show_upstream_ref)
94fcb730
JH
424{
425 int ours, theirs;
21dfc09d 426 char *ref = NULL;
94fcb730 427 struct branch *branch = branch_get(branch_name);
dbda21fa 428 struct strbuf fancy = STRBUF_INIT;
f2e08739 429 int upstream_is_gone = 0;
6b364d48 430 int added_decoration = 1;
94fcb730 431
f2e08739
JX
432 switch (stat_tracking_info(branch, &ours, &theirs)) {
433 case 0:
434 /* no base */
94fcb730 435 return;
f2e08739
JX
436 case -1:
437 /* with "gone" base */
438 upstream_is_gone = 1;
439 break;
440 default:
441 /* with base */
442 break;
2d8a7f0b
JK
443 }
444
dbda21fa 445 if (show_upstream_ref) {
21dfc09d 446 ref = shorten_unambiguous_ref(branch->merge[0]->dst, 0);
dbda21fa
FC
447 if (want_color(branch_use_color))
448 strbuf_addf(&fancy, "%s%s%s",
449 branch_get_color(BRANCH_COLOR_UPSTREAM),
450 ref, branch_get_color(BRANCH_COLOR_RESET));
451 else
452 strbuf_addstr(&fancy, ref);
453 }
454
f2e08739
JX
455 if (upstream_is_gone) {
456 if (show_upstream_ref)
457 strbuf_addf(stat, _("[%s: gone]"), fancy.buf);
6b364d48
TH
458 else
459 added_decoration = 0;
f2e08739
JX
460 } else if (!ours && !theirs) {
461 if (show_upstream_ref)
462 strbuf_addf(stat, _("[%s]"), fancy.buf);
6b364d48
TH
463 else
464 added_decoration = 0;
f2e08739
JX
465 } else if (!ours) {
466 if (show_upstream_ref)
dbda21fa 467 strbuf_addf(stat, _("[%s: behind %d]"), fancy.buf, theirs);
21dfc09d
NTND
468 else
469 strbuf_addf(stat, _("[behind %d]"), theirs);
470
471 } else if (!theirs) {
f2e08739 472 if (show_upstream_ref)
dbda21fa 473 strbuf_addf(stat, _("[%s: ahead %d]"), fancy.buf, ours);
21dfc09d
NTND
474 else
475 strbuf_addf(stat, _("[ahead %d]"), ours);
476 } else {
f2e08739 477 if (show_upstream_ref)
21dfc09d 478 strbuf_addf(stat, _("[%s: ahead %d, behind %d]"),
dbda21fa 479 fancy.buf, ours, theirs);
21dfc09d
NTND
480 else
481 strbuf_addf(stat, _("[ahead %d, behind %d]"),
482 ours, theirs);
483 }
dbda21fa 484 strbuf_release(&fancy);
6b364d48
TH
485 if (added_decoration)
486 strbuf_addch(stat, ' ');
21dfc09d 487 free(ref);
94fcb730
JH
488}
489
6e0332ec
JN
490static void add_verbose_info(struct strbuf *out, struct ref_item *item,
491 int verbose, int abbrev)
492{
493 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
045e3884 494 const char *sub = _(" **** invalid ref ****");
6e0332ec
JN
495 struct commit *commit = item->commit;
496
5e7d4d3e 497 if (!parse_commit(commit)) {
f67d2e82 498 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
6e0332ec
JN
499 sub = subject.buf;
500 }
501
502 if (item->kind == REF_LOCAL_BRANCH)
503 fill_tracking_info(&stat, item->name, verbose > 1);
504
505 strbuf_addf(out, " %s %s%s",
506 find_unique_abbrev(item->commit->object.sha1, abbrev),
507 stat.buf, sub);
508 strbuf_release(&stat);
509 strbuf_release(&subject);
510}
511
af0e4ac0 512static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
209d336a 513 int abbrev, int current, char *prefix)
75e6e213 514{
af0e4ac0
LH
515 char c;
516 int color;
209d336a 517 struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
68067ca1 518
8376a704 519 if (item->ignore)
7950cda7 520 return;
75e6e213 521
af0e4ac0
LH
522 switch (item->kind) {
523 case REF_LOCAL_BRANCH:
74bb2dfb 524 color = BRANCH_COLOR_LOCAL;
af0e4ac0
LH
525 break;
526 case REF_REMOTE_BRANCH:
74bb2dfb 527 color = BRANCH_COLOR_REMOTE;
af0e4ac0
LH
528 break;
529 default:
74bb2dfb 530 color = BRANCH_COLOR_PLAIN;
af0e4ac0
LH
531 break;
532 }
75e6e213 533
af0e4ac0
LH
534 c = ' ';
535 if (current) {
536 c = '*';
74bb2dfb 537 color = BRANCH_COLOR_CURRENT;
af0e4ac0 538 }
75e6e213 539
209d336a 540 strbuf_addf(&name, "%s%s", prefix, item->name);
1452bd64
NTND
541 if (verbose) {
542 int utf8_compensation = strlen(name.buf) - utf8_strwidth(name.buf);
209d336a 543 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
1452bd64 544 maxwidth + utf8_compensation, name.buf,
81474267 545 branch_get_color(BRANCH_COLOR_RESET));
1452bd64 546 } else
209d336a 547 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
81474267 548 name.buf, branch_get_color(BRANCH_COLOR_RESET));
209d336a
JS
549
550 if (item->dest)
551 strbuf_addf(&out, " -> %s", item->dest);
6e0332ec
JN
552 else if (verbose)
553 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
554 add_verbose_info(&out, item, verbose, abbrev);
ebe31ef2
NTND
555 if (column_active(colopts)) {
556 assert(!verbose && "--column and --verbose are incompatible");
557 string_list_append(&output, out.buf);
558 } else {
559 printf("%s\n", out.buf);
560 }
209d336a
JS
561 strbuf_release(&name);
562 strbuf_release(&out);
75e6e213
LH
563}
564
b6f637d1
LH
565static int calc_maxwidth(struct ref_list *refs)
566{
209d336a 567 int i, w = 0;
b6f637d1 568 for (i = 0; i < refs->index; i++) {
8376a704 569 if (refs->list[i].ignore)
b6f637d1 570 continue;
1452bd64
NTND
571 if (refs->list[i].width > w)
572 w = refs->list[i].width;
b6f637d1
LH
573 }
574 return w;
575}
576
c8183cd2
NTND
577static char *get_head_description(void)
578{
579 struct strbuf desc = STRBUF_INIT;
580 struct wt_status_state state;
581 memset(&state, 0, sizeof(state));
582 wt_status_get_state(&state, 1);
583 if (state.rebase_in_progress ||
584 state.rebase_interactive_in_progress)
585 strbuf_addf(&desc, _("(no branch, rebasing %s)"),
586 state.branch);
587 else if (state.bisect_in_progress)
6deab24d 588 strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
c8183cd2 589 state.branch);
4b063186
MG
590 else if (state.detached_from) {
591 /* TRANSLATORS: make sure these match _("HEAD detached at ")
592 and _("HEAD detached from ") in wt-status.c */
593 if (state.detached_at)
594 strbuf_addf(&desc, _("(HEAD detached at %s)"),
595 state.detached_from);
596 else
597 strbuf_addf(&desc, _("(HEAD detached from %s)"),
598 state.detached_from);
599 }
c8183cd2
NTND
600 else
601 strbuf_addstr(&desc, _("(no branch)"));
602 free(state.branch);
603 free(state.onto);
604 free(state.detached_from);
605 return strbuf_detach(&desc, NULL);
606}
7e9ff00b
LT
607
608static void show_detached(struct ref_list *ref_list)
609{
610 struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
611
612 if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
613 struct ref_item item;
c8183cd2 614 item.name = get_head_description();
1452bd64 615 item.width = utf8_strwidth(item.name);
7e9ff00b
LT
616 item.kind = REF_LOCAL_BRANCH;
617 item.dest = NULL;
618 item.commit = head_commit;
8376a704 619 item.ignore = 0;
1452bd64
NTND
620 if (item.width > ref_list->maxwidth)
621 ref_list->maxwidth = item.width;
7e9ff00b
LT
622 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
623 free(item.name);
624 }
625}
626
d8d33736 627static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit, const char **pattern)
c31820c2
LH
628{
629 int i;
1603ade8 630 struct append_ref_cb cb;
bfcc9214 631 struct ref_list ref_list;
c31820c2 632
bfcc9214
AP
633 memset(&ref_list, 0, sizeof(ref_list));
634 ref_list.kinds = kinds;
191d1ac4 635 ref_list.verbose = verbose;
7e9ff00b 636 ref_list.abbrev = abbrev;
694a5775 637 ref_list.with_commit = with_commit;
68067ca1
JH
638 if (merge_filter != NO_FILTER)
639 init_revisions(&ref_list.revs, NULL);
1603ade8 640 cb.ref_list = &ref_list;
d8d33736 641 cb.pattern = pattern;
1603ade8
SM
642 cb.ret = 0;
643 for_each_rawref(append_ref, &cb);
68067ca1
JH
644 if (merge_filter != NO_FILTER) {
645 struct commit *filter;
646 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
6c41e975 647 if (!filter)
045e3884 648 die(_("object '%s' does not point to a commit"),
6c41e975
CMN
649 sha1_to_hex(merge_filter_ref));
650
68067ca1
JH
651 filter->object.flags |= UNINTERESTING;
652 add_pending_object(&ref_list.revs,
653 (struct object *) filter, "");
654 ref_list.revs.limited = 1;
81c3ce3c
SB
655
656 if (prepare_revision_walk(&ref_list.revs))
657 die(_("revision walk setup failed"));
8376a704
JK
658
659 for (i = 0; i < ref_list.index; i++) {
660 struct ref_item *item = &ref_list.list[i];
661 struct commit *commit = item->commit;
662 int is_merged = !!(commit->object.flags & UNINTERESTING);
663 item->ignore = is_merged != (merge_filter == SHOW_MERGED);
664 }
665
666 for (i = 0; i < ref_list.index; i++) {
667 struct ref_item *item = &ref_list.list[i];
668 clear_commit_marks(item->commit, ALL_REV_FLAGS);
669 }
670 clear_commit_marks(filter, ALL_REV_FLAGS);
671
b6f637d1
LH
672 if (verbose)
673 ref_list.maxwidth = calc_maxwidth(&ref_list);
68067ca1 674 }
c31820c2 675
bfcc9214 676 qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
c31820c2 677
0016a482 678 detached = (detached && (kinds & REF_LOCAL_BRANCH));
d8d33736 679 if (detached && match_patterns(pattern, "HEAD"))
7e9ff00b 680 show_detached(&ref_list);
0016a482 681
bfcc9214 682 for (i = 0; i < ref_list.index; i++) {
0016a482
LH
683 int current = !detached &&
684 (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
af0e4ac0 685 !strcmp(ref_list.list[i].name, head);
209d336a
JS
686 char *prefix = (kinds != REF_REMOTE_BRANCH &&
687 ref_list.list[i].kind == REF_REMOTE_BRANCH)
688 ? "remotes/" : "";
af0e4ac0 689 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
209d336a 690 abbrev, current, prefix);
c31820c2 691 }
bfcc9214
AP
692
693 free_ref_list(&ref_list);
1603ade8 694
0e9716e6 695 if (cb.ret)
49df4b02 696 error(_("some refs could not be read"));
0e9716e6 697
1603ade8 698 return cb.ret;
c31820c2
LH
699}
700
c976d415
LH
701static void rename_branch(const char *oldname, const char *newname, int force)
702{
da3f78a2 703 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
da3f78a2 704 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
cbdffe40 705 int recovery = 0;
3f59481e 706 int clobber_head_ok;
c976d415 707
c847f537 708 if (!oldname)
49df4b02 709 die(_("cannot rename the current branch while not on any."));
c847f537 710
cbdffe40
JH
711 if (strbuf_check_branch_ref(&oldref, oldname)) {
712 /*
713 * Bad name --- this could be an attempt to rename a
714 * ref that we used to allow to be created by accident.
715 */
c6893323 716 if (ref_exists(oldref.buf))
cbdffe40
JH
717 recovery = 1;
718 else
49df4b02 719 die(_("Invalid branch name: '%s'"), oldname);
cbdffe40 720 }
c976d415 721
3f59481e
JN
722 /*
723 * A command like "git branch -M currentbranch currentbranch" cannot
724 * cause the worktree to become inconsistent with HEAD, so allow it.
725 */
726 clobber_head_ok = !strcmp(oldname, newname);
727
728 validate_new_branchname(newname, &newref, force, clobber_head_ok);
c976d415 729
da3f78a2
MV
730 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
731 oldref.buf, newref.buf);
678d0f4c 732
da3f78a2 733 if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
49df4b02 734 die(_("Branch rename failed"));
da3f78a2 735 strbuf_release(&logmsg);
c976d415 736
cbdffe40 737 if (recovery)
49df4b02 738 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
cbdffe40 739
8b5157e4 740 /* no need to pass logmsg here as HEAD didn't really move */
da3f78a2 741 if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
49df4b02 742 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
19eba151 743
da3f78a2
MV
744 strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
745 strbuf_release(&oldref);
746 strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
747 strbuf_release(&newref);
748 if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
49df4b02 749 die(_("Branch is renamed, but update of config-file failed"));
da3f78a2
MV
750 strbuf_release(&oldsection);
751 strbuf_release(&newsection);
c976d415
LH
752}
753
049716b3
JH
754static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
755{
756 merge_filter = ((opt->long_name[0] == 'n')
757 ? SHOW_NOT_MERGED
758 : SHOW_MERGED);
759 if (unset)
760 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
761 if (!arg)
762 arg = "HEAD";
763 if (get_sha1(arg, merge_filter_ref))
49df4b02 764 die(_("malformed object name %s"), arg);
049716b3
JH
765 return 0;
766}
767
b7200e83
JH
768static const char edit_description[] = "BRANCH_DESCRIPTION";
769
770static int edit_branch_description(const char *branch_name)
771{
772 FILE *fp;
773 int status;
774 struct strbuf buf = STRBUF_INIT;
775 struct strbuf name = STRBUF_INIT;
776
777 read_branch_desc(&buf, branch_name);
778 if (!buf.len || buf.buf[buf.len-1] != '\n')
779 strbuf_addch(&buf, '\n');
eff80a9f
JH
780 strbuf_commented_addf(&buf,
781 "Please edit the description for the branch\n"
782 " %s\n"
783 "Lines starting with '%c' will be stripped.\n",
784 branch_name, comment_line_char);
b7200e83
JH
785 fp = fopen(git_path(edit_description), "w");
786 if ((fwrite(buf.buf, 1, buf.len, fp) < buf.len) || fclose(fp)) {
787 strbuf_release(&buf);
82247e9b 788 return error(_("could not write branch description template: %s"),
b7200e83
JH
789 strerror(errno));
790 }
791 strbuf_reset(&buf);
792 if (launch_editor(git_path(edit_description), &buf, NULL)) {
793 strbuf_release(&buf);
794 return -1;
795 }
796 stripspace(&buf, 1);
797
798 strbuf_addf(&name, "branch.%s.description", branch_name);
4b5553b5 799 status = git_config_set(name.buf, buf.len ? buf.buf : NULL);
b7200e83
JH
800 strbuf_release(&name);
801 strbuf_release(&buf);
802
803 return status;
804}
805
c31820c2
LH
806int cmd_branch(int argc, const char **argv, const char *prefix)
807{
356e91f2 808 int delete = 0, rename = 0, force = 0, list = 0;
b792c067 809 int verbose = 0, abbrev = -1, detached = 0;
b7200e83 810 int reflog = 0, edit_description = 0;
b84869ef 811 int quiet = 0, unset_upstream = 0;
6183d826 812 const char *new_upstream = NULL;
9ed36cfa 813 enum branch_track track;
d11d44fa 814 int kinds = REF_LOCAL_BRANCH;
694a5775 815 struct commit_list *with_commit = NULL;
a8dfd5ea
PH
816
817 struct option options[] = {
24a85214 818 OPT_GROUP(N_("Generic options")),
39271425 819 OPT__VERBOSE(&verbose,
24a85214
NTND
820 N_("show hash and subject, give twice for upstream branch")),
821 OPT__QUIET(&quiet, N_("suppress informational messages")),
822 OPT_SET_INT('t', "track", &track, N_("set up tracking mode (see git-pull(1))"),
9ed36cfa 823 BRANCH_TRACK_EXPLICIT),
24a85214 824 OPT_SET_INT( 0, "set-upstream", &track, N_("change upstream info"),
4fc50066 825 BRANCH_TRACK_OVERRIDE),
6183d826 826 OPT_STRING('u', "set-upstream-to", &new_upstream, "upstream", "change the upstream info"),
d5d09d47 827 OPT_BOOL(0, "unset-upstream", &unset_upstream, "Unset the upstream info"),
24a85214
NTND
828 OPT__COLOR(&branch_use_color, N_("use colored output")),
829 OPT_SET_INT('r', "remotes", &kinds, N_("act on remote-tracking branches"),
d11d44fa 830 REF_REMOTE_BRANCH),
e84fb2ff 831 {
24a85214
NTND
832 OPTION_CALLBACK, 0, "contains", &with_commit, N_("commit"),
833 N_("print only branches that contain the commit"),
e84fb2ff 834 PARSE_OPT_LASTARG_DEFAULT,
269defdf 835 parse_opt_with_commit, (intptr_t)"HEAD",
e84fb2ff 836 },
694a5775 837 {
24a85214
NTND
838 OPTION_CALLBACK, 0, "with", &with_commit, N_("commit"),
839 N_("print only branches that contain the commit"),
e84fb2ff 840 PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
269defdf 841 parse_opt_with_commit, (intptr_t) "HEAD",
694a5775 842 },
a8dfd5ea
PH
843 OPT__ABBREV(&abbrev),
844
24a85214
NTND
845 OPT_GROUP(N_("Specific git-branch actions:")),
846 OPT_SET_INT('a', "all", &kinds, N_("list both remote-tracking and local branches"),
d11d44fa 847 REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
24a85214
NTND
848 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
849 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
850 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
851 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
d5d09d47
SB
852 OPT_BOOL(0, "list", &list, N_("list branch names")),
853 OPT_BOOL('l', "create-reflog", &reflog, N_("create the branch's reflog")),
854 OPT_BOOL(0, "edit-description", &edit_description,
855 N_("edit the description for the branch")),
356e91f2 856 OPT__FORCE(&force, N_("force creation, move/rename, deletion")),
049716b3
JH
857 {
858 OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
24a85214 859 N_("commit"), N_("print only not merged branches"),
049716b3
JH
860 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
861 opt_parse_merge_filter, (intptr_t) "HEAD",
862 },
863 {
864 OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
24a85214 865 N_("commit"), N_("print only merged branches"),
049716b3
JH
866 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
867 opt_parse_merge_filter, (intptr_t) "HEAD",
868 },
24a85214 869 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
a8dfd5ea
PH
870 OPT_END(),
871 };
c31820c2 872
1dacfbcf
NTND
873 if (argc == 2 && !strcmp(argv[1], "-h"))
874 usage_with_options(builtin_branch_usage, options);
875
ef90d6d4 876 git_config(git_branch_config, NULL);
6b2f2d98 877
9ed36cfa 878 track = git_branch_track;
c976d415 879
7695d118 880 head = resolve_refdup("HEAD", 0, head_sha1, NULL);
c31820c2 881 if (!head)
49df4b02 882 die(_("Failed to resolve HEAD as a valid ref."));
e3f1da98 883 if (!strcmp(head, "HEAD"))
0016a482 884 detached = 1;
e3f1da98
RS
885 else if (!skip_prefix(head, "refs/heads/", &head))
886 die(_("HEAD not found below refs/heads!"));
049716b3
JH
887 hashcpy(merge_filter_ref, head_sha1);
888
ebe31ef2 889
37782920
SB
890 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
891 0);
cddd127b 892
b84869ef 893 if (!delete && !rename && !edit_description && !new_upstream && !unset_upstream && argc == 0)
cddd127b
MG
894 list = 1;
895
d0403508
JK
896 if (with_commit || merge_filter != NO_FILTER)
897 list = 1;
898
356e91f2 899 if (!!delete + !!rename + !!new_upstream +
05efb7b7 900 list + unset_upstream > 1)
049716b3 901 usage_with_options(builtin_branch_usage, options);
c31820c2 902
b792c067
NK
903 if (abbrev == -1)
904 abbrev = DEFAULT_ABBREV;
ebe31ef2
NTND
905 finalize_colopts(&colopts, -1);
906 if (verbose) {
907 if (explicitly_enable_column(colopts))
908 die(_("--column and --verbose are incompatible"));
909 colopts = 0;
910 }
b792c067 911
356e91f2
MG
912 if (force) {
913 delete *= 2;
914 rename *= 2;
915 }
916
640d0401
NTND
917 if (delete) {
918 if (!argc)
919 die(_("branch name required"));
d65ddf19 920 return delete_branches(argc, argv, delete > 1, kinds, quiet);
640d0401 921 } else if (list) {
ebe31ef2
NTND
922 int ret = print_ref_list(kinds, detached, verbose, abbrev,
923 with_commit, argv);
924 print_columns(&output, colopts, NULL);
925 string_list_clear(&output, 0);
926 return ret;
927 }
b7200e83
JH
928 else if (edit_description) {
929 const char *branch_name;
c2d17ba3
JH
930 struct strbuf branch_ref = STRBUF_INIT;
931
75135b23
NTND
932 if (!argc) {
933 if (detached)
045e3884 934 die(_("Cannot give description to detached HEAD"));
b7200e83 935 branch_name = head;
75135b23 936 } else if (argc == 1)
b7200e83
JH
937 branch_name = argv[0];
938 else
43722c4d 939 die(_("cannot edit description of more than one branch"));
c2d17ba3
JH
940
941 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
942 if (!ref_exists(branch_ref.buf)) {
943 strbuf_release(&branch_ref);
944
945 if (!argc)
045e3884 946 return error(_("No commit on branch '%s' yet."),
c2d17ba3
JH
947 branch_name);
948 else
045e3884
NTND
949 return error(_("No branch named '%s'."),
950 branch_name);
c2d17ba3
JH
951 }
952 strbuf_release(&branch_ref);
953
b7200e83
JH
954 if (edit_branch_description(branch_name))
955 return 1;
a4043aea 956 } else if (rename) {
d1520c4b
JM
957 if (!argc)
958 die(_("branch name required"));
959 else if (argc == 1)
3706ed29
TRC
960 rename_branch(head, argv[0], rename > 1);
961 else if (argc == 2)
962 rename_branch(argv[0], argv[1], rename > 1);
963 else
43722c4d 964 die(_("too many branches for a rename operation"));
6183d826
CMN
965 } else if (new_upstream) {
966 struct branch *branch = branch_get(argv[0]);
967
8efb8899
NTND
968 if (argc > 1)
969 die(_("too many branches to set new upstream"));
970
971 if (!branch) {
972 if (!argc || !strcmp(argv[0], "HEAD"))
973 die(_("could not set upstream of HEAD to %s when "
974 "it does not point to any branch."),
975 new_upstream);
976 die(_("no such branch '%s'"), argv[0]);
977 }
978
6183d826
CMN
979 if (!ref_exists(branch->refname))
980 die(_("branch '%s' does not exist"), branch->name);
981
982 /*
983 * create_branch takes care of setting up the tracking
984 * info and making sure new_upstream is correct
985 */
986 create_branch(head, branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
b84869ef
CMN
987 } else if (unset_upstream) {
988 struct branch *branch = branch_get(argv[0]);
989 struct strbuf buf = STRBUF_INIT;
990
8efb8899
NTND
991 if (argc > 1)
992 die(_("too many branches to unset upstream"));
993
994 if (!branch) {
995 if (!argc || !strcmp(argv[0], "HEAD"))
996 die(_("could not unset upstream of HEAD when "
997 "it does not point to any branch."));
998 die(_("no such branch '%s'"), argv[0]);
999 }
1000
54d07f2e 1001 if (!branch_has_merge_config(branch))
b84869ef 1002 die(_("Branch '%s' has no upstream information"), branch->name);
b84869ef
CMN
1003
1004 strbuf_addf(&buf, "branch.%s.remote", branch->name);
1005 git_config_set_multivar(buf.buf, NULL, NULL, 1);
1006 strbuf_reset(&buf);
1007 strbuf_addf(&buf, "branch.%s.merge", branch->name);
1008 git_config_set_multivar(buf.buf, NULL, NULL, 1);
1009 strbuf_release(&buf);
5cd75c7d 1010 } else if (argc > 0 && argc <= 2) {
b347d06b
CMN
1011 struct branch *branch = branch_get(argv[0]);
1012 int branch_existed = 0, remote_tracking = 0;
1013 struct strbuf buf = STRBUF_INIT;
1014
8efb8899
NTND
1015 if (!strcmp(argv[0], "HEAD"))
1016 die(_("it does not make sense to create 'HEAD' manually"));
1017
1018 if (!branch)
1019 die(_("no such branch '%s'"), argv[0]);
1020
6e8f993a 1021 if (kinds != REF_LOCAL_BRANCH)
49df4b02 1022 die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
b347d06b
CMN
1023
1024 if (track == BRANCH_TRACK_OVERRIDE)
1025 fprintf(stderr, _("The --set-upstream flag is deprecated and will be removed. Consider using --track or --set-upstream-to\n"));
1026
1027 strbuf_addf(&buf, "refs/remotes/%s", branch->name);
1028 remote_tracking = ref_exists(buf.buf);
1029 strbuf_release(&buf);
1030
1031 branch_existed = ref_exists(branch->refname);
e496c003 1032 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
356e91f2 1033 force, reflog, 0, quiet, track);
b347d06b
CMN
1034
1035 /*
1036 * We only show the instructions if the user gave us
1037 * one branch which doesn't exist locally, but is the
1038 * name of a remote-tracking branch.
1039 */
1040 if (argc == 1 && track == BRANCH_TRACK_OVERRIDE &&
1041 !branch_existed && remote_tracking) {
1042 fprintf(stderr, _("\nIf you wanted to make '%s' track '%s', do this:\n\n"), head, branch->name);
1043 fprintf(stderr, _(" git branch -d %s\n"), branch->name);
1044 fprintf(stderr, _(" git branch --set-upstream-to %s\n"), branch->name);
1045 }
1046
6e8f993a 1047 } else
a8dfd5ea 1048 usage_with_options(builtin_branch_usage, options);
c31820c2
LH
1049
1050 return 0;
1051}