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