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;
107 void *reference_name_to_free = NULL;
110 if (kind == REF_LOCAL_BRANCH) {
111 struct branch *branch = branch_get(name);
112 unsigned char sha1[20];
117 branch->merge[0]->dst &&
118 (reference_name = reference_name_to_free =
119 resolve_refdup(branch->merge[0]->dst, sha1, 1, NULL)) != NULL)
120 reference_rev = lookup_commit_reference(sha1);
123 reference_rev = head_rev;
125 merged = in_merge_bases(rev, &reference_rev, 1);
128 * After the safety valve is fully redefined to "check with
129 * upstream, if any, otherwise with HEAD", we should just
130 * return the result of the in_merge_bases() above without
131 * any of the following code, but during the transition period,
132 * a gentle reminder is in order.
134 if ((head_rev != reference_rev) &&
135 in_merge_bases(rev, &head_rev, 1) != merged) {
137 warning(_("deleting branch '%s' that has been merged to\n"
138 " '%s', but not yet merged to HEAD."),
139 name, reference_name);
141 warning(_("not deleting branch '%s' that is not yet merged to\n"
142 " '%s', even though it is merged to HEAD."),
143 name, reference_name);
145 free(reference_name_to_free);
149 static int delete_branches(int argc, const char **argv, int force, int kinds)
151 struct commit *rev, *head_rev = NULL;
152 unsigned char sha1[20];
154 const char *fmt, *remote;
157 struct strbuf bname = STRBUF_INIT;
160 case REF_REMOTE_BRANCH:
161 fmt = "refs/remotes/%s";
162 /* TRANSLATORS: This is "remote " in "remote branch '%s' not found" */
163 remote = _("remote ");
166 case REF_LOCAL_BRANCH:
167 fmt = "refs/heads/%s";
171 die(_("cannot use -a with -d"));
175 head_rev = lookup_commit_reference(head_sha1);
177 die(_("Couldn't look up commit object for HEAD"));
179 for (i = 0; i < argc; i++, strbuf_release(&bname)) {
180 strbuf_branchname(&bname, argv[i]);
181 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
182 error(_("Cannot delete the branch '%s' "
183 "which you are currently on."), bname.buf);
190 name = xstrdup(mkpath(fmt, bname.buf));
191 if (read_ref(name, sha1)) {
192 error(_("%sbranch '%s' not found."),
198 rev = lookup_commit_reference(sha1);
200 error(_("Couldn't look up commit object for '%s'"), name);
205 if (!force && !branch_merged(kinds, bname.buf, rev, head_rev)) {
206 error(_("The branch '%s' is not fully merged.\n"
207 "If you are sure you want to delete it, "
208 "run 'git branch -D %s'."), bname.buf, bname.buf);
213 if (delete_ref(name, sha1, 0)) {
214 error(_("Error deleting %sbranch '%s'"), remote,
218 struct strbuf buf = STRBUF_INIT;
219 printf(_("Deleted %sbranch %s (was %s).\n"), remote,
221 find_unique_abbrev(sha1, DEFAULT_ABBREV));
222 strbuf_addf(&buf, "branch.%s", bname.buf);
223 if (git_config_rename_section(buf.buf, NULL) < 0)
224 warning(_("Update of config-file failed"));
225 strbuf_release(&buf);
237 unsigned int kind, len;
238 struct commit *commit;
242 struct rev_info revs;
243 int index, alloc, maxwidth, verbose, abbrev;
244 struct ref_item *list;
245 struct commit_list *with_commit;
249 static char *resolve_symref(const char *src, const char *prefix)
251 unsigned char sha1[20];
253 const char *dst, *cp;
255 dst = resolve_ref_unsafe(src, sha1, 0, &flag);
256 if (!(dst && (flag & REF_ISSYMREF)))
258 if (prefix && (cp = skip_prefix(dst, prefix)))
263 struct append_ref_cb {
264 struct ref_list *ref_list;
265 const char **pattern;
269 static int match_patterns(const char **pattern, const char *refname)
272 return 1; /* no pattern always matches */
274 if (!fnmatch(*pattern, refname, 0))
281 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
283 struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
284 struct ref_list *ref_list = cb->ref_list;
285 struct ref_item *newitem;
286 struct commit *commit;
288 const char *prefix, *orig_refname = refname;
295 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
296 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
300 for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
301 prefix = ref_kind[i].prefix;
302 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
304 kind = ref_kind[i].kind;
305 refname += ref_kind[i].pfxlen;
308 if (ARRAY_SIZE(ref_kind) <= i)
311 /* Don't add types the caller doesn't want */
312 if ((kind & ref_list->kinds) == 0)
315 if (!match_patterns(cb->pattern, refname))
319 if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
320 commit = lookup_commit_reference_gently(sha1, 1);
322 cb->ret = error(_("branch '%s' does not point at a commit"), refname);
326 /* Filter with with_commit if specified */
327 if (!is_descendant_of(commit, ref_list->with_commit))
330 if (merge_filter != NO_FILTER)
331 add_pending_object(&ref_list->revs,
332 (struct object *)commit, refname);
335 ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
337 /* Record the new item */
338 newitem = &(ref_list->list[ref_list->index++]);
339 newitem->name = xstrdup(refname);
340 newitem->kind = kind;
341 newitem->commit = commit;
342 newitem->len = strlen(refname);
343 newitem->dest = resolve_symref(orig_refname, prefix);
344 /* adjust for "remotes/" */
345 if (newitem->kind == REF_REMOTE_BRANCH &&
346 ref_list->kinds != REF_REMOTE_BRANCH)
348 if (newitem->len > ref_list->maxwidth)
349 ref_list->maxwidth = newitem->len;
354 static void free_ref_list(struct ref_list *ref_list)
358 for (i = 0; i < ref_list->index; i++) {
359 free(ref_list->list[i].name);
360 free(ref_list->list[i].dest);
362 free(ref_list->list);
365 static int ref_cmp(const void *r1, const void *r2)
367 struct ref_item *c1 = (struct ref_item *)(r1);
368 struct ref_item *c2 = (struct ref_item *)(r2);
370 if (c1->kind != c2->kind)
371 return c1->kind - c2->kind;
372 return strcmp(c1->name, c2->name);
375 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
376 int show_upstream_ref)
379 struct branch *branch = branch_get(branch_name);
381 if (!stat_tracking_info(branch, &ours, &theirs)) {
382 if (branch && branch->merge && branch->merge[0]->dst &&
384 strbuf_addf(stat, "[%s] ",
385 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
389 strbuf_addch(stat, '[');
390 if (show_upstream_ref)
391 strbuf_addf(stat, "%s: ",
392 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
394 strbuf_addf(stat, _("behind %d] "), theirs);
396 strbuf_addf(stat, _("ahead %d] "), ours);
398 strbuf_addf(stat, _("ahead %d, behind %d] "), ours, theirs);
401 static int matches_merge_filter(struct commit *commit)
405 if (merge_filter == NO_FILTER)
408 is_merged = !!(commit->object.flags & UNINTERESTING);
409 return (is_merged == (merge_filter == SHOW_MERGED));
412 static void add_verbose_info(struct strbuf *out, struct ref_item *item,
413 int verbose, int abbrev)
415 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
416 const char *sub = " **** invalid ref ****";
417 struct commit *commit = item->commit;
419 if (commit && !parse_commit(commit)) {
420 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
424 if (item->kind == REF_LOCAL_BRANCH)
425 fill_tracking_info(&stat, item->name, verbose > 1);
427 strbuf_addf(out, " %s %s%s",
428 find_unique_abbrev(item->commit->object.sha1, abbrev),
430 strbuf_release(&stat);
431 strbuf_release(&subject);
434 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
435 int abbrev, int current, char *prefix)
439 struct commit *commit = item->commit;
440 struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
442 if (!matches_merge_filter(commit))
445 switch (item->kind) {
446 case REF_LOCAL_BRANCH:
447 color = BRANCH_COLOR_LOCAL;
449 case REF_REMOTE_BRANCH:
450 color = BRANCH_COLOR_REMOTE;
453 color = BRANCH_COLOR_PLAIN;
460 color = BRANCH_COLOR_CURRENT;
463 strbuf_addf(&name, "%s%s", prefix, item->name);
465 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
467 branch_get_color(BRANCH_COLOR_RESET));
469 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
470 name.buf, branch_get_color(BRANCH_COLOR_RESET));
473 strbuf_addf(&out, " -> %s", item->dest);
475 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
476 add_verbose_info(&out, item, verbose, abbrev);
477 printf("%s\n", out.buf);
478 strbuf_release(&name);
479 strbuf_release(&out);
482 static int calc_maxwidth(struct ref_list *refs)
485 for (i = 0; i < refs->index; i++) {
486 if (!matches_merge_filter(refs->list[i].commit))
488 if (refs->list[i].len > w)
489 w = refs->list[i].len;
495 static void show_detached(struct ref_list *ref_list)
497 struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
499 if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
500 struct ref_item item;
501 item.name = xstrdup(_("(no branch)"));
502 item.len = strlen(item.name);
503 item.kind = REF_LOCAL_BRANCH;
505 item.commit = head_commit;
506 if (item.len > ref_list->maxwidth)
507 ref_list->maxwidth = item.len;
508 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
513 static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit, const char **pattern)
516 struct append_ref_cb cb;
517 struct ref_list ref_list;
519 memset(&ref_list, 0, sizeof(ref_list));
520 ref_list.kinds = kinds;
521 ref_list.verbose = verbose;
522 ref_list.abbrev = abbrev;
523 ref_list.with_commit = with_commit;
524 if (merge_filter != NO_FILTER)
525 init_revisions(&ref_list.revs, NULL);
526 cb.ref_list = &ref_list;
527 cb.pattern = pattern;
529 for_each_rawref(append_ref, &cb);
530 if (merge_filter != NO_FILTER) {
531 struct commit *filter;
532 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
533 filter->object.flags |= UNINTERESTING;
534 add_pending_object(&ref_list.revs,
535 (struct object *) filter, "");
536 ref_list.revs.limited = 1;
537 prepare_revision_walk(&ref_list.revs);
539 ref_list.maxwidth = calc_maxwidth(&ref_list);
542 qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
544 detached = (detached && (kinds & REF_LOCAL_BRANCH));
545 if (detached && match_patterns(pattern, "HEAD"))
546 show_detached(&ref_list);
548 for (i = 0; i < ref_list.index; i++) {
549 int current = !detached &&
550 (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
551 !strcmp(ref_list.list[i].name, head);
552 char *prefix = (kinds != REF_REMOTE_BRANCH &&
553 ref_list.list[i].kind == REF_REMOTE_BRANCH)
555 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
556 abbrev, current, prefix);
559 free_ref_list(&ref_list);
562 error(_("some refs could not be read"));
567 static void rename_branch(const char *oldname, const char *newname, int force)
569 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
570 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
575 die(_("cannot rename the current branch while not on any."));
577 if (strbuf_check_branch_ref(&oldref, oldname)) {
579 * Bad name --- this could be an attempt to rename a
580 * ref that we used to allow to be created by accident.
582 if (ref_exists(oldref.buf))
585 die(_("Invalid branch name: '%s'"), oldname);
589 * A command like "git branch -M currentbranch currentbranch" cannot
590 * cause the worktree to become inconsistent with HEAD, so allow it.
592 clobber_head_ok = !strcmp(oldname, newname);
594 validate_new_branchname(newname, &newref, force, clobber_head_ok);
596 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
597 oldref.buf, newref.buf);
599 if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
600 die(_("Branch rename failed"));
601 strbuf_release(&logmsg);
604 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
606 /* no need to pass logmsg here as HEAD didn't really move */
607 if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
608 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
610 strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
611 strbuf_release(&oldref);
612 strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
613 strbuf_release(&newref);
614 if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
615 die(_("Branch is renamed, but update of config-file failed"));
616 strbuf_release(&oldsection);
617 strbuf_release(&newsection);
620 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
622 merge_filter = ((opt->long_name[0] == 'n')
626 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
629 if (get_sha1(arg, merge_filter_ref))
630 die(_("malformed object name %s"), arg);
634 static const char edit_description[] = "BRANCH_DESCRIPTION";
636 static int edit_branch_description(const char *branch_name)
640 struct strbuf buf = STRBUF_INIT;
641 struct strbuf name = STRBUF_INIT;
643 read_branch_desc(&buf, branch_name);
644 if (!buf.len || buf.buf[buf.len-1] != '\n')
645 strbuf_addch(&buf, '\n');
647 "# Please edit the description for the branch\n"
649 "# Lines starting with '#' will be stripped.\n",
651 fp = fopen(git_path(edit_description), "w");
652 if ((fwrite(buf.buf, 1, buf.len, fp) < buf.len) || fclose(fp)) {
653 strbuf_release(&buf);
654 return error(_("could not write branch description template: %s\n"),
658 if (launch_editor(git_path(edit_description), &buf, NULL)) {
659 strbuf_release(&buf);
664 strbuf_addf(&name, "branch.%s.description", branch_name);
665 status = git_config_set(name.buf, buf.buf);
666 strbuf_release(&name);
667 strbuf_release(&buf);
672 int cmd_branch(int argc, const char **argv, const char *prefix)
674 int delete = 0, rename = 0, force_create = 0, list = 0;
675 int verbose = 0, abbrev = -1, detached = 0;
676 int reflog = 0, edit_description = 0;
677 enum branch_track track;
678 int kinds = REF_LOCAL_BRANCH;
679 struct commit_list *with_commit = NULL;
681 struct option options[] = {
682 OPT_GROUP("Generic options"),
683 OPT__VERBOSE(&verbose,
684 "show hash and subject, give twice for upstream branch"),
685 OPT_SET_INT('t', "track", &track, "set up tracking mode (see git-pull(1))",
686 BRANCH_TRACK_EXPLICIT),
687 OPT_SET_INT( 0, "set-upstream", &track, "change upstream info",
688 BRANCH_TRACK_OVERRIDE),
689 OPT__COLOR(&branch_use_color, "use colored output"),
690 OPT_SET_INT('r', "remotes", &kinds, "act on remote-tracking branches",
693 OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
694 "print only branches that contain the commit",
695 PARSE_OPT_LASTARG_DEFAULT,
696 parse_opt_with_commit, (intptr_t)"HEAD",
699 OPTION_CALLBACK, 0, "with", &with_commit, "commit",
700 "print only branches that contain the commit",
701 PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
702 parse_opt_with_commit, (intptr_t) "HEAD",
704 OPT__ABBREV(&abbrev),
706 OPT_GROUP("Specific git-branch actions:"),
707 OPT_SET_INT('a', "all", &kinds, "list both remote-tracking and local branches",
708 REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
709 OPT_BIT('d', "delete", &delete, "delete fully merged branch", 1),
710 OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
711 OPT_BIT('m', "move", &rename, "move/rename a branch and its reflog", 1),
712 OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
713 OPT_BOOLEAN(0, "list", &list, "list branch names"),
714 OPT_BOOLEAN('l', "create-reflog", &reflog, "create the branch's reflog"),
715 OPT_BOOLEAN(0, "edit-description", &edit_description,
716 "edit the description for the branch"),
717 OPT__FORCE(&force_create, "force creation (when already exists)"),
719 OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
720 "commit", "print only not merged branches",
721 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
722 opt_parse_merge_filter, (intptr_t) "HEAD",
725 OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
726 "commit", "print only merged branches",
727 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
728 opt_parse_merge_filter, (intptr_t) "HEAD",
733 if (argc == 2 && !strcmp(argv[1], "-h"))
734 usage_with_options(builtin_branch_usage, options);
736 git_config(git_branch_config, NULL);
738 track = git_branch_track;
740 head = resolve_refdup("HEAD", head_sha1, 0, NULL);
742 die(_("Failed to resolve HEAD as a valid ref."));
743 if (!strcmp(head, "HEAD")) {
746 if (prefixcmp(head, "refs/heads/"))
747 die(_("HEAD not found below refs/heads!"));
750 hashcpy(merge_filter_ref, head_sha1);
752 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
755 if (!delete && !rename && !edit_description && argc == 0)
758 if (!!delete + !!rename + !!force_create + !!list > 1)
759 usage_with_options(builtin_branch_usage, options);
762 abbrev = DEFAULT_ABBREV;
765 return delete_branches(argc, argv, delete > 1, kinds);
767 return print_ref_list(kinds, detached, verbose, abbrev,
769 else if (edit_description) {
770 const char *branch_name;
772 die("Cannot give description to detached HEAD");
776 branch_name = argv[0];
778 usage_with_options(builtin_branch_usage, options);
779 if (edit_branch_description(branch_name))
783 rename_branch(head, argv[0], rename > 1);
785 rename_branch(argv[0], argv[1], rename > 1);
787 usage_with_options(builtin_branch_usage, options);
788 } else if (argc > 0 && argc <= 2) {
789 if (kinds != REF_LOCAL_BRANCH)
790 die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
791 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
792 force_create, reflog, 0, track);
794 usage_with_options(builtin_branch_usage, options);