1/*
2 * Builtin "git branch"
3 *
4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-branch.sh by Junio C Hamano.
6 */
7#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"
18#include "string-list.h"
19#include "column.h"
20#include "utf8.h"
21#include "wt-status.h"
22static const char * const builtin_branch_usage[] = {
24 N_("git branch [options] [-r | -a] [--merged | --no-merged]"),
25 N_("git branch [options] [-l] [-f] <branchname> [<start-point>]"),
26 N_("git branch [options] [-r] (-d | -D) <branchname>..."),
27 N_("git branch [options] (-m | -M) [<oldbranch>] <newbranch>"),
28 NULL
29};
30#define REF_LOCAL_BRANCH 0x01
32#define REF_REMOTE_BRANCH 0x02
33static const char *head;
35static unsigned char head_sha1[20];
36static int branch_use_color = -1;
38static char branch_colors[][COLOR_MAXLEN] = {
39 GIT_COLOR_RESET,
40 GIT_COLOR_NORMAL, /* PLAIN */
41 GIT_COLOR_RED, /* REMOTE */
42 GIT_COLOR_NORMAL, /* LOCAL */
43 GIT_COLOR_GREEN, /* CURRENT */
44 GIT_COLOR_BLUE, /* UPSTREAM */
45};
46enum color_branch {
47 BRANCH_COLOR_RESET = 0,
48 BRANCH_COLOR_PLAIN = 1,
49 BRANCH_COLOR_REMOTE = 2,
50 BRANCH_COLOR_LOCAL = 3,
51 BRANCH_COLOR_CURRENT = 4,
52 BRANCH_COLOR_UPSTREAM = 5
53};
54static enum merge_filter {
56 NO_FILTER = 0,
57 SHOW_NOT_MERGED,
58 SHOW_MERGED
59} merge_filter;
60static unsigned char merge_filter_ref[20];
61static struct string_list output = STRING_LIST_INIT_DUP;
63static unsigned int colopts;
64static int parse_branch_color_slot(const char *var, int ofs)
66{
67 if (!strcasecmp(var+ofs, "plain"))
68 return BRANCH_COLOR_PLAIN;
69 if (!strcasecmp(var+ofs, "reset"))
70 return BRANCH_COLOR_RESET;
71 if (!strcasecmp(var+ofs, "remote"))
72 return BRANCH_COLOR_REMOTE;
73 if (!strcasecmp(var+ofs, "local"))
74 return BRANCH_COLOR_LOCAL;
75 if (!strcasecmp(var+ofs, "current"))
76 return BRANCH_COLOR_CURRENT;
77 if (!strcasecmp(var+ofs, "upstream"))
78 return BRANCH_COLOR_UPSTREAM;
79 return -1;
80}
81static int git_branch_config(const char *var, const char *value, void *cb)
83{
84 if (!prefixcmp(var, "column."))
85 return git_column_config(var, value, "branch", &colopts);
86 if (!strcmp(var, "color.branch")) {
87 branch_use_color = git_config_colorbool(var, value);
88 return 0;
89 }
90 if (!prefixcmp(var, "color.branch.")) {
91 int slot = parse_branch_color_slot(var, 13);
92 if (slot < 0)
93 return 0;
94 if (!value)
95 return config_error_nonbool(var);
96 color_parse(value, var, branch_colors[slot]);
97 return 0;
98 }
99 return git_color_default_config(var, value, cb);
100}
101static const char *branch_get_color(enum color_branch ix)
103{
104 if (want_color(branch_use_color))
105 return branch_colors[ix];
106 return "";
107}
108static int branch_merged(int kind, const char *name,
110 struct commit *rev, struct commit *head_rev)
111{
112 /*
113 * This checks whether the merge bases of branch and HEAD (or
114 * the other branch this branch builds upon) contains the
115 * branch, which means that the branch has already been merged
116 * safely to HEAD (or the other branch).
117 */
118 struct commit *reference_rev = NULL;
119 const char *reference_name = NULL;
120 void *reference_name_to_free = NULL;
121 int merged;
122 if (kind == REF_LOCAL_BRANCH) {
124 struct branch *branch = branch_get(name);
125 unsigned char sha1[20];
126 if (branch &&
128 branch->merge &&
129 branch->merge[0] &&
130 branch->merge[0]->dst &&
131 (reference_name = reference_name_to_free =
132 resolve_refdup(branch->merge[0]->dst, sha1, 1, NULL)) != NULL)
133 reference_rev = lookup_commit_reference(sha1);
134 }
135 if (!reference_rev)
136 reference_rev = head_rev;
137 merged = in_merge_bases(rev, reference_rev);
139 /*
141 * After the safety valve is fully redefined to "check with
142 * upstream, if any, otherwise with HEAD", we should just
143 * return the result of the in_merge_bases() above without
144 * any of the following code, but during the transition period,
145 * a gentle reminder is in order.
146 */
147 if ((head_rev != reference_rev) &&
148 in_merge_bases(rev, head_rev) != merged) {
149 if (merged)
150 warning(_("deleting branch '%s' that has been merged to\n"
151 " '%s', but not yet merged to HEAD."),
152 name, reference_name);
153 else
154 warning(_("not deleting branch '%s' that is not yet merged to\n"
155 " '%s', even though it is merged to HEAD."),
156 name, reference_name);
157 }
158 free(reference_name_to_free);
159 return merged;
160}
161static int check_branch_commit(const char *branchname, const char *refname,
163 unsigned char *sha1, struct commit *head_rev,
164 int kinds, int force)
165{
166 struct commit *rev = lookup_commit_reference(sha1);
167 if (!rev) {
168 error(_("Couldn't look up commit object for '%s'"), refname);
169 return -1;
170 }
171 if (!force && !branch_merged(kinds, branchname, rev, head_rev)) {
172 error(_("The branch '%s' is not fully merged.\n"
173 "If you are sure you want to delete it, "
174 "run 'git branch -D %s'."), branchname, branchname);
175 return -1;
176 }
177 return 0;
178}
179static void delete_branch_config(const char *branchname)
181{
182 struct strbuf buf = STRBUF_INIT;
183 strbuf_addf(&buf, "branch.%s", branchname);
184 if (git_config_rename_section(buf.buf, NULL) < 0)
185 warning(_("Update of config-file failed"));
186 strbuf_release(&buf);
187}
188static int delete_branches(int argc, const char **argv, int force, int kinds,
190 int quiet)
191{
192 struct commit *head_rev = NULL;
193 unsigned char sha1[20];
194 char *name = NULL;
195 const char *fmt;
196 int i;
197 int ret = 0;
198 int remote_branch = 0;
199 struct strbuf bname = STRBUF_INIT;
200 switch (kinds) {
202 case REF_REMOTE_BRANCH:
203 fmt = "refs/remotes/%s";
204 /* For subsequent UI messages */
205 remote_branch = 1;
206 force = 1;
208 break;
209 case REF_LOCAL_BRANCH:
210 fmt = "refs/heads/%s";
211 break;
212 default:
213 die(_("cannot use -a with -d"));
214 }
215 if (!force) {
217 head_rev = lookup_commit_reference(head_sha1);
218 if (!head_rev)
219 die(_("Couldn't look up commit object for HEAD"));
220 }
221 for (i = 0; i < argc; i++, strbuf_release(&bname)) {
222 const char *target;
223 int flags = 0;
224 strbuf_branchname(&bname, argv[i]);
226 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
227 error(_("Cannot delete the branch '%s' "
228 "which you are currently on."), bname.buf);
229 ret = 1;
230 continue;
231 }
232 free(name);
234 name = mkpathdup(fmt, bname.buf);
236 target = resolve_ref_unsafe(name, sha1, 0, &flags);
237 if (!target ||
238 (!(flags & REF_ISSYMREF) && is_null_sha1(sha1))) {
239 error(remote_branch
240 ? _("remote branch '%s' not found.")
241 : _("branch '%s' not found."), bname.buf);
242 ret = 1;
243 continue;
244 }
245 if (!(flags & REF_ISSYMREF) &&
247 check_branch_commit(bname.buf, name, sha1, head_rev, kinds,
248 force)) {
249 ret = 1;
250 continue;
251 }
252 if (delete_ref(name, sha1, REF_NODEREF)) {
254 error(remote_branch
255 ? _("Error deleting remote branch '%s'")
256 : _("Error deleting branch '%s'"),
257 bname.buf);
258 ret = 1;
259 continue;
260 }
261 if (!quiet) {
262 printf(remote_branch
263 ? _("Deleted remote branch %s (was %s).\n")
264 : _("Deleted branch %s (was %s).\n"),
265 bname.buf,
266 (flags & REF_ISSYMREF)
267 ? target
268 : find_unique_abbrev(sha1, DEFAULT_ABBREV));
269 }
270 delete_branch_config(bname.buf);
271 }
272 free(name);
274 return(ret);
276}
277struct ref_item {
279 char *name;
280 char *dest;
281 unsigned int kind, width;
282 struct commit *commit;
283};
284struct ref_list {
286 struct rev_info revs;
287 int index, alloc, maxwidth, verbose, abbrev;
288 struct ref_item *list;
289 struct commit_list *with_commit;
290 int kinds;
291};
292static char *resolve_symref(const char *src, const char *prefix)
294{
295 unsigned char sha1[20];
296 int flag;
297 const char *dst, *cp;
298 dst = resolve_ref_unsafe(src, sha1, 0, &flag);
300 if (!(dst && (flag & REF_ISSYMREF)))
301 return NULL;
302 if (prefix && (cp = skip_prefix(dst, prefix)))
303 dst = cp;
304 return xstrdup(dst);
305}
306struct append_ref_cb {
308 struct ref_list *ref_list;
309 const char **pattern;
310 int ret;
311};
312static int match_patterns(const char **pattern, const char *refname)
314{
315 if (!*pattern)
316 return 1; /* no pattern always matches */
317 while (*pattern) {
318 if (!fnmatch(*pattern, refname, 0))
319 return 1;
320 pattern++;
321 }
322 return 0;
323}
324static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
326{
327 struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
328 struct ref_list *ref_list = cb->ref_list;
329 struct ref_item *newitem;
330 struct commit *commit;
331 int kind, i;
332 const char *prefix, *orig_refname = refname;
333 static struct {
335 int kind;
336 const char *prefix;
337 int pfxlen;
338 } ref_kind[] = {
339 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
340 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
341 };
342 /* Detect kind */
344 for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
345 prefix = ref_kind[i].prefix;
346 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
347 continue;
348 kind = ref_kind[i].kind;
349 refname += ref_kind[i].pfxlen;
350 break;
351 }
352 if (ARRAY_SIZE(ref_kind) <= i)
353 return 0;
354 /* Don't add types the caller doesn't want */
356 if ((kind & ref_list->kinds) == 0)
357 return 0;
358 if (!match_patterns(cb->pattern, refname))
360 return 0;
361 commit = NULL;
363 if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
364 commit = lookup_commit_reference_gently(sha1, 1);
365 if (!commit) {
366 cb->ret = error(_("branch '%s' does not point at a commit"), refname);
367 return 0;
368 }
369 /* Filter with with_commit if specified */
371 if (!is_descendant_of(commit, ref_list->with_commit))
372 return 0;
373 if (merge_filter != NO_FILTER)
375 add_pending_object(&ref_list->revs,
376 (struct object *)commit, refname);
377 }
378 ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
380 /* Record the new item */
382 newitem = &(ref_list->list[ref_list->index++]);
383 newitem->name = xstrdup(refname);
384 newitem->kind = kind;
385 newitem->commit = commit;
386 newitem->width = utf8_strwidth(refname);
387 newitem->dest = resolve_symref(orig_refname, prefix);
388 /* adjust for "remotes/" */
389 if (newitem->kind == REF_REMOTE_BRANCH &&
390 ref_list->kinds != REF_REMOTE_BRANCH)
391 newitem->width += 8;
392 if (newitem->width > ref_list->maxwidth)
393 ref_list->maxwidth = newitem->width;
394 return 0;
396}
397static void free_ref_list(struct ref_list *ref_list)
399{
400 int i;
401 for (i = 0; i < ref_list->index; i++) {
403 free(ref_list->list[i].name);
404 free(ref_list->list[i].dest);
405 }
406 free(ref_list->list);
407}
408static int ref_cmp(const void *r1, const void *r2)
410{
411 struct ref_item *c1 = (struct ref_item *)(r1);
412 struct ref_item *c2 = (struct ref_item *)(r2);
413 if (c1->kind != c2->kind)
415 return c1->kind - c2->kind;
416 return strcmp(c1->name, c2->name);
417}
418static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
420 int show_upstream_ref)
421{
422 int ours, theirs;
423 char *ref = NULL;
424 struct branch *branch = branch_get(branch_name);
425 struct strbuf fancy = STRBUF_INIT;
426 int upstream_is_gone = 0;
427 switch (stat_tracking_info(branch, &ours, &theirs)) {
429 case 0:
430 /* no base */
431 return;
432 case -1:
433 /* with "gone" base */
434 upstream_is_gone = 1;
435 break;
436 default:
437 /* with base */
438 break;
439 }
440 if (show_upstream_ref) {
442 ref = shorten_unambiguous_ref(branch->merge[0]->dst, 0);
443 if (want_color(branch_use_color))
444 strbuf_addf(&fancy, "%s%s%s",
445 branch_get_color(BRANCH_COLOR_UPSTREAM),
446 ref, branch_get_color(BRANCH_COLOR_RESET));
447 else
448 strbuf_addstr(&fancy, ref);
449 }
450 if (upstream_is_gone) {
452 if (show_upstream_ref)
453 strbuf_addf(stat, _("[%s: gone]"), fancy.buf);
454 } else if (!ours && !theirs) {
455 if (show_upstream_ref)
456 strbuf_addf(stat, _("[%s]"), fancy.buf);
457 } else if (!ours) {
458 if (show_upstream_ref)
459 strbuf_addf(stat, _("[%s: behind %d]"), fancy.buf, theirs);
460 else
461 strbuf_addf(stat, _("[behind %d]"), theirs);
462 } else if (!theirs) {
464 if (show_upstream_ref)
465 strbuf_addf(stat, _("[%s: ahead %d]"), fancy.buf, ours);
466 else
467 strbuf_addf(stat, _("[ahead %d]"), ours);
468 } else {
469 if (show_upstream_ref)
470 strbuf_addf(stat, _("[%s: ahead %d, behind %d]"),
471 fancy.buf, ours, theirs);
472 else
473 strbuf_addf(stat, _("[ahead %d, behind %d]"),
474 ours, theirs);
475 }
476 strbuf_release(&fancy);
477 strbuf_addch(stat, ' ');
478 free(ref);
479}
480static int matches_merge_filter(struct commit *commit)
482{
483 int is_merged;
484 if (merge_filter == NO_FILTER)
486 return 1;
487 is_merged = !!(commit->object.flags & UNINTERESTING);
489 return (is_merged == (merge_filter == SHOW_MERGED));
490}
491static void add_verbose_info(struct strbuf *out, struct ref_item *item,
493 int verbose, int abbrev)
494{
495 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
496 const char *sub = _(" **** invalid ref ****");
497 struct commit *commit = item->commit;
498 if (commit && !parse_commit(commit)) {
500 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
501 sub = subject.buf;
502 }
503 if (item->kind == REF_LOCAL_BRANCH)
505 fill_tracking_info(&stat, item->name, verbose > 1);
506 strbuf_addf(out, " %s %s%s",
508 find_unique_abbrev(item->commit->object.sha1, abbrev),
509 stat.buf, sub);
510 strbuf_release(&stat);
511 strbuf_release(&subject);
512}
513static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
515 int abbrev, int current, char *prefix)
516{
517 char c;
518 int color;
519 struct commit *commit = item->commit;
520 struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
521 if (!matches_merge_filter(commit))
523 return;
524 switch (item->kind) {
526 case REF_LOCAL_BRANCH:
527 color = BRANCH_COLOR_LOCAL;
528 break;
529 case REF_REMOTE_BRANCH:
530 color = BRANCH_COLOR_REMOTE;
531 break;
532 default:
533 color = BRANCH_COLOR_PLAIN;
534 break;
535 }
536 c = ' ';
538 if (current) {
539 c = '*';
540 color = BRANCH_COLOR_CURRENT;
541 }
542 strbuf_addf(&name, "%s%s", prefix, item->name);
544 if (verbose) {
545 int utf8_compensation = strlen(name.buf) - utf8_strwidth(name.buf);
546 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
547 maxwidth + utf8_compensation, name.buf,
548 branch_get_color(BRANCH_COLOR_RESET));
549 } else
550 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
551 name.buf, branch_get_color(BRANCH_COLOR_RESET));
552 if (item->dest)
554 strbuf_addf(&out, " -> %s", item->dest);
555 else if (verbose)
556 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
557 add_verbose_info(&out, item, verbose, abbrev);
558 if (column_active(colopts)) {
559 assert(!verbose && "--column and --verbose are incompatible");
560 string_list_append(&output, out.buf);
561 } else {
562 printf("%s\n", out.buf);
563 }
564 strbuf_release(&name);
565 strbuf_release(&out);
566}
567static int calc_maxwidth(struct ref_list *refs)
569{
570 int i, w = 0;
571 for (i = 0; i < refs->index; i++) {
572 if (!matches_merge_filter(refs->list[i].commit))
573 continue;
574 if (refs->list[i].width > w)
575 w = refs->list[i].width;
576 }
577 return w;
578}
579static char *get_head_description(void)
581{
582 struct strbuf desc = STRBUF_INIT;
583 struct wt_status_state state;
584 memset(&state, 0, sizeof(state));
585 wt_status_get_state(&state, 1);
586 if (state.rebase_in_progress ||
587 state.rebase_interactive_in_progress)
588 strbuf_addf(&desc, _("(no branch, rebasing %s)"),
589 state.branch);
590 else if (state.bisect_in_progress)
591 strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
592 state.branch);
593 else if (state.detached_from)
594 strbuf_addf(&desc, _("(detached from %s)"),
595 state.detached_from);
596 else
597 strbuf_addstr(&desc, _("(no branch)"));
598 free(state.branch);
599 free(state.onto);
600 free(state.detached_from);
601 return strbuf_detach(&desc, NULL);
602}
603static void show_detached(struct ref_list *ref_list)
605{
606 struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
607 if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
609 struct ref_item item;
610 item.name = get_head_description();
611 item.width = utf8_strwidth(item.name);
612 item.kind = REF_LOCAL_BRANCH;
613 item.dest = NULL;
614 item.commit = head_commit;
615 if (item.width > ref_list->maxwidth)
616 ref_list->maxwidth = item.width;
617 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
618 free(item.name);
619 }
620}
621static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit, const char **pattern)
623{
624 int i;
625 struct append_ref_cb cb;
626 struct ref_list ref_list;
627 memset(&ref_list, 0, sizeof(ref_list));
629 ref_list.kinds = kinds;
630 ref_list.verbose = verbose;
631 ref_list.abbrev = abbrev;
632 ref_list.with_commit = with_commit;
633 if (merge_filter != NO_FILTER)
634 init_revisions(&ref_list.revs, NULL);
635 cb.ref_list = &ref_list;
636 cb.pattern = pattern;
637 cb.ret = 0;
638 for_each_rawref(append_ref, &cb);
639 if (merge_filter != NO_FILTER) {
640 struct commit *filter;
641 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
642 if (!filter)
643 die(_("object '%s' does not point to a commit"),
644 sha1_to_hex(merge_filter_ref));
645 filter->object.flags |= UNINTERESTING;
647 add_pending_object(&ref_list.revs,
648 (struct object *) filter, "");
649 ref_list.revs.limited = 1;
650 prepare_revision_walk(&ref_list.revs);
651 if (verbose)
652 ref_list.maxwidth = calc_maxwidth(&ref_list);
653 }
654 qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
656 detached = (detached && (kinds & REF_LOCAL_BRANCH));
658 if (detached && match_patterns(pattern, "HEAD"))
659 show_detached(&ref_list);
660 for (i = 0; i < ref_list.index; i++) {
662 int current = !detached &&
663 (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
664 !strcmp(ref_list.list[i].name, head);
665 char *prefix = (kinds != REF_REMOTE_BRANCH &&
666 ref_list.list[i].kind == REF_REMOTE_BRANCH)
667 ? "remotes/" : "";
668 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
669 abbrev, current, prefix);
670 }
671 free_ref_list(&ref_list);
673 if (cb.ret)
675 error(_("some refs could not be read"));
676 return cb.ret;
678}
679static void rename_branch(const char *oldname, const char *newname, int force)
681{
682 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
683 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
684 int recovery = 0;
685 int clobber_head_ok;
686 if (!oldname)
688 die(_("cannot rename the current branch while not on any."));
689 if (strbuf_check_branch_ref(&oldref, oldname)) {
691 /*
692 * Bad name --- this could be an attempt to rename a
693 * ref that we used to allow to be created by accident.
694 */
695 if (ref_exists(oldref.buf))
696 recovery = 1;
697 else
698 die(_("Invalid branch name: '%s'"), oldname);
699 }
700 /*
702 * A command like "git branch -M currentbranch currentbranch" cannot
703 * cause the worktree to become inconsistent with HEAD, so allow it.
704 */
705 clobber_head_ok = !strcmp(oldname, newname);
706 validate_new_branchname(newname, &newref, force, clobber_head_ok);
708 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
710 oldref.buf, newref.buf);
711 if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
713 die(_("Branch rename failed"));
714 strbuf_release(&logmsg);
715 if (recovery)
717 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
718 /* no need to pass logmsg here as HEAD didn't really move */
720 if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
721 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
722 strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
724 strbuf_release(&oldref);
725 strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
726 strbuf_release(&newref);
727 if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
728 die(_("Branch is renamed, but update of config-file failed"));
729 strbuf_release(&oldsection);
730 strbuf_release(&newsection);
731}
732static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
734{
735 merge_filter = ((opt->long_name[0] == 'n')
736 ? SHOW_NOT_MERGED
737 : SHOW_MERGED);
738 if (unset)
739 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
740 if (!arg)
741 arg = "HEAD";
742 if (get_sha1(arg, merge_filter_ref))
743 die(_("malformed object name %s"), arg);
744 return 0;
745}
746static const char edit_description[] = "BRANCH_DESCRIPTION";
748static int edit_branch_description(const char *branch_name)
750{
751 FILE *fp;
752 int status;
753 struct strbuf buf = STRBUF_INIT;
754 struct strbuf name = STRBUF_INIT;
755 read_branch_desc(&buf, branch_name);
757 if (!buf.len || buf.buf[buf.len-1] != '\n')
758 strbuf_addch(&buf, '\n');
759 strbuf_commented_addf(&buf,
760 "Please edit the description for the branch\n"
761 " %s\n"
762 "Lines starting with '%c' will be stripped.\n",
763 branch_name, comment_line_char);
764 fp = fopen(git_path(edit_description), "w");
765 if ((fwrite(buf.buf, 1, buf.len, fp) < buf.len) || fclose(fp)) {
766 strbuf_release(&buf);
767 return error(_("could not write branch description template: %s"),
768 strerror(errno));
769 }
770 strbuf_reset(&buf);
771 if (launch_editor(git_path(edit_description), &buf, NULL)) {
772 strbuf_release(&buf);
773 return -1;
774 }
775 stripspace(&buf, 1);
776 strbuf_addf(&name, "branch.%s.description", branch_name);
778 status = git_config_set(name.buf, buf.len ? buf.buf : NULL);
779 strbuf_release(&name);
780 strbuf_release(&buf);
781 return status;
783}
784int cmd_branch(int argc, const char **argv, const char *prefix)
786{
787 int delete = 0, rename = 0, force_create = 0, list = 0;
788 int verbose = 0, abbrev = -1, detached = 0;
789 int reflog = 0, edit_description = 0;
790 int quiet = 0, unset_upstream = 0;
791 const char *new_upstream = NULL;
792 enum branch_track track;
793 int kinds = REF_LOCAL_BRANCH;
794 struct commit_list *with_commit = NULL;
795 struct option options[] = {
797 OPT_GROUP(N_("Generic options")),
798 OPT__VERBOSE(&verbose,
799 N_("show hash and subject, give twice for upstream branch")),
800 OPT__QUIET(&quiet, N_("suppress informational messages")),
801 OPT_SET_INT('t', "track", &track, N_("set up tracking mode (see git-pull(1))"),
802 BRANCH_TRACK_EXPLICIT),
803 OPT_SET_INT( 0, "set-upstream", &track, N_("change upstream info"),
804 BRANCH_TRACK_OVERRIDE),
805 OPT_STRING('u', "set-upstream-to", &new_upstream, "upstream", "change the upstream info"),
806 OPT_BOOL(0, "unset-upstream", &unset_upstream, "Unset the upstream info"),
807 OPT__COLOR(&branch_use_color, N_("use colored output")),
808 OPT_SET_INT('r', "remotes", &kinds, N_("act on remote-tracking branches"),
809 REF_REMOTE_BRANCH),
810 {
811 OPTION_CALLBACK, 0, "contains", &with_commit, N_("commit"),
812 N_("print only branches that contain the commit"),
813 PARSE_OPT_LASTARG_DEFAULT,
814 parse_opt_with_commit, (intptr_t)"HEAD",
815 },
816 {
817 OPTION_CALLBACK, 0, "with", &with_commit, N_("commit"),
818 N_("print only branches that contain the commit"),
819 PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
820 parse_opt_with_commit, (intptr_t) "HEAD",
821 },
822 OPT__ABBREV(&abbrev),
823 OPT_GROUP(N_("Specific git-branch actions:")),
825 OPT_SET_INT('a', "all", &kinds, N_("list both remote-tracking and local branches"),
826 REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
827 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
828 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
829 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
830 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
831 OPT_BOOL(0, "list", &list, N_("list branch names")),
832 OPT_BOOL('l', "create-reflog", &reflog, N_("create the branch's reflog")),
833 OPT_BOOL(0, "edit-description", &edit_description,
834 N_("edit the description for the branch")),
835 OPT__FORCE(&force_create, N_("force creation (when already exists)")),
836 {
837 OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
838 N_("commit"), N_("print only not merged branches"),
839 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
840 opt_parse_merge_filter, (intptr_t) "HEAD",
841 },
842 {
843 OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
844 N_("commit"), N_("print only merged branches"),
845 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
846 opt_parse_merge_filter, (intptr_t) "HEAD",
847 },
848 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
849 OPT_END(),
850 };
851 if (argc == 2 && !strcmp(argv[1], "-h"))
853 usage_with_options(builtin_branch_usage, options);
854 git_config(git_branch_config, NULL);
856 track = git_branch_track;
858 head = resolve_refdup("HEAD", head_sha1, 0, NULL);
860 if (!head)
861 die(_("Failed to resolve HEAD as a valid ref."));
862 if (!strcmp(head, "HEAD")) {
863 detached = 1;
864 } else {
865 if (prefixcmp(head, "refs/heads/"))
866 die(_("HEAD not found below refs/heads!"));
867 head += 11;
868 }
869 hashcpy(merge_filter_ref, head_sha1);
870 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
873 0);
874 if (!delete && !rename && !edit_description && !new_upstream && !unset_upstream && argc == 0)
876 list = 1;
877 if (with_commit || merge_filter != NO_FILTER)
879 list = 1;
880 if (!!delete + !!rename + !!force_create + !!new_upstream +
882 list + unset_upstream > 1)
883 usage_with_options(builtin_branch_usage, options);
884 if (abbrev == -1)
886 abbrev = DEFAULT_ABBREV;
887 finalize_colopts(&colopts, -1);
888 if (verbose) {
889 if (explicitly_enable_column(colopts))
890 die(_("--column and --verbose are incompatible"));
891 colopts = 0;
892 }
893 if (delete) {
895 if (!argc)
896 die(_("branch name required"));
897 return delete_branches(argc, argv, delete > 1, kinds, quiet);
898 } else if (list) {
899 int ret = print_ref_list(kinds, detached, verbose, abbrev,
900 with_commit, argv);
901 print_columns(&output, colopts, NULL);
902 string_list_clear(&output, 0);
903 return ret;
904 }
905 else if (edit_description) {
906 const char *branch_name;
907 struct strbuf branch_ref = STRBUF_INIT;
908 if (!argc) {
910 if (detached)
911 die(_("Cannot give description to detached HEAD"));
912 branch_name = head;
913 } else if (argc == 1)
914 branch_name = argv[0];
915 else
916 die(_("cannot edit description of more than one branch"));
917 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
919 if (!ref_exists(branch_ref.buf)) {
920 strbuf_release(&branch_ref);
921 if (!argc)
923 return error(_("No commit on branch '%s' yet."),
924 branch_name);
925 else
926 return error(_("No branch named '%s'."),
927 branch_name);
928 }
929 strbuf_release(&branch_ref);
930 if (edit_branch_description(branch_name))
932 return 1;
933 } else if (rename) {
934 if (!argc)
935 die(_("branch name required"));
936 else if (argc == 1)
937 rename_branch(head, argv[0], rename > 1);
938 else if (argc == 2)
939 rename_branch(argv[0], argv[1], rename > 1);
940 else
941 die(_("too many branches for a rename operation"));
942 } else if (new_upstream) {
943 struct branch *branch = branch_get(argv[0]);
944 if (argc > 1)
946 die(_("too many branches to set new upstream"));
947 if (!branch) {
949 if (!argc || !strcmp(argv[0], "HEAD"))
950 die(_("could not set upstream of HEAD to %s when "
951 "it does not point to any branch."),
952 new_upstream);
953 die(_("no such branch '%s'"), argv[0]);
954 }
955 if (!ref_exists(branch->refname))
957 die(_("branch '%s' does not exist"), branch->name);
958 /*
960 * create_branch takes care of setting up the tracking
961 * info and making sure new_upstream is correct
962 */
963 create_branch(head, branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
964 } else if (unset_upstream) {
965 struct branch *branch = branch_get(argv[0]);
966 struct strbuf buf = STRBUF_INIT;
967 if (argc > 1)
969 die(_("too many branches to unset upstream"));
970 if (!branch) {
972 if (!argc || !strcmp(argv[0], "HEAD"))
973 die(_("could not unset upstream of HEAD when "
974 "it does not point to any branch."));
975 die(_("no such branch '%s'"), argv[0]);
976 }
977 if (!branch_has_merge_config(branch)) {
979 die(_("Branch '%s' has no upstream information"), branch->name);
980 }
981 strbuf_addf(&buf, "branch.%s.remote", branch->name);
983 git_config_set_multivar(buf.buf, NULL, NULL, 1);
984 strbuf_reset(&buf);
985 strbuf_addf(&buf, "branch.%s.merge", branch->name);
986 git_config_set_multivar(buf.buf, NULL, NULL, 1);
987 strbuf_release(&buf);
988 } else if (argc > 0 && argc <= 2) {
989 struct branch *branch = branch_get(argv[0]);
990 int branch_existed = 0, remote_tracking = 0;
991 struct strbuf buf = STRBUF_INIT;
992 if (!strcmp(argv[0], "HEAD"))
994 die(_("it does not make sense to create 'HEAD' manually"));
995 if (!branch)
997 die(_("no such branch '%s'"), argv[0]);
998 if (kinds != REF_LOCAL_BRANCH)
1000 die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
1001 if (track == BRANCH_TRACK_OVERRIDE)
1003 fprintf(stderr, _("The --set-upstream flag is deprecated and will be removed. Consider using --track or --set-upstream-to\n"));
1004 strbuf_addf(&buf, "refs/remotes/%s", branch->name);
1006 remote_tracking = ref_exists(buf.buf);
1007 strbuf_release(&buf);
1008 branch_existed = ref_exists(branch->refname);
1010 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
1011 force_create, reflog, 0, quiet, track);
1012 /*
1014 * We only show the instructions if the user gave us
1015 * one branch which doesn't exist locally, but is the
1016 * name of a remote-tracking branch.
1017 */
1018 if (argc == 1 && track == BRANCH_TRACK_OVERRIDE &&
1019 !branch_existed && remote_tracking) {
1020 fprintf(stderr, _("\nIf you wanted to make '%s' track '%s', do this:\n\n"), head, branch->name);
1021 fprintf(stderr, _(" git branch -d %s\n"), branch->name);
1022 fprintf(stderr, _(" git branch --set-upstream-to %s\n"), branch->name);
1023 }
1024 } else
1026 usage_with_options(builtin_branch_usage, options);
1027 return 0;
1029}