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";
160 /* TRANSLATORS: This is "remote " in "remote branch '%s' not found" */
161 remote = _("remote ");
164 case REF_LOCAL_BRANCH:
165 fmt = "refs/heads/%s";
169 die(_("cannot use -a with -d"));
173 head_rev = lookup_commit_reference(head_sha1);
175 die(_("Couldn't look up commit object for HEAD"));
177 for (i = 0; i < argc; i++, strbuf_release(&bname)) {
178 strbuf_branchname(&bname, argv[i]);
179 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
180 error(_("Cannot delete the branch '%s' "
181 "which you are currently on."), bname.buf);
188 name = xstrdup(mkpath(fmt, bname.buf));
189 if (!resolve_ref(name, sha1, 1, NULL)) {
190 error(_("%sbranch '%s' not found."),
196 rev = lookup_commit_reference(sha1);
198 error(_("Couldn't look up commit object for '%s'"), name);
203 if (!force && !branch_merged(kinds, bname.buf, rev, head_rev)) {
204 error(_("The branch '%s' is not fully merged.\n"
205 "If you are sure you want to delete it, "
206 "run 'git branch -D %s'."), bname.buf, bname.buf);
211 if (delete_ref(name, sha1, 0)) {
212 error(_("Error deleting %sbranch '%s'"), remote,
216 struct strbuf buf = STRBUF_INIT;
217 printf(_("Deleted %sbranch %s (was %s).\n"), remote,
219 find_unique_abbrev(sha1, DEFAULT_ABBREV));
220 strbuf_addf(&buf, "branch.%s", bname.buf);
221 if (git_config_rename_section(buf.buf, NULL) < 0)
222 warning(_("Update of config-file failed"));
223 strbuf_release(&buf);
235 unsigned int kind, len;
236 struct commit *commit;
240 struct rev_info revs;
241 int index, alloc, maxwidth, verbose, abbrev;
242 struct ref_item *list;
243 struct commit_list *with_commit;
247 static char *resolve_symref(const char *src, const char *prefix)
249 unsigned char sha1[20];
251 const char *dst, *cp;
253 dst = resolve_ref(src, sha1, 0, &flag);
254 if (!(dst && (flag & REF_ISSYMREF)))
256 if (prefix && (cp = skip_prefix(dst, prefix)))
261 struct append_ref_cb {
262 struct ref_list *ref_list;
266 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
268 struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
269 struct ref_list *ref_list = cb->ref_list;
270 struct ref_item *newitem;
271 struct commit *commit;
273 const char *prefix, *orig_refname = refname;
280 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
281 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
285 for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
286 prefix = ref_kind[i].prefix;
287 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
289 kind = ref_kind[i].kind;
290 refname += ref_kind[i].pfxlen;
293 if (ARRAY_SIZE(ref_kind) <= i)
296 /* Don't add types the caller doesn't want */
297 if ((kind & ref_list->kinds) == 0)
301 if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
302 commit = lookup_commit_reference_gently(sha1, 1);
304 cb->ret = error(_("branch '%s' does not point at a commit"), refname);
308 /* Filter with with_commit if specified */
309 if (!is_descendant_of(commit, ref_list->with_commit))
312 if (merge_filter != NO_FILTER)
313 add_pending_object(&ref_list->revs,
314 (struct object *)commit, refname);
317 ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
319 /* Record the new item */
320 newitem = &(ref_list->list[ref_list->index++]);
321 newitem->name = xstrdup(refname);
322 newitem->kind = kind;
323 newitem->commit = commit;
324 newitem->len = strlen(refname);
325 newitem->dest = resolve_symref(orig_refname, prefix);
326 /* adjust for "remotes/" */
327 if (newitem->kind == REF_REMOTE_BRANCH &&
328 ref_list->kinds != REF_REMOTE_BRANCH)
330 if (newitem->len > ref_list->maxwidth)
331 ref_list->maxwidth = newitem->len;
336 static void free_ref_list(struct ref_list *ref_list)
340 for (i = 0; i < ref_list->index; i++) {
341 free(ref_list->list[i].name);
342 free(ref_list->list[i].dest);
344 free(ref_list->list);
347 static int ref_cmp(const void *r1, const void *r2)
349 struct ref_item *c1 = (struct ref_item *)(r1);
350 struct ref_item *c2 = (struct ref_item *)(r2);
352 if (c1->kind != c2->kind)
353 return c1->kind - c2->kind;
354 return strcmp(c1->name, c2->name);
357 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
358 int show_upstream_ref)
361 struct branch *branch = branch_get(branch_name);
363 if (!stat_tracking_info(branch, &ours, &theirs)) {
364 if (branch && branch->merge && branch->merge[0]->dst &&
366 strbuf_addf(stat, "[%s] ",
367 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
371 strbuf_addch(stat, '[');
372 if (show_upstream_ref)
373 strbuf_addf(stat, "%s: ",
374 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
376 strbuf_addf(stat, _("behind %d] "), theirs);
378 strbuf_addf(stat, _("ahead %d] "), ours);
380 strbuf_addf(stat, _("ahead %d, behind %d] "), ours, theirs);
383 static int matches_merge_filter(struct commit *commit)
387 if (merge_filter == NO_FILTER)
390 is_merged = !!(commit->object.flags & UNINTERESTING);
391 return (is_merged == (merge_filter == SHOW_MERGED));
394 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
395 int abbrev, int current, char *prefix)
399 struct commit *commit = item->commit;
400 struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
402 if (!matches_merge_filter(commit))
405 switch (item->kind) {
406 case REF_LOCAL_BRANCH:
407 color = BRANCH_COLOR_LOCAL;
409 case REF_REMOTE_BRANCH:
410 color = BRANCH_COLOR_REMOTE;
413 color = BRANCH_COLOR_PLAIN;
420 color = BRANCH_COLOR_CURRENT;
423 strbuf_addf(&name, "%s%s", prefix, item->name);
425 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
427 branch_get_color(BRANCH_COLOR_RESET));
429 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
430 name.buf, branch_get_color(BRANCH_COLOR_RESET));
433 strbuf_addf(&out, " -> %s", item->dest);
435 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
436 const char *sub = " **** invalid ref ****";
438 commit = item->commit;
439 if (commit && !parse_commit(commit)) {
440 struct pretty_print_context ctx = {0};
441 pretty_print_commit(CMIT_FMT_ONELINE, commit,
446 if (item->kind == REF_LOCAL_BRANCH)
447 fill_tracking_info(&stat, item->name, verbose > 1);
449 strbuf_addf(&out, " %s %s%s",
450 find_unique_abbrev(item->commit->object.sha1, abbrev),
452 strbuf_release(&stat);
453 strbuf_release(&subject);
455 printf("%s\n", out.buf);
456 strbuf_release(&name);
457 strbuf_release(&out);
460 static int calc_maxwidth(struct ref_list *refs)
463 for (i = 0; i < refs->index; i++) {
464 if (!matches_merge_filter(refs->list[i].commit))
466 if (refs->list[i].len > w)
467 w = refs->list[i].len;
473 static void show_detached(struct ref_list *ref_list)
475 struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
477 if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
478 struct ref_item item;
479 item.name = xstrdup("(no branch)");
480 item.len = strlen(item.name);
481 item.kind = REF_LOCAL_BRANCH;
483 item.commit = head_commit;
484 if (item.len > ref_list->maxwidth)
485 ref_list->maxwidth = item.len;
486 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
491 static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit)
494 struct append_ref_cb cb;
495 struct ref_list ref_list;
497 memset(&ref_list, 0, sizeof(ref_list));
498 ref_list.kinds = kinds;
499 ref_list.verbose = verbose;
500 ref_list.abbrev = abbrev;
501 ref_list.with_commit = with_commit;
502 if (merge_filter != NO_FILTER)
503 init_revisions(&ref_list.revs, NULL);
504 cb.ref_list = &ref_list;
506 for_each_rawref(append_ref, &cb);
507 if (merge_filter != NO_FILTER) {
508 struct commit *filter;
509 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
510 filter->object.flags |= UNINTERESTING;
511 add_pending_object(&ref_list.revs,
512 (struct object *) filter, "");
513 ref_list.revs.limited = 1;
514 prepare_revision_walk(&ref_list.revs);
516 ref_list.maxwidth = calc_maxwidth(&ref_list);
519 qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
521 detached = (detached && (kinds & REF_LOCAL_BRANCH));
523 show_detached(&ref_list);
525 for (i = 0; i < ref_list.index; i++) {
526 int current = !detached &&
527 (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
528 !strcmp(ref_list.list[i].name, head);
529 char *prefix = (kinds != REF_REMOTE_BRANCH &&
530 ref_list.list[i].kind == REF_REMOTE_BRANCH)
532 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
533 abbrev, current, prefix);
536 free_ref_list(&ref_list);
539 error(_("some refs could not be read"));
544 static void rename_branch(const char *oldname, const char *newname, int force)
546 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
547 unsigned char sha1[20];
548 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
552 die(_("cannot rename the current branch while not on any."));
554 if (strbuf_check_branch_ref(&oldref, oldname)) {
556 * Bad name --- this could be an attempt to rename a
557 * ref that we used to allow to be created by accident.
559 if (resolve_ref(oldref.buf, sha1, 1, NULL))
562 die(_("Invalid branch name: '%s'"), oldname);
565 if (strbuf_check_branch_ref(&newref, newname))
566 die(_("Invalid branch name: '%s'"), newname);
568 if (resolve_ref(newref.buf, sha1, 1, NULL) && !force)
569 die(_("A branch named '%s' already exists."), newref.buf + 11);
571 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
572 oldref.buf, newref.buf);
574 if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
575 die(_("Branch rename failed"));
576 strbuf_release(&logmsg);
579 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
581 /* no need to pass logmsg here as HEAD didn't really move */
582 if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
583 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
585 strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
586 strbuf_release(&oldref);
587 strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
588 strbuf_release(&newref);
589 if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
590 die(_("Branch is renamed, but update of config-file failed"));
591 strbuf_release(&oldsection);
592 strbuf_release(&newsection);
595 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
597 merge_filter = ((opt->long_name[0] == 'n')
601 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
604 if (get_sha1(arg, merge_filter_ref))
605 die(_("malformed object name %s"), arg);
609 int cmd_branch(int argc, const char **argv, const char *prefix)
611 int delete = 0, rename = 0, force_create = 0;
612 int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
614 enum branch_track track;
615 int kinds = REF_LOCAL_BRANCH;
616 struct commit_list *with_commit = NULL;
618 struct option options[] = {
619 OPT_GROUP("Generic options"),
620 OPT__VERBOSE(&verbose,
621 "show hash and subject, give twice for upstream branch"),
622 OPT_SET_INT('t', "track", &track, "set up tracking mode (see git-pull(1))",
623 BRANCH_TRACK_EXPLICIT),
624 OPT_SET_INT( 0, "set-upstream", &track, "change upstream info",
625 BRANCH_TRACK_OVERRIDE),
626 OPT__COLOR(&branch_use_color, "use colored output"),
627 OPT_SET_INT('r', NULL, &kinds, "act on remote-tracking branches",
630 OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
631 "print only branches that contain the commit",
632 PARSE_OPT_LASTARG_DEFAULT,
633 parse_opt_with_commit, (intptr_t)"HEAD",
636 OPTION_CALLBACK, 0, "with", &with_commit, "commit",
637 "print only branches that contain the commit",
638 PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
639 parse_opt_with_commit, (intptr_t) "HEAD",
641 OPT__ABBREV(&abbrev),
643 OPT_GROUP("Specific git-branch actions:"),
644 OPT_SET_INT('a', NULL, &kinds, "list both remote-tracking and local branches",
645 REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
646 OPT_BIT('d', NULL, &delete, "delete fully merged branch", 1),
647 OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
648 OPT_BIT('m', NULL, &rename, "move/rename a branch and its reflog", 1),
649 OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
650 OPT_BOOLEAN('l', NULL, &reflog, "create the branch's reflog"),
651 OPT__FORCE(&force_create, "force creation (when already exists)"),
653 OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
654 "commit", "print only not merged branches",
655 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
656 opt_parse_merge_filter, (intptr_t) "HEAD",
659 OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
660 "commit", "print only merged branches",
661 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
662 opt_parse_merge_filter, (intptr_t) "HEAD",
667 if (argc == 2 && !strcmp(argv[1], "-h"))
668 usage_with_options(builtin_branch_usage, options);
670 git_config(git_branch_config, NULL);
672 if (branch_use_color == -1)
673 branch_use_color = git_use_color_default;
675 track = git_branch_track;
677 head = resolve_ref("HEAD", head_sha1, 0, NULL);
679 die(_("Failed to resolve HEAD as a valid ref."));
680 head = xstrdup(head);
681 if (!strcmp(head, "HEAD")) {
684 if (prefixcmp(head, "refs/heads/"))
685 die(_("HEAD not found below refs/heads!"));
688 hashcpy(merge_filter_ref, head_sha1);
690 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
692 if (!!delete + !!rename + !!force_create > 1)
693 usage_with_options(builtin_branch_usage, options);
696 return delete_branches(argc, argv, delete > 1, kinds);
698 return print_ref_list(kinds, detached, verbose, abbrev, with_commit);
699 else if (rename && (argc == 1))
700 rename_branch(head, argv[0], rename > 1);
701 else if (rename && (argc == 2))
702 rename_branch(argv[0], argv[1], rename > 1);
703 else if (argc <= 2) {
704 if (kinds != REF_LOCAL_BRANCH)
705 die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
706 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
707 force_create, reflog, track);
709 usage_with_options(builtin_branch_usage, options);