4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-branch.sh by Junio C Hamano.
14 #include "parse-options.h"
19 static const char * const builtin_branch_usage[] = {
20 "git branch [options] [-r | -a] [--merged | --no-merged]",
21 "git branch [options] [-l] [-f] <branchname> [<start-point>]",
22 "git branch [options] [-r] (-d | -D) <branchname>",
23 "git branch [options] (-m | -M) [<oldbranch>] <newbranch>",
27 #define REF_LOCAL_BRANCH 0x01
28 #define REF_REMOTE_BRANCH 0x02
30 static const char *head;
31 static unsigned char head_sha1[20];
33 static int branch_use_color = -1;
34 static char branch_colors[][COLOR_MAXLEN] = {
36 GIT_COLOR_NORMAL, /* PLAIN */
37 GIT_COLOR_RED, /* REMOTE */
38 GIT_COLOR_NORMAL, /* LOCAL */
39 GIT_COLOR_GREEN, /* CURRENT */
42 BRANCH_COLOR_RESET = 0,
43 BRANCH_COLOR_PLAIN = 1,
44 BRANCH_COLOR_REMOTE = 2,
45 BRANCH_COLOR_LOCAL = 3,
46 BRANCH_COLOR_CURRENT = 4
49 static enum merge_filter {
54 static unsigned char merge_filter_ref[20];
56 static int parse_branch_color_slot(const char *var, int ofs)
58 if (!strcasecmp(var+ofs, "plain"))
59 return BRANCH_COLOR_PLAIN;
60 if (!strcasecmp(var+ofs, "reset"))
61 return BRANCH_COLOR_RESET;
62 if (!strcasecmp(var+ofs, "remote"))
63 return BRANCH_COLOR_REMOTE;
64 if (!strcasecmp(var+ofs, "local"))
65 return BRANCH_COLOR_LOCAL;
66 if (!strcasecmp(var+ofs, "current"))
67 return BRANCH_COLOR_CURRENT;
71 static int git_branch_config(const char *var, const char *value, void *cb)
73 if (!strcmp(var, "color.branch")) {
74 branch_use_color = git_config_colorbool(var, value, -1);
77 if (!prefixcmp(var, "color.branch.")) {
78 int slot = parse_branch_color_slot(var, 13);
82 return config_error_nonbool(var);
83 color_parse(value, var, branch_colors[slot]);
86 return git_color_default_config(var, value, cb);
89 static const char *branch_get_color(enum color_branch ix)
91 if (branch_use_color > 0)
92 return branch_colors[ix];
96 static int branch_merged(int kind, const char *name,
97 struct commit *rev, struct commit *head_rev)
100 * This checks whether the merge bases of branch and HEAD (or
101 * the other branch this branch builds upon) contains the
102 * branch, which means that the branch has already been merged
103 * safely to HEAD (or the other branch).
105 struct commit *reference_rev = NULL;
106 const char *reference_name = NULL;
109 if (kind == REF_LOCAL_BRANCH) {
110 struct branch *branch = branch_get(name);
111 unsigned char sha1[20];
116 branch->merge[0]->dst &&
118 resolve_ref(branch->merge[0]->dst, sha1, 1, NULL)) != NULL)
119 reference_rev = lookup_commit_reference(sha1);
122 reference_rev = head_rev;
124 merged = in_merge_bases(rev, &reference_rev, 1);
127 * After the safety valve is fully redefined to "check with
128 * upstream, if any, otherwise with HEAD", we should just
129 * return the result of the in_merge_bases() above without
130 * any of the following code, but during the transition period,
131 * a gentle reminder is in order.
133 if ((head_rev != reference_rev) &&
134 in_merge_bases(rev, &head_rev, 1) != merged) {
136 warning("deleting branch '%s' that has been merged to\n"
137 " '%s', but it is not yet merged to HEAD.",
138 name, reference_name);
140 warning("not deleting branch '%s' that is not yet merged to\n"
141 " '%s', even though it is merged to HEAD.",
142 name, reference_name);
147 static int delete_branches(int argc, const char **argv, int force, int kinds)
149 struct commit *rev, *head_rev = NULL;
150 unsigned char sha1[20];
152 const char *fmt, *remote;
155 struct strbuf bname = STRBUF_INIT;
158 case REF_REMOTE_BRANCH:
159 fmt = "refs/remotes/%s";
163 case REF_LOCAL_BRANCH:
164 fmt = "refs/heads/%s";
168 die("cannot use -a with -d");
172 head_rev = lookup_commit_reference(head_sha1);
174 die("Couldn't look up commit object for HEAD");
176 for (i = 0; i < argc; i++, strbuf_release(&bname)) {
177 strbuf_branchname(&bname, argv[i]);
178 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
179 error("Cannot delete the branch '%s' "
180 "which you are currently on.", bname.buf);
187 name = xstrdup(mkpath(fmt, bname.buf));
188 if (!resolve_ref(name, sha1, 1, NULL)) {
189 error("%sbranch '%s' not found.",
195 rev = lookup_commit_reference(sha1);
197 error("Couldn't look up commit object for '%s'", name);
202 if (!force && !branch_merged(kinds, bname.buf, rev, head_rev)) {
203 error("The branch '%s' is not fully merged.\n"
204 "If you are sure you want to delete it, "
205 "run 'git branch -D %s'.", bname.buf, bname.buf);
210 if (delete_ref(name, sha1, 0)) {
211 error("Error deleting %sbranch '%s'", remote,
215 struct strbuf buf = STRBUF_INIT;
216 printf("Deleted %sbranch %s (was %s).\n", remote,
218 find_unique_abbrev(sha1, DEFAULT_ABBREV));
219 strbuf_addf(&buf, "branch.%s", bname.buf);
220 if (git_config_rename_section(buf.buf, NULL) < 0)
221 warning("Update of config-file failed");
222 strbuf_release(&buf);
234 unsigned int kind, len;
235 struct commit *commit;
239 struct rev_info revs;
240 int index, alloc, maxwidth, verbose, abbrev;
241 struct ref_item *list;
242 struct commit_list *with_commit;
246 static char *resolve_symref(const char *src, const char *prefix)
248 unsigned char sha1[20];
250 const char *dst, *cp;
252 dst = resolve_ref(src, sha1, 0, &flag);
253 if (!(dst && (flag & REF_ISSYMREF)))
255 if (prefix && (cp = skip_prefix(dst, prefix)))
260 struct append_ref_cb {
261 struct ref_list *ref_list;
265 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
267 struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
268 struct ref_list *ref_list = cb->ref_list;
269 struct ref_item *newitem;
270 struct commit *commit;
272 const char *prefix, *orig_refname = refname;
279 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
280 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
284 for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
285 prefix = ref_kind[i].prefix;
286 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
288 kind = ref_kind[i].kind;
289 refname += ref_kind[i].pfxlen;
292 if (ARRAY_SIZE(ref_kind) <= i)
295 /* Don't add types the caller doesn't want */
296 if ((kind & ref_list->kinds) == 0)
300 if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
301 commit = lookup_commit_reference_gently(sha1, 1);
303 cb->ret = error("branch '%s' does not point at a commit", refname);
307 /* Filter with with_commit if specified */
308 if (!is_descendant_of(commit, ref_list->with_commit))
311 if (merge_filter != NO_FILTER)
312 add_pending_object(&ref_list->revs,
313 (struct object *)commit, refname);
316 ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
318 /* Record the new item */
319 newitem = &(ref_list->list[ref_list->index++]);
320 newitem->name = xstrdup(refname);
321 newitem->kind = kind;
322 newitem->commit = commit;
323 newitem->len = strlen(refname);
324 newitem->dest = resolve_symref(orig_refname, prefix);
325 /* adjust for "remotes/" */
326 if (newitem->kind == REF_REMOTE_BRANCH &&
327 ref_list->kinds != REF_REMOTE_BRANCH)
329 if (newitem->len > ref_list->maxwidth)
330 ref_list->maxwidth = newitem->len;
335 static void free_ref_list(struct ref_list *ref_list)
339 for (i = 0; i < ref_list->index; i++) {
340 free(ref_list->list[i].name);
341 free(ref_list->list[i].dest);
343 free(ref_list->list);
346 static int ref_cmp(const void *r1, const void *r2)
348 struct ref_item *c1 = (struct ref_item *)(r1);
349 struct ref_item *c2 = (struct ref_item *)(r2);
351 if (c1->kind != c2->kind)
352 return c1->kind - c2->kind;
353 return strcmp(c1->name, c2->name);
356 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
357 int show_upstream_ref)
360 struct branch *branch = branch_get(branch_name);
362 if (!stat_tracking_info(branch, &ours, &theirs)) {
363 if (branch && branch->merge && branch->merge[0]->dst &&
365 strbuf_addf(stat, "[%s] ",
366 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
370 strbuf_addch(stat, '[');
371 if (show_upstream_ref)
372 strbuf_addf(stat, "%s: ",
373 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
375 strbuf_addf(stat, "behind %d] ", theirs);
377 strbuf_addf(stat, "ahead %d] ", ours);
379 strbuf_addf(stat, "ahead %d, behind %d] ", ours, theirs);
382 static int matches_merge_filter(struct commit *commit)
386 if (merge_filter == NO_FILTER)
389 is_merged = !!(commit->object.flags & UNINTERESTING);
390 return (is_merged == (merge_filter == SHOW_MERGED));
393 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
394 int abbrev, int current, char *prefix)
398 struct commit *commit = item->commit;
399 struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
401 if (!matches_merge_filter(commit))
404 switch (item->kind) {
405 case REF_LOCAL_BRANCH:
406 color = BRANCH_COLOR_LOCAL;
408 case REF_REMOTE_BRANCH:
409 color = BRANCH_COLOR_REMOTE;
412 color = BRANCH_COLOR_PLAIN;
419 color = BRANCH_COLOR_CURRENT;
422 strbuf_addf(&name, "%s%s", prefix, item->name);
424 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
426 branch_get_color(BRANCH_COLOR_RESET));
428 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
429 name.buf, branch_get_color(BRANCH_COLOR_RESET));
432 strbuf_addf(&out, " -> %s", item->dest);
434 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
435 const char *sub = " **** invalid ref ****";
437 commit = item->commit;
438 if (commit && !parse_commit(commit)) {
439 struct pretty_print_context ctx = {0};
440 pretty_print_commit(CMIT_FMT_ONELINE, commit,
445 if (item->kind == REF_LOCAL_BRANCH)
446 fill_tracking_info(&stat, item->name, verbose > 1);
448 strbuf_addf(&out, " %s %s%s",
449 find_unique_abbrev(item->commit->object.sha1, abbrev),
451 strbuf_release(&stat);
452 strbuf_release(&subject);
454 printf("%s\n", out.buf);
455 strbuf_release(&name);
456 strbuf_release(&out);
459 static int calc_maxwidth(struct ref_list *refs)
462 for (i = 0; i < refs->index; i++) {
463 if (!matches_merge_filter(refs->list[i].commit))
465 if (refs->list[i].len > w)
466 w = refs->list[i].len;
472 static void show_detached(struct ref_list *ref_list)
474 struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
476 if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
477 struct ref_item item;
478 item.name = xstrdup("(no branch)");
479 item.len = strlen(item.name);
480 item.kind = REF_LOCAL_BRANCH;
482 item.commit = head_commit;
483 if (item.len > ref_list->maxwidth)
484 ref_list->maxwidth = item.len;
485 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
490 static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit)
493 struct append_ref_cb cb;
494 struct ref_list ref_list;
496 memset(&ref_list, 0, sizeof(ref_list));
497 ref_list.kinds = kinds;
498 ref_list.verbose = verbose;
499 ref_list.abbrev = abbrev;
500 ref_list.with_commit = with_commit;
501 if (merge_filter != NO_FILTER)
502 init_revisions(&ref_list.revs, NULL);
503 cb.ref_list = &ref_list;
505 for_each_rawref(append_ref, &cb);
506 if (merge_filter != NO_FILTER) {
507 struct commit *filter;
508 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
509 filter->object.flags |= UNINTERESTING;
510 add_pending_object(&ref_list.revs,
511 (struct object *) filter, "");
512 ref_list.revs.limited = 1;
513 prepare_revision_walk(&ref_list.revs);
515 ref_list.maxwidth = calc_maxwidth(&ref_list);
518 qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
520 detached = (detached && (kinds & REF_LOCAL_BRANCH));
522 show_detached(&ref_list);
524 for (i = 0; i < ref_list.index; i++) {
525 int current = !detached &&
526 (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
527 !strcmp(ref_list.list[i].name, head);
528 char *prefix = (kinds != REF_REMOTE_BRANCH &&
529 ref_list.list[i].kind == REF_REMOTE_BRANCH)
531 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
532 abbrev, current, prefix);
535 free_ref_list(&ref_list);
538 error("some refs could not be read");
543 static void rename_branch(const char *oldname, const char *newname, int force)
545 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
546 unsigned char sha1[20];
547 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
551 die("cannot rename the current branch while not on any.");
553 if (strbuf_check_branch_ref(&oldref, oldname)) {
555 * Bad name --- this could be an attempt to rename a
556 * ref that we used to allow to be created by accident.
558 if (resolve_ref(oldref.buf, sha1, 1, NULL))
561 die("Invalid branch name: '%s'", oldname);
564 if (strbuf_check_branch_ref(&newref, newname))
565 die("Invalid branch name: '%s'", newname);
567 if (resolve_ref(newref.buf, sha1, 1, NULL) && !force)
568 die("A branch named '%s' already exists.", newref.buf + 11);
570 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
571 oldref.buf, newref.buf);
573 if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
574 die("Branch rename failed");
575 strbuf_release(&logmsg);
578 warning("Renamed a misnamed branch '%s' away", oldref.buf + 11);
580 /* no need to pass logmsg here as HEAD didn't really move */
581 if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
582 die("Branch renamed to %s, but HEAD is not updated!", newname);
584 strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
585 strbuf_release(&oldref);
586 strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
587 strbuf_release(&newref);
588 if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
589 die("Branch is renamed, but update of config-file failed");
590 strbuf_release(&oldsection);
591 strbuf_release(&newsection);
594 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
596 merge_filter = ((opt->long_name[0] == 'n')
600 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
603 if (get_sha1(arg, merge_filter_ref))
604 die("malformed object name %s", arg);
608 int cmd_branch(int argc, const char **argv, const char *prefix)
610 int delete = 0, rename = 0, force_create = 0;
611 int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
613 enum branch_track track;
614 int kinds = REF_LOCAL_BRANCH;
615 struct commit_list *with_commit = NULL;
617 struct option options[] = {
618 OPT_GROUP("Generic options"),
619 OPT__VERBOSE(&verbose,
620 "show hash and subject, give twice for upstream branch"),
621 OPT_SET_INT('t', "track", &track, "set up tracking mode (see git-pull(1))",
622 BRANCH_TRACK_EXPLICIT),
623 OPT_SET_INT( 0, "set-upstream", &track, "change upstream info",
624 BRANCH_TRACK_OVERRIDE),
625 OPT__COLOR(&branch_use_color, "use colored output"),
626 OPT_SET_INT('r', NULL, &kinds, "act on remote-tracking branches",
629 OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
630 "print only branches that contain the commit",
631 PARSE_OPT_LASTARG_DEFAULT,
632 parse_opt_with_commit, (intptr_t)"HEAD",
635 OPTION_CALLBACK, 0, "with", &with_commit, "commit",
636 "print only branches that contain the commit",
637 PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
638 parse_opt_with_commit, (intptr_t) "HEAD",
640 OPT__ABBREV(&abbrev),
642 OPT_GROUP("Specific git-branch actions:"),
643 OPT_SET_INT('a', NULL, &kinds, "list both remote-tracking and local branches",
644 REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
645 OPT_BIT('d', NULL, &delete, "delete fully merged branch", 1),
646 OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
647 OPT_BIT('m', NULL, &rename, "move/rename a branch and its reflog", 1),
648 OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
649 OPT_BOOLEAN('l', NULL, &reflog, "create the branch's reflog"),
650 OPT__FORCE(&force_create, "force creation (when already exists)"),
652 OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
653 "commit", "print only not merged branches",
654 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
655 opt_parse_merge_filter, (intptr_t) "HEAD",
658 OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
659 "commit", "print only merged branches",
660 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
661 opt_parse_merge_filter, (intptr_t) "HEAD",
666 if (argc == 2 && !strcmp(argv[1], "-h"))
667 usage_with_options(builtin_branch_usage, options);
669 git_config(git_branch_config, NULL);
671 if (branch_use_color == -1)
672 branch_use_color = git_use_color_default;
674 track = git_branch_track;
676 head = resolve_ref("HEAD", head_sha1, 0, NULL);
678 die("Failed to resolve HEAD as a valid ref.");
679 head = xstrdup(head);
680 if (!strcmp(head, "HEAD")) {
683 if (prefixcmp(head, "refs/heads/"))
684 die("HEAD not found below refs/heads!");
687 hashcpy(merge_filter_ref, head_sha1);
689 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
691 if (!!delete + !!rename + !!force_create > 1)
692 usage_with_options(builtin_branch_usage, options);
695 return delete_branches(argc, argv, delete > 1, kinds);
697 return print_ref_list(kinds, detached, verbose, abbrev, with_commit);
698 else if (rename && (argc == 1))
699 rename_branch(head, argv[0], rename > 1);
700 else if (rename && (argc == 2))
701 rename_branch(argv[0], argv[1], rename > 1);
702 else if (argc <= 2) {
703 if (kinds != REF_LOCAL_BRANCH)
704 die("-a and -r options to 'git branch' do not make sense with a branch name");
705 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
706 force_create, reflog, track);
708 usage_with_options(builtin_branch_usage, options);