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);
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 (want_color(branch_use_color))
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 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;
263 const char **pattern;
267 static int match_patterns(const char **pattern, const char *refname)
270 return 1; /* no pattern always matches */
272 if (!fnmatch(*pattern, refname, 0))
279 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
281 struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
282 struct ref_list *ref_list = cb->ref_list;
283 struct ref_item *newitem;
284 struct commit *commit;
286 const char *prefix, *orig_refname = refname;
293 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
294 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
298 for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
299 prefix = ref_kind[i].prefix;
300 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
302 kind = ref_kind[i].kind;
303 refname += ref_kind[i].pfxlen;
306 if (ARRAY_SIZE(ref_kind) <= i)
309 /* Don't add types the caller doesn't want */
310 if ((kind & ref_list->kinds) == 0)
313 if (!match_patterns(cb->pattern, refname))
317 if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
318 commit = lookup_commit_reference_gently(sha1, 1);
320 cb->ret = error(_("branch '%s' does not point at a commit"), refname);
324 /* Filter with with_commit if specified */
325 if (!is_descendant_of(commit, ref_list->with_commit))
328 if (merge_filter != NO_FILTER)
329 add_pending_object(&ref_list->revs,
330 (struct object *)commit, refname);
333 ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
335 /* Record the new item */
336 newitem = &(ref_list->list[ref_list->index++]);
337 newitem->name = xstrdup(refname);
338 newitem->kind = kind;
339 newitem->commit = commit;
340 newitem->len = strlen(refname);
341 newitem->dest = resolve_symref(orig_refname, prefix);
342 /* adjust for "remotes/" */
343 if (newitem->kind == REF_REMOTE_BRANCH &&
344 ref_list->kinds != REF_REMOTE_BRANCH)
346 if (newitem->len > ref_list->maxwidth)
347 ref_list->maxwidth = newitem->len;
352 static void free_ref_list(struct ref_list *ref_list)
356 for (i = 0; i < ref_list->index; i++) {
357 free(ref_list->list[i].name);
358 free(ref_list->list[i].dest);
360 free(ref_list->list);
363 static int ref_cmp(const void *r1, const void *r2)
365 struct ref_item *c1 = (struct ref_item *)(r1);
366 struct ref_item *c2 = (struct ref_item *)(r2);
368 if (c1->kind != c2->kind)
369 return c1->kind - c2->kind;
370 return strcmp(c1->name, c2->name);
373 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
374 int show_upstream_ref)
377 struct branch *branch = branch_get(branch_name);
379 if (!stat_tracking_info(branch, &ours, &theirs)) {
380 if (branch && branch->merge && branch->merge[0]->dst &&
382 strbuf_addf(stat, "[%s] ",
383 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
387 strbuf_addch(stat, '[');
388 if (show_upstream_ref)
389 strbuf_addf(stat, "%s: ",
390 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
392 strbuf_addf(stat, _("behind %d] "), theirs);
394 strbuf_addf(stat, _("ahead %d] "), ours);
396 strbuf_addf(stat, _("ahead %d, behind %d] "), ours, theirs);
399 static int matches_merge_filter(struct commit *commit)
403 if (merge_filter == NO_FILTER)
406 is_merged = !!(commit->object.flags & UNINTERESTING);
407 return (is_merged == (merge_filter == SHOW_MERGED));
410 static void add_verbose_info(struct strbuf *out, struct ref_item *item,
411 int verbose, int abbrev)
413 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
414 const char *sub = " **** invalid ref ****";
415 struct commit *commit = item->commit;
417 if (commit && !parse_commit(commit)) {
418 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
422 if (item->kind == REF_LOCAL_BRANCH)
423 fill_tracking_info(&stat, item->name, verbose > 1);
425 strbuf_addf(out, " %s %s%s",
426 find_unique_abbrev(item->commit->object.sha1, abbrev),
428 strbuf_release(&stat);
429 strbuf_release(&subject);
432 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
433 int abbrev, int current, char *prefix)
437 struct commit *commit = item->commit;
438 struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
440 if (!matches_merge_filter(commit))
443 switch (item->kind) {
444 case REF_LOCAL_BRANCH:
445 color = BRANCH_COLOR_LOCAL;
447 case REF_REMOTE_BRANCH:
448 color = BRANCH_COLOR_REMOTE;
451 color = BRANCH_COLOR_PLAIN;
458 color = BRANCH_COLOR_CURRENT;
461 strbuf_addf(&name, "%s%s", prefix, item->name);
463 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
465 branch_get_color(BRANCH_COLOR_RESET));
467 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
468 name.buf, branch_get_color(BRANCH_COLOR_RESET));
471 strbuf_addf(&out, " -> %s", item->dest);
473 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
474 add_verbose_info(&out, item, verbose, abbrev);
475 printf("%s\n", out.buf);
476 strbuf_release(&name);
477 strbuf_release(&out);
480 static int calc_maxwidth(struct ref_list *refs)
483 for (i = 0; i < refs->index; i++) {
484 if (!matches_merge_filter(refs->list[i].commit))
486 if (refs->list[i].len > w)
487 w = refs->list[i].len;
493 static void show_detached(struct ref_list *ref_list)
495 struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
497 if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
498 struct ref_item item;
499 item.name = xstrdup(_("(no branch)"));
500 item.len = strlen(item.name);
501 item.kind = REF_LOCAL_BRANCH;
503 item.commit = head_commit;
504 if (item.len > ref_list->maxwidth)
505 ref_list->maxwidth = item.len;
506 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
511 static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit, const char **pattern)
514 struct append_ref_cb cb;
515 struct ref_list ref_list;
517 memset(&ref_list, 0, sizeof(ref_list));
518 ref_list.kinds = kinds;
519 ref_list.verbose = verbose;
520 ref_list.abbrev = abbrev;
521 ref_list.with_commit = with_commit;
522 if (merge_filter != NO_FILTER)
523 init_revisions(&ref_list.revs, NULL);
524 cb.ref_list = &ref_list;
525 cb.pattern = pattern;
527 for_each_rawref(append_ref, &cb);
528 if (merge_filter != NO_FILTER) {
529 struct commit *filter;
530 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
531 filter->object.flags |= UNINTERESTING;
532 add_pending_object(&ref_list.revs,
533 (struct object *) filter, "");
534 ref_list.revs.limited = 1;
535 prepare_revision_walk(&ref_list.revs);
537 ref_list.maxwidth = calc_maxwidth(&ref_list);
540 qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
542 detached = (detached && (kinds & REF_LOCAL_BRANCH));
543 if (detached && match_patterns(pattern, "HEAD"))
544 show_detached(&ref_list);
546 for (i = 0; i < ref_list.index; i++) {
547 int current = !detached &&
548 (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
549 !strcmp(ref_list.list[i].name, head);
550 char *prefix = (kinds != REF_REMOTE_BRANCH &&
551 ref_list.list[i].kind == REF_REMOTE_BRANCH)
553 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
554 abbrev, current, prefix);
557 free_ref_list(&ref_list);
560 error(_("some refs could not be read"));
565 static void rename_branch(const char *oldname, const char *newname, int force)
567 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
568 unsigned char sha1[20];
569 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
573 die(_("cannot rename the current branch while not on any."));
575 if (strbuf_check_branch_ref(&oldref, oldname)) {
577 * Bad name --- this could be an attempt to rename a
578 * ref that we used to allow to be created by accident.
580 if (resolve_ref(oldref.buf, sha1, 1, NULL))
583 die(_("Invalid branch name: '%s'"), oldname);
586 validate_new_branchname(newname, &newref, force, 0);
588 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
589 oldref.buf, newref.buf);
591 if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
592 die(_("Branch rename failed"));
593 strbuf_release(&logmsg);
596 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
598 /* no need to pass logmsg here as HEAD didn't really move */
599 if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
600 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
602 strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
603 strbuf_release(&oldref);
604 strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
605 strbuf_release(&newref);
606 if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
607 die(_("Branch is renamed, but update of config-file failed"));
608 strbuf_release(&oldsection);
609 strbuf_release(&newsection);
612 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
614 merge_filter = ((opt->long_name[0] == 'n')
618 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
621 if (get_sha1(arg, merge_filter_ref))
622 die(_("malformed object name %s"), arg);
626 int cmd_branch(int argc, const char **argv, const char *prefix)
628 int delete = 0, rename = 0, force_create = 0, list = 0;
629 int verbose = 0, abbrev = -1, detached = 0;
631 enum branch_track track;
632 int kinds = REF_LOCAL_BRANCH;
633 struct commit_list *with_commit = NULL;
635 struct option options[] = {
636 OPT_GROUP("Generic options"),
637 OPT__VERBOSE(&verbose,
638 "show hash and subject, give twice for upstream branch"),
639 OPT_SET_INT('t', "track", &track, "set up tracking mode (see git-pull(1))",
640 BRANCH_TRACK_EXPLICIT),
641 OPT_SET_INT( 0, "set-upstream", &track, "change upstream info",
642 BRANCH_TRACK_OVERRIDE),
643 OPT__COLOR(&branch_use_color, "use colored output"),
644 OPT_SET_INT('r', "remotes", &kinds, "act on remote-tracking branches",
647 OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
648 "print only branches that contain the commit",
649 PARSE_OPT_LASTARG_DEFAULT,
650 parse_opt_with_commit, (intptr_t)"HEAD",
653 OPTION_CALLBACK, 0, "with", &with_commit, "commit",
654 "print only branches that contain the commit",
655 PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
656 parse_opt_with_commit, (intptr_t) "HEAD",
658 OPT__ABBREV(&abbrev),
660 OPT_GROUP("Specific git-branch actions:"),
661 OPT_SET_INT('a', "all", &kinds, "list both remote-tracking and local branches",
662 REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
663 OPT_BIT('d', "delete", &delete, "delete fully merged branch", 1),
664 OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
665 OPT_BIT('m', "move", &rename, "move/rename a branch and its reflog", 1),
666 OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
667 OPT_BOOLEAN(0, "list", &list, "list branch names"),
668 OPT_BOOLEAN('l', "create-reflog", &reflog, "create the branch's reflog"),
669 OPT__FORCE(&force_create, "force creation (when already exists)"),
671 OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
672 "commit", "print only not merged branches",
673 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
674 opt_parse_merge_filter, (intptr_t) "HEAD",
677 OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
678 "commit", "print only merged branches",
679 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
680 opt_parse_merge_filter, (intptr_t) "HEAD",
685 if (argc == 2 && !strcmp(argv[1], "-h"))
686 usage_with_options(builtin_branch_usage, options);
688 git_config(git_branch_config, NULL);
690 track = git_branch_track;
692 head = resolve_ref("HEAD", head_sha1, 0, NULL);
694 die(_("Failed to resolve HEAD as a valid ref."));
695 head = xstrdup(head);
696 if (!strcmp(head, "HEAD")) {
699 if (prefixcmp(head, "refs/heads/"))
700 die(_("HEAD not found below refs/heads!"));
703 hashcpy(merge_filter_ref, head_sha1);
705 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
708 if (!delete && !rename && !force_create && argc == 0)
711 if (!!delete + !!rename + !!force_create + !!list > 1)
712 usage_with_options(builtin_branch_usage, options);
715 abbrev = DEFAULT_ABBREV;
718 return delete_branches(argc, argv, delete > 1, kinds);
720 return print_ref_list(kinds, detached, verbose, abbrev,
724 rename_branch(head, argv[0], rename > 1);
726 rename_branch(argv[0], argv[1], rename > 1);
728 usage_with_options(builtin_branch_usage, options);
729 } else if (argc <= 2) {
730 if (kinds != REF_LOCAL_BRANCH)
731 die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
732 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
733 force_create, reflog, track);
735 usage_with_options(builtin_branch_usage, options);