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