Merge branch 'maint'
[alt-git.git] / builtin / branch.c
blob87976f0921d87f2a8564eb54aa3b81d30ee7f214
1 /*
2 * Builtin "git branch"
4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-branch.sh by Junio C Hamano.
6 */
8 #include "cache.h"
9 #include "color.h"
10 #include "refs.h"
11 #include "commit.h"
12 #include "builtin.h"
13 #include "remote.h"
14 #include "parse-options.h"
15 #include "branch.h"
16 #include "diff.h"
17 #include "revision.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>",
24 NULL
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] = {
35 GIT_COLOR_RESET,
36 GIT_COLOR_NORMAL, /* PLAIN */
37 GIT_COLOR_RED, /* REMOTE */
38 GIT_COLOR_NORMAL, /* LOCAL */
39 GIT_COLOR_GREEN, /* CURRENT */
41 enum color_branch {
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 {
50 NO_FILTER = 0,
51 SHOW_NOT_MERGED,
52 SHOW_MERGED
53 } 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;
68 return -1;
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);
75 return 0;
77 if (!prefixcmp(var, "color.branch.")) {
78 int slot = parse_branch_color_slot(var, 13);
79 if (slot < 0)
80 return 0;
81 if (!value)
82 return config_error_nonbool(var);
83 color_parse(value, var, branch_colors[slot]);
84 return 0;
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];
93 return "";
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 int merged;
109 if (kind == REF_LOCAL_BRANCH) {
110 struct branch *branch = branch_get(name);
111 unsigned char sha1[20];
113 if (branch &&
114 branch->merge &&
115 branch->merge[0] &&
116 branch->merge[0]->dst &&
117 (reference_name =
118 resolve_ref(branch->merge[0]->dst, sha1, 1, NULL)) != NULL)
119 reference_rev = lookup_commit_reference(sha1);
121 if (!reference_rev)
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) {
135 if (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);
139 else
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);
144 return merged;
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];
151 char *name = NULL;
152 const char *fmt, *remote;
153 int i;
154 int ret = 0;
155 struct strbuf bname = STRBUF_INIT;
157 switch (kinds) {
158 case REF_REMOTE_BRANCH:
159 fmt = "refs/remotes/%s";
160 remote = "remote ";
161 force = 1;
162 break;
163 case REF_LOCAL_BRANCH:
164 fmt = "refs/heads/%s";
165 remote = "";
166 break;
167 default:
168 die("cannot use -a with -d");
171 if (!force) {
172 head_rev = lookup_commit_reference(head_sha1);
173 if (!head_rev)
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);
181 ret = 1;
182 continue;
185 free(name);
187 name = xstrdup(mkpath(fmt, bname.buf));
188 if (!resolve_ref(name, sha1, 1, NULL)) {
189 error("%sbranch '%s' not found.",
190 remote, bname.buf);
191 ret = 1;
192 continue;
195 rev = lookup_commit_reference(sha1);
196 if (!rev) {
197 error("Couldn't look up commit object for '%s'", name);
198 ret = 1;
199 continue;
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);
206 ret = 1;
207 continue;
210 if (delete_ref(name, sha1, 0)) {
211 error("Error deleting %sbranch '%s'", remote,
212 bname.buf);
213 ret = 1;
214 } else {
215 struct strbuf buf = STRBUF_INIT;
216 printf("Deleted %sbranch %s (was %s).\n", remote,
217 bname.buf,
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);
226 free(name);
228 return(ret);
231 struct ref_item {
232 char *name;
233 char *dest;
234 unsigned int kind, len;
235 struct commit *commit;
238 struct ref_list {
239 struct rev_info revs;
240 int index, alloc, maxwidth, verbose, abbrev;
241 struct ref_item *list;
242 struct commit_list *with_commit;
243 int kinds;
246 static char *resolve_symref(const char *src, const char *prefix)
248 unsigned char sha1[20];
249 int flag;
250 const char *dst, *cp;
252 dst = resolve_ref(src, sha1, 0, &flag);
253 if (!(dst && (flag & REF_ISSYMREF)))
254 return NULL;
255 if (prefix && (cp = skip_prefix(dst, prefix)))
256 dst = cp;
257 return xstrdup(dst);
260 struct append_ref_cb {
261 struct ref_list *ref_list;
262 int ret;
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;
271 int kind, i;
272 const char *prefix, *orig_refname = refname;
274 static struct {
275 int kind;
276 const char *prefix;
277 int pfxlen;
278 } ref_kind[] = {
279 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
280 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
283 /* Detect kind */
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))
287 continue;
288 kind = ref_kind[i].kind;
289 refname += ref_kind[i].pfxlen;
290 break;
292 if (ARRAY_SIZE(ref_kind) <= i)
293 return 0;
295 /* Don't add types the caller doesn't want */
296 if ((kind & ref_list->kinds) == 0)
297 return 0;
299 commit = NULL;
300 if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
301 commit = lookup_commit_reference_gently(sha1, 1);
302 if (!commit) {
303 cb->ret = error("branch '%s' does not point at a commit", refname);
304 return 0;
307 /* Filter with with_commit if specified */
308 if (!is_descendant_of(commit, ref_list->with_commit))
309 return 0;
311 if (merge_filter != NO_FILTER)
312 add_pending_object(&ref_list->revs,
313 (struct object *)commit, refname);
316 /* Resize buffer */
317 if (ref_list->index >= ref_list->alloc) {
318 ref_list->alloc = alloc_nr(ref_list->alloc);
319 ref_list->list = xrealloc(ref_list->list,
320 ref_list->alloc * sizeof(struct ref_item));
323 /* Record the new item */
324 newitem = &(ref_list->list[ref_list->index++]);
325 newitem->name = xstrdup(refname);
326 newitem->kind = kind;
327 newitem->commit = commit;
328 newitem->len = strlen(refname);
329 newitem->dest = resolve_symref(orig_refname, prefix);
330 /* adjust for "remotes/" */
331 if (newitem->kind == REF_REMOTE_BRANCH &&
332 ref_list->kinds != REF_REMOTE_BRANCH)
333 newitem->len += 8;
334 if (newitem->len > ref_list->maxwidth)
335 ref_list->maxwidth = newitem->len;
337 return 0;
340 static void free_ref_list(struct ref_list *ref_list)
342 int i;
344 for (i = 0; i < ref_list->index; i++) {
345 free(ref_list->list[i].name);
346 free(ref_list->list[i].dest);
348 free(ref_list->list);
351 static int ref_cmp(const void *r1, const void *r2)
353 struct ref_item *c1 = (struct ref_item *)(r1);
354 struct ref_item *c2 = (struct ref_item *)(r2);
356 if (c1->kind != c2->kind)
357 return c1->kind - c2->kind;
358 return strcmp(c1->name, c2->name);
361 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
362 int show_upstream_ref)
364 int ours, theirs;
365 struct branch *branch = branch_get(branch_name);
367 if (!stat_tracking_info(branch, &ours, &theirs)) {
368 if (branch && branch->merge && branch->merge[0]->dst &&
369 show_upstream_ref)
370 strbuf_addf(stat, "[%s] ",
371 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
372 return;
375 strbuf_addch(stat, '[');
376 if (show_upstream_ref)
377 strbuf_addf(stat, "%s: ",
378 shorten_unambiguous_ref(branch->merge[0]->dst, 0));
379 if (!ours)
380 strbuf_addf(stat, "behind %d] ", theirs);
381 else if (!theirs)
382 strbuf_addf(stat, "ahead %d] ", ours);
383 else
384 strbuf_addf(stat, "ahead %d, behind %d] ", ours, theirs);
387 static int matches_merge_filter(struct commit *commit)
389 int is_merged;
391 if (merge_filter == NO_FILTER)
392 return 1;
394 is_merged = !!(commit->object.flags & UNINTERESTING);
395 return (is_merged == (merge_filter == SHOW_MERGED));
398 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
399 int abbrev, int current, char *prefix)
401 char c;
402 int color;
403 struct commit *commit = item->commit;
404 struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
406 if (!matches_merge_filter(commit))
407 return;
409 switch (item->kind) {
410 case REF_LOCAL_BRANCH:
411 color = BRANCH_COLOR_LOCAL;
412 break;
413 case REF_REMOTE_BRANCH:
414 color = BRANCH_COLOR_REMOTE;
415 break;
416 default:
417 color = BRANCH_COLOR_PLAIN;
418 break;
421 c = ' ';
422 if (current) {
423 c = '*';
424 color = BRANCH_COLOR_CURRENT;
427 strbuf_addf(&name, "%s%s", prefix, item->name);
428 if (verbose)
429 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
430 maxwidth, name.buf,
431 branch_get_color(BRANCH_COLOR_RESET));
432 else
433 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
434 name.buf, branch_get_color(BRANCH_COLOR_RESET));
436 if (item->dest)
437 strbuf_addf(&out, " -> %s", item->dest);
438 else if (verbose) {
439 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
440 const char *sub = " **** invalid ref ****";
442 commit = item->commit;
443 if (commit && !parse_commit(commit)) {
444 struct pretty_print_context ctx = {0};
445 pretty_print_commit(CMIT_FMT_ONELINE, commit,
446 &subject, &ctx);
447 sub = subject.buf;
450 if (item->kind == REF_LOCAL_BRANCH)
451 fill_tracking_info(&stat, item->name, verbose > 1);
453 strbuf_addf(&out, " %s %s%s",
454 find_unique_abbrev(item->commit->object.sha1, abbrev),
455 stat.buf, sub);
456 strbuf_release(&stat);
457 strbuf_release(&subject);
459 printf("%s\n", out.buf);
460 strbuf_release(&name);
461 strbuf_release(&out);
464 static int calc_maxwidth(struct ref_list *refs)
466 int i, w = 0;
467 for (i = 0; i < refs->index; i++) {
468 if (!matches_merge_filter(refs->list[i].commit))
469 continue;
470 if (refs->list[i].len > w)
471 w = refs->list[i].len;
473 return w;
477 static void show_detached(struct ref_list *ref_list)
479 struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
481 if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
482 struct ref_item item;
483 item.name = xstrdup("(no branch)");
484 item.len = strlen(item.name);
485 item.kind = REF_LOCAL_BRANCH;
486 item.dest = NULL;
487 item.commit = head_commit;
488 if (item.len > ref_list->maxwidth)
489 ref_list->maxwidth = item.len;
490 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
491 free(item.name);
495 static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit)
497 int i;
498 struct append_ref_cb cb;
499 struct ref_list ref_list;
501 memset(&ref_list, 0, sizeof(ref_list));
502 ref_list.kinds = kinds;
503 ref_list.verbose = verbose;
504 ref_list.abbrev = abbrev;
505 ref_list.with_commit = with_commit;
506 if (merge_filter != NO_FILTER)
507 init_revisions(&ref_list.revs, NULL);
508 cb.ref_list = &ref_list;
509 cb.ret = 0;
510 for_each_rawref(append_ref, &cb);
511 if (merge_filter != NO_FILTER) {
512 struct commit *filter;
513 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
514 filter->object.flags |= UNINTERESTING;
515 add_pending_object(&ref_list.revs,
516 (struct object *) filter, "");
517 ref_list.revs.limited = 1;
518 prepare_revision_walk(&ref_list.revs);
519 if (verbose)
520 ref_list.maxwidth = calc_maxwidth(&ref_list);
523 qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
525 detached = (detached && (kinds & REF_LOCAL_BRANCH));
526 if (detached)
527 show_detached(&ref_list);
529 for (i = 0; i < ref_list.index; i++) {
530 int current = !detached &&
531 (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
532 !strcmp(ref_list.list[i].name, head);
533 char *prefix = (kinds != REF_REMOTE_BRANCH &&
534 ref_list.list[i].kind == REF_REMOTE_BRANCH)
535 ? "remotes/" : "";
536 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
537 abbrev, current, prefix);
540 free_ref_list(&ref_list);
542 if (cb.ret)
543 error("some refs could not be read");
545 return cb.ret;
548 static void rename_branch(const char *oldname, const char *newname, int force)
550 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
551 unsigned char sha1[20];
552 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
553 int recovery = 0;
555 if (!oldname)
556 die("cannot rename the current branch while not on any.");
558 if (strbuf_check_branch_ref(&oldref, oldname)) {
560 * Bad name --- this could be an attempt to rename a
561 * ref that we used to allow to be created by accident.
563 if (resolve_ref(oldref.buf, sha1, 1, NULL))
564 recovery = 1;
565 else
566 die("Invalid branch name: '%s'", oldname);
569 if (strbuf_check_branch_ref(&newref, newname))
570 die("Invalid branch name: '%s'", newname);
572 if (resolve_ref(newref.buf, sha1, 1, NULL) && !force)
573 die("A branch named '%s' already exists.", newref.buf + 11);
575 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
576 oldref.buf, newref.buf);
578 if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
579 die("Branch rename failed");
580 strbuf_release(&logmsg);
582 if (recovery)
583 warning("Renamed a misnamed branch '%s' away", oldref.buf + 11);
585 /* no need to pass logmsg here as HEAD didn't really move */
586 if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
587 die("Branch renamed to %s, but HEAD is not updated!", newname);
589 strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
590 strbuf_release(&oldref);
591 strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
592 strbuf_release(&newref);
593 if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
594 die("Branch is renamed, but update of config-file failed");
595 strbuf_release(&oldsection);
596 strbuf_release(&newsection);
599 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
601 merge_filter = ((opt->long_name[0] == 'n')
602 ? SHOW_NOT_MERGED
603 : SHOW_MERGED);
604 if (unset)
605 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
606 if (!arg)
607 arg = "HEAD";
608 if (get_sha1(arg, merge_filter_ref))
609 die("malformed object name %s", arg);
610 return 0;
613 int cmd_branch(int argc, const char **argv, const char *prefix)
615 int delete = 0, rename = 0, force_create = 0;
616 int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
617 int reflog = 0;
618 enum branch_track track;
619 int kinds = REF_LOCAL_BRANCH;
620 struct commit_list *with_commit = NULL;
622 struct option options[] = {
623 OPT_GROUP("Generic options"),
624 OPT__VERBOSE(&verbose),
625 OPT_SET_INT('t', "track", &track, "set up tracking mode (see git-pull(1))",
626 BRANCH_TRACK_EXPLICIT),
627 OPT_SET_INT( 0, "set-upstream", &track, "change upstream info",
628 BRANCH_TRACK_OVERRIDE),
629 OPT__COLOR(&branch_use_color, "use colored output"),
630 OPT_SET_INT('r', NULL, &kinds, "act on remote-tracking branches",
631 REF_REMOTE_BRANCH),
633 OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
634 "print only branches that contain the commit",
635 PARSE_OPT_LASTARG_DEFAULT,
636 parse_opt_with_commit, (intptr_t)"HEAD",
639 OPTION_CALLBACK, 0, "with", &with_commit, "commit",
640 "print only branches that contain the commit",
641 PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
642 parse_opt_with_commit, (intptr_t) "HEAD",
644 OPT__ABBREV(&abbrev),
646 OPT_GROUP("Specific git-branch actions:"),
647 OPT_SET_INT('a', NULL, &kinds, "list both remote-tracking and local branches",
648 REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
649 OPT_BIT('d', NULL, &delete, "delete fully merged branch", 1),
650 OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
651 OPT_BIT('m', NULL, &rename, "move/rename a branch and its reflog", 1),
652 OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
653 OPT_BOOLEAN('l', NULL, &reflog, "create the branch's reflog"),
654 OPT_BOOLEAN('f', "force", &force_create, "force creation (when already exists)"),
656 OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
657 "commit", "print only not merged branches",
658 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
659 opt_parse_merge_filter, (intptr_t) "HEAD",
662 OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
663 "commit", "print only merged branches",
664 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
665 opt_parse_merge_filter, (intptr_t) "HEAD",
667 OPT_END(),
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);
678 if (!head)
679 die("Failed to resolve HEAD as a valid ref.");
680 head = xstrdup(head);
681 if (!strcmp(head, "HEAD")) {
682 detached = 1;
683 } else {
684 if (prefixcmp(head, "refs/heads/"))
685 die("HEAD not found below refs/heads!");
686 head += 11;
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);
695 if (delete)
696 return delete_branches(argc, argv, delete > 1, kinds);
697 else if (argc == 0)
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);
708 } else
709 usage_with_options(builtin_branch_usage, options);
711 return 0;