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"
18 #include "string-list.h"
21 #include "wt-status.h"
23 static const char * const builtin_branch_usage
[] = {
24 N_("git branch [<options>] [-r | -a] [--merged | --no-merged]"),
25 N_("git branch [<options>] [-l] [-f] <branch-name> [<start-point>]"),
26 N_("git branch [<options>] [-r] (-d | -D) <branch-name>..."),
27 N_("git branch [<options>] (-m | -M) [<old-branch>] <new-branch>"),
31 #define REF_LOCAL_BRANCH 0x01
32 #define REF_REMOTE_BRANCH 0x02
34 static const char *head
;
35 static unsigned char head_sha1
[20];
37 static int branch_use_color
= -1;
38 static char branch_colors
[][COLOR_MAXLEN
] = {
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 */
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
55 static enum merge_filter
{
60 static unsigned char merge_filter_ref
[20];
62 static struct string_list output
= STRING_LIST_INIT_DUP
;
63 static unsigned int colopts
;
65 static int parse_branch_color_slot(const char *slot
)
67 if (!strcasecmp(slot
, "plain"))
68 return BRANCH_COLOR_PLAIN
;
69 if (!strcasecmp(slot
, "reset"))
70 return BRANCH_COLOR_RESET
;
71 if (!strcasecmp(slot
, "remote"))
72 return BRANCH_COLOR_REMOTE
;
73 if (!strcasecmp(slot
, "local"))
74 return BRANCH_COLOR_LOCAL
;
75 if (!strcasecmp(slot
, "current"))
76 return BRANCH_COLOR_CURRENT
;
77 if (!strcasecmp(slot
, "upstream"))
78 return BRANCH_COLOR_UPSTREAM
;
82 static int git_branch_config(const char *var
, const char *value
, void *cb
)
84 const char *slot_name
;
86 if (starts_with(var
, "column."))
87 return git_column_config(var
, value
, "branch", &colopts
);
88 if (!strcmp(var
, "color.branch")) {
89 branch_use_color
= git_config_colorbool(var
, value
);
92 if (skip_prefix(var
, "color.branch.", &slot_name
)) {
93 int slot
= parse_branch_color_slot(slot_name
);
97 return config_error_nonbool(var
);
98 return color_parse(value
, branch_colors
[slot
]);
100 return git_color_default_config(var
, value
, cb
);
103 static const char *branch_get_color(enum color_branch ix
)
105 if (want_color(branch_use_color
))
106 return branch_colors
[ix
];
110 static int branch_merged(int kind
, const char *name
,
111 struct commit
*rev
, struct commit
*head_rev
)
114 * This checks whether the merge bases of branch and HEAD (or
115 * the other branch this branch builds upon) contains the
116 * branch, which means that the branch has already been merged
117 * safely to HEAD (or the other branch).
119 struct commit
*reference_rev
= NULL
;
120 const char *reference_name
= NULL
;
121 void *reference_name_to_free
= NULL
;
124 if (kind
== REF_LOCAL_BRANCH
) {
125 struct branch
*branch
= branch_get(name
);
126 unsigned char sha1
[20];
131 branch
->merge
[0]->dst
&&
132 (reference_name
= reference_name_to_free
=
133 resolve_refdup(branch
->merge
[0]->dst
, RESOLVE_REF_READING
,
134 sha1
, NULL
)) != NULL
)
135 reference_rev
= lookup_commit_reference(sha1
);
138 reference_rev
= head_rev
;
140 merged
= in_merge_bases(rev
, reference_rev
);
143 * After the safety valve is fully redefined to "check with
144 * upstream, if any, otherwise with HEAD", we should just
145 * return the result of the in_merge_bases() above without
146 * any of the following code, but during the transition period,
147 * a gentle reminder is in order.
149 if ((head_rev
!= reference_rev
) &&
150 in_merge_bases(rev
, head_rev
) != merged
) {
152 warning(_("deleting branch '%s' that has been merged to\n"
153 " '%s', but not yet merged to HEAD."),
154 name
, reference_name
);
156 warning(_("not deleting branch '%s' that is not yet merged to\n"
157 " '%s', even though it is merged to HEAD."),
158 name
, reference_name
);
160 free(reference_name_to_free
);
164 static int check_branch_commit(const char *branchname
, const char *refname
,
165 unsigned char *sha1
, struct commit
*head_rev
,
166 int kinds
, int force
)
168 struct commit
*rev
= lookup_commit_reference(sha1
);
170 error(_("Couldn't look up commit object for '%s'"), refname
);
173 if (!force
&& !branch_merged(kinds
, branchname
, rev
, head_rev
)) {
174 error(_("The branch '%s' is not fully merged.\n"
175 "If you are sure you want to delete it, "
176 "run 'git branch -D %s'."), branchname
, branchname
);
182 static void delete_branch_config(const char *branchname
)
184 struct strbuf buf
= STRBUF_INIT
;
185 strbuf_addf(&buf
, "branch.%s", branchname
);
186 if (git_config_rename_section(buf
.buf
, NULL
) < 0)
187 warning(_("Update of config-file failed"));
188 strbuf_release(&buf
);
191 static int delete_branches(int argc
, const char **argv
, int force
, int kinds
,
194 struct commit
*head_rev
= NULL
;
195 unsigned char sha1
[20];
200 int remote_branch
= 0;
201 struct strbuf bname
= STRBUF_INIT
;
204 case REF_REMOTE_BRANCH
:
205 fmt
= "refs/remotes/%s";
206 /* For subsequent UI messages */
211 case REF_LOCAL_BRANCH
:
212 fmt
= "refs/heads/%s";
215 die(_("cannot use -a with -d"));
219 head_rev
= lookup_commit_reference(head_sha1
);
221 die(_("Couldn't look up commit object for HEAD"));
223 for (i
= 0; i
< argc
; i
++, strbuf_release(&bname
)) {
227 strbuf_branchname(&bname
, argv
[i
]);
228 if (kinds
== REF_LOCAL_BRANCH
&& !strcmp(head
, bname
.buf
)) {
229 error(_("Cannot delete the branch '%s' "
230 "which you are currently on."), bname
.buf
);
237 name
= mkpathdup(fmt
, bname
.buf
);
238 target
= resolve_ref_unsafe(name
,
240 | RESOLVE_REF_NO_RECURSE
241 | RESOLVE_REF_ALLOW_BAD_NAME
,
245 ? _("remote branch '%s' not found.")
246 : _("branch '%s' not found."), bname
.buf
);
251 if (!(flags
& (REF_ISSYMREF
|REF_ISBROKEN
)) &&
252 check_branch_commit(bname
.buf
, name
, sha1
, head_rev
, kinds
,
258 if (delete_ref(name
, sha1
, REF_NODEREF
)) {
260 ? _("Error deleting remote branch '%s'")
261 : _("Error deleting branch '%s'"),
268 ? _("Deleted remote branch %s (was %s).\n")
269 : _("Deleted branch %s (was %s).\n"),
271 (flags
& REF_ISBROKEN
) ? "broken"
272 : (flags
& REF_ISSYMREF
) ? target
273 : find_unique_abbrev(sha1
, DEFAULT_ABBREV
));
275 delete_branch_config(bname
.buf
);
286 unsigned int kind
, width
;
287 struct commit
*commit
;
292 struct rev_info revs
;
293 int index
, alloc
, maxwidth
, verbose
, abbrev
;
294 struct ref_item
*list
;
295 struct commit_list
*with_commit
;
299 static char *resolve_symref(const char *src
, const char *prefix
)
301 unsigned char sha1
[20];
305 dst
= resolve_ref_unsafe(src
, 0, sha1
, &flag
);
306 if (!(dst
&& (flag
& REF_ISSYMREF
)))
309 skip_prefix(dst
, prefix
, &dst
);
313 struct append_ref_cb
{
314 struct ref_list
*ref_list
;
315 const char **pattern
;
319 static int match_patterns(const char **pattern
, const char *refname
)
322 return 1; /* no pattern always matches */
324 if (!wildmatch(*pattern
, refname
, 0, NULL
))
331 static int append_ref(const char *refname
, const unsigned char *sha1
, int flags
, void *cb_data
)
333 struct append_ref_cb
*cb
= (struct append_ref_cb
*)(cb_data
);
334 struct ref_list
*ref_list
= cb
->ref_list
;
335 struct ref_item
*newitem
;
336 struct commit
*commit
;
338 const char *prefix
, *orig_refname
= refname
;
344 { REF_LOCAL_BRANCH
, "refs/heads/" },
345 { REF_REMOTE_BRANCH
, "refs/remotes/" },
349 for (i
= 0; i
< ARRAY_SIZE(ref_kind
); i
++) {
350 prefix
= ref_kind
[i
].prefix
;
351 if (skip_prefix(refname
, prefix
, &refname
)) {
352 kind
= ref_kind
[i
].kind
;
356 if (ARRAY_SIZE(ref_kind
) <= i
)
359 /* Don't add types the caller doesn't want */
360 if ((kind
& ref_list
->kinds
) == 0)
363 if (!match_patterns(cb
->pattern
, refname
))
367 if (ref_list
->verbose
|| ref_list
->with_commit
|| merge_filter
!= NO_FILTER
) {
368 commit
= lookup_commit_reference_gently(sha1
, 1);
370 cb
->ret
= error(_("branch '%s' does not point at a commit"), refname
);
374 /* Filter with with_commit if specified */
375 if (!is_descendant_of(commit
, ref_list
->with_commit
))
378 if (merge_filter
!= NO_FILTER
)
379 add_pending_object(&ref_list
->revs
,
380 (struct object
*)commit
, refname
);
383 ALLOC_GROW(ref_list
->list
, ref_list
->index
+ 1, ref_list
->alloc
);
385 /* Record the new item */
386 newitem
= &(ref_list
->list
[ref_list
->index
++]);
387 newitem
->name
= xstrdup(refname
);
388 newitem
->kind
= kind
;
389 newitem
->commit
= commit
;
390 newitem
->width
= utf8_strwidth(refname
);
391 newitem
->dest
= resolve_symref(orig_refname
, prefix
);
393 /* adjust for "remotes/" */
394 if (newitem
->kind
== REF_REMOTE_BRANCH
&&
395 ref_list
->kinds
!= REF_REMOTE_BRANCH
)
397 if (newitem
->width
> ref_list
->maxwidth
)
398 ref_list
->maxwidth
= newitem
->width
;
403 static void free_ref_list(struct ref_list
*ref_list
)
407 for (i
= 0; i
< ref_list
->index
; i
++) {
408 free(ref_list
->list
[i
].name
);
409 free(ref_list
->list
[i
].dest
);
411 free(ref_list
->list
);
414 static int ref_cmp(const void *r1
, const void *r2
)
416 struct ref_item
*c1
= (struct ref_item
*)(r1
);
417 struct ref_item
*c2
= (struct ref_item
*)(r2
);
419 if (c1
->kind
!= c2
->kind
)
420 return c1
->kind
- c2
->kind
;
421 return strcmp(c1
->name
, c2
->name
);
424 static void fill_tracking_info(struct strbuf
*stat
, const char *branch_name
,
425 int show_upstream_ref
)
429 struct branch
*branch
= branch_get(branch_name
);
430 struct strbuf fancy
= STRBUF_INIT
;
431 int upstream_is_gone
= 0;
432 int added_decoration
= 1;
434 switch (stat_tracking_info(branch
, &ours
, &theirs
)) {
439 /* with "gone" base */
440 upstream_is_gone
= 1;
447 if (show_upstream_ref
) {
448 ref
= shorten_unambiguous_ref(branch
->merge
[0]->dst
, 0);
449 if (want_color(branch_use_color
))
450 strbuf_addf(&fancy
, "%s%s%s",
451 branch_get_color(BRANCH_COLOR_UPSTREAM
),
452 ref
, branch_get_color(BRANCH_COLOR_RESET
));
454 strbuf_addstr(&fancy
, ref
);
457 if (upstream_is_gone
) {
458 if (show_upstream_ref
)
459 strbuf_addf(stat
, _("[%s: gone]"), fancy
.buf
);
461 added_decoration
= 0;
462 } else if (!ours
&& !theirs
) {
463 if (show_upstream_ref
)
464 strbuf_addf(stat
, _("[%s]"), fancy
.buf
);
466 added_decoration
= 0;
468 if (show_upstream_ref
)
469 strbuf_addf(stat
, _("[%s: behind %d]"), fancy
.buf
, theirs
);
471 strbuf_addf(stat
, _("[behind %d]"), theirs
);
473 } else if (!theirs
) {
474 if (show_upstream_ref
)
475 strbuf_addf(stat
, _("[%s: ahead %d]"), fancy
.buf
, ours
);
477 strbuf_addf(stat
, _("[ahead %d]"), ours
);
479 if (show_upstream_ref
)
480 strbuf_addf(stat
, _("[%s: ahead %d, behind %d]"),
481 fancy
.buf
, ours
, theirs
);
483 strbuf_addf(stat
, _("[ahead %d, behind %d]"),
486 strbuf_release(&fancy
);
487 if (added_decoration
)
488 strbuf_addch(stat
, ' ');
492 static void add_verbose_info(struct strbuf
*out
, struct ref_item
*item
,
493 int verbose
, int abbrev
)
495 struct strbuf subject
= STRBUF_INIT
, stat
= STRBUF_INIT
;
496 const char *sub
= _(" **** invalid ref ****");
497 struct commit
*commit
= item
->commit
;
499 if (!parse_commit(commit
)) {
500 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &subject
);
504 if (item
->kind
== REF_LOCAL_BRANCH
)
505 fill_tracking_info(&stat
, item
->name
, verbose
> 1);
507 strbuf_addf(out
, " %s %s%s",
508 find_unique_abbrev(item
->commit
->object
.sha1
, abbrev
),
510 strbuf_release(&stat
);
511 strbuf_release(&subject
);
514 static void print_ref_item(struct ref_item
*item
, int maxwidth
, int verbose
,
515 int abbrev
, int current
, char *prefix
)
519 struct strbuf out
= STRBUF_INIT
, name
= STRBUF_INIT
;
524 switch (item
->kind
) {
525 case REF_LOCAL_BRANCH
:
526 color
= BRANCH_COLOR_LOCAL
;
528 case REF_REMOTE_BRANCH
:
529 color
= BRANCH_COLOR_REMOTE
;
532 color
= BRANCH_COLOR_PLAIN
;
539 color
= BRANCH_COLOR_CURRENT
;
542 strbuf_addf(&name
, "%s%s", prefix
, item
->name
);
544 int utf8_compensation
= strlen(name
.buf
) - utf8_strwidth(name
.buf
);
545 strbuf_addf(&out
, "%c %s%-*s%s", c
, branch_get_color(color
),
546 maxwidth
+ utf8_compensation
, name
.buf
,
547 branch_get_color(BRANCH_COLOR_RESET
));
549 strbuf_addf(&out
, "%c %s%s%s", c
, branch_get_color(color
),
550 name
.buf
, branch_get_color(BRANCH_COLOR_RESET
));
553 strbuf_addf(&out
, " -> %s", item
->dest
);
555 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
556 add_verbose_info(&out
, item
, verbose
, abbrev
);
557 if (column_active(colopts
)) {
558 assert(!verbose
&& "--column and --verbose are incompatible");
559 string_list_append(&output
, out
.buf
);
561 printf("%s\n", out
.buf
);
563 strbuf_release(&name
);
564 strbuf_release(&out
);
567 static int calc_maxwidth(struct ref_list
*refs
)
570 for (i
= 0; i
< refs
->index
; i
++) {
571 if (refs
->list
[i
].ignore
)
573 if (refs
->list
[i
].width
> w
)
574 w
= refs
->list
[i
].width
;
579 static char *get_head_description(void)
581 struct strbuf desc
= STRBUF_INIT
;
582 struct wt_status_state state
;
583 memset(&state
, 0, sizeof(state
));
584 wt_status_get_state(&state
, 1);
585 if (state
.rebase_in_progress
||
586 state
.rebase_interactive_in_progress
)
587 strbuf_addf(&desc
, _("(no branch, rebasing %s)"),
589 else if (state
.bisect_in_progress
)
590 strbuf_addf(&desc
, _("(no branch, bisect started on %s)"),
592 else if (state
.detached_from
) {
593 /* TRANSLATORS: make sure these match _("HEAD detached at ")
594 and _("HEAD detached from ") in wt-status.c */
595 if (state
.detached_at
)
596 strbuf_addf(&desc
, _("(HEAD detached at %s)"),
597 state
.detached_from
);
599 strbuf_addf(&desc
, _("(HEAD detached from %s)"),
600 state
.detached_from
);
603 strbuf_addstr(&desc
, _("(no branch)"));
606 free(state
.detached_from
);
607 return strbuf_detach(&desc
, NULL
);
610 static void show_detached(struct ref_list
*ref_list
)
612 struct commit
*head_commit
= lookup_commit_reference_gently(head_sha1
, 1);
614 if (head_commit
&& is_descendant_of(head_commit
, ref_list
->with_commit
)) {
615 struct ref_item item
;
616 item
.name
= get_head_description();
617 item
.width
= utf8_strwidth(item
.name
);
618 item
.kind
= REF_LOCAL_BRANCH
;
620 item
.commit
= head_commit
;
622 if (item
.width
> ref_list
->maxwidth
)
623 ref_list
->maxwidth
= item
.width
;
624 print_ref_item(&item
, ref_list
->maxwidth
, ref_list
->verbose
, ref_list
->abbrev
, 1, "");
629 static int print_ref_list(int kinds
, int detached
, int verbose
, int abbrev
, struct commit_list
*with_commit
, const char **pattern
)
632 struct append_ref_cb cb
;
633 struct ref_list ref_list
;
635 memset(&ref_list
, 0, sizeof(ref_list
));
636 ref_list
.kinds
= kinds
;
637 ref_list
.verbose
= verbose
;
638 ref_list
.abbrev
= abbrev
;
639 ref_list
.with_commit
= with_commit
;
640 if (merge_filter
!= NO_FILTER
)
641 init_revisions(&ref_list
.revs
, NULL
);
642 cb
.ref_list
= &ref_list
;
643 cb
.pattern
= pattern
;
645 for_each_rawref(append_ref
, &cb
);
646 if (merge_filter
!= NO_FILTER
) {
647 struct commit
*filter
;
648 filter
= lookup_commit_reference_gently(merge_filter_ref
, 0);
650 die(_("object '%s' does not point to a commit"),
651 sha1_to_hex(merge_filter_ref
));
653 filter
->object
.flags
|= UNINTERESTING
;
654 add_pending_object(&ref_list
.revs
,
655 (struct object
*) filter
, "");
656 ref_list
.revs
.limited
= 1;
658 if (prepare_revision_walk(&ref_list
.revs
))
659 die(_("revision walk setup failed"));
661 for (i
= 0; i
< ref_list
.index
; i
++) {
662 struct ref_item
*item
= &ref_list
.list
[i
];
663 struct commit
*commit
= item
->commit
;
664 int is_merged
= !!(commit
->object
.flags
& UNINTERESTING
);
665 item
->ignore
= is_merged
!= (merge_filter
== SHOW_MERGED
);
668 for (i
= 0; i
< ref_list
.index
; i
++) {
669 struct ref_item
*item
= &ref_list
.list
[i
];
670 clear_commit_marks(item
->commit
, ALL_REV_FLAGS
);
672 clear_commit_marks(filter
, ALL_REV_FLAGS
);
675 ref_list
.maxwidth
= calc_maxwidth(&ref_list
);
678 qsort(ref_list
.list
, ref_list
.index
, sizeof(struct ref_item
), ref_cmp
);
680 detached
= (detached
&& (kinds
& REF_LOCAL_BRANCH
));
681 if (detached
&& match_patterns(pattern
, "HEAD"))
682 show_detached(&ref_list
);
684 for (i
= 0; i
< ref_list
.index
; i
++) {
685 int current
= !detached
&&
686 (ref_list
.list
[i
].kind
== REF_LOCAL_BRANCH
) &&
687 !strcmp(ref_list
.list
[i
].name
, head
);
688 char *prefix
= (kinds
!= REF_REMOTE_BRANCH
&&
689 ref_list
.list
[i
].kind
== REF_REMOTE_BRANCH
)
691 print_ref_item(&ref_list
.list
[i
], ref_list
.maxwidth
, verbose
,
692 abbrev
, current
, prefix
);
695 free_ref_list(&ref_list
);
698 error(_("some refs could not be read"));
703 static void rename_branch(const char *oldname
, const char *newname
, int force
)
705 struct strbuf oldref
= STRBUF_INIT
, newref
= STRBUF_INIT
, logmsg
= STRBUF_INIT
;
706 struct strbuf oldsection
= STRBUF_INIT
, newsection
= STRBUF_INIT
;
711 die(_("cannot rename the current branch while not on any."));
713 if (strbuf_check_branch_ref(&oldref
, oldname
)) {
715 * Bad name --- this could be an attempt to rename a
716 * ref that we used to allow to be created by accident.
718 if (ref_exists(oldref
.buf
))
721 die(_("Invalid branch name: '%s'"), oldname
);
725 * A command like "git branch -M currentbranch currentbranch" cannot
726 * cause the worktree to become inconsistent with HEAD, so allow it.
728 clobber_head_ok
= !strcmp(oldname
, newname
);
730 validate_new_branchname(newname
, &newref
, force
, clobber_head_ok
);
732 strbuf_addf(&logmsg
, "Branch: renamed %s to %s",
733 oldref
.buf
, newref
.buf
);
735 if (rename_ref(oldref
.buf
, newref
.buf
, logmsg
.buf
))
736 die(_("Branch rename failed"));
737 strbuf_release(&logmsg
);
740 warning(_("Renamed a misnamed branch '%s' away"), oldref
.buf
+ 11);
742 /* no need to pass logmsg here as HEAD didn't really move */
743 if (!strcmp(oldname
, head
) && create_symref("HEAD", newref
.buf
, NULL
))
744 die(_("Branch renamed to %s, but HEAD is not updated!"), newname
);
746 strbuf_addf(&oldsection
, "branch.%s", oldref
.buf
+ 11);
747 strbuf_release(&oldref
);
748 strbuf_addf(&newsection
, "branch.%s", newref
.buf
+ 11);
749 strbuf_release(&newref
);
750 if (git_config_rename_section(oldsection
.buf
, newsection
.buf
) < 0)
751 die(_("Branch is renamed, but update of config-file failed"));
752 strbuf_release(&oldsection
);
753 strbuf_release(&newsection
);
756 static int opt_parse_merge_filter(const struct option
*opt
, const char *arg
, int unset
)
758 merge_filter
= ((opt
->long_name
[0] == 'n')
762 merge_filter
= SHOW_NOT_MERGED
; /* b/c for --no-merged */
765 if (get_sha1(arg
, merge_filter_ref
))
766 die(_("malformed object name %s"), arg
);
770 static const char edit_description
[] = "BRANCH_DESCRIPTION";
772 static int edit_branch_description(const char *branch_name
)
775 struct strbuf buf
= STRBUF_INIT
;
776 struct strbuf name
= STRBUF_INIT
;
778 read_branch_desc(&buf
, branch_name
);
779 if (!buf
.len
|| buf
.buf
[buf
.len
-1] != '\n')
780 strbuf_addch(&buf
, '\n');
781 strbuf_commented_addf(&buf
,
782 "Please edit the description for the branch\n"
784 "Lines starting with '%c' will be stripped.\n",
785 branch_name
, comment_line_char
);
786 if (write_file(git_path(edit_description
), 0, "%s", buf
.buf
)) {
787 strbuf_release(&buf
);
788 return error(_("could not write branch description template: %s"),
792 if (launch_editor(git_path(edit_description
), &buf
, NULL
)) {
793 strbuf_release(&buf
);
798 strbuf_addf(&name
, "branch.%s.description", branch_name
);
799 status
= git_config_set(name
.buf
, buf
.len
? buf
.buf
: NULL
);
800 strbuf_release(&name
);
801 strbuf_release(&buf
);
806 int cmd_branch(int argc
, const char **argv
, const char *prefix
)
808 int delete = 0, rename
= 0, force
= 0, list
= 0;
809 int verbose
= 0, abbrev
= -1, detached
= 0;
810 int reflog
= 0, edit_description
= 0;
811 int quiet
= 0, unset_upstream
= 0;
812 const char *new_upstream
= NULL
;
813 enum branch_track track
;
814 int kinds
= REF_LOCAL_BRANCH
;
815 struct commit_list
*with_commit
= NULL
;
817 struct option options
[] = {
818 OPT_GROUP(N_("Generic options")),
819 OPT__VERBOSE(&verbose
,
820 N_("show hash and subject, give twice for upstream branch")),
821 OPT__QUIET(&quiet
, N_("suppress informational messages")),
822 OPT_SET_INT('t', "track", &track
, N_("set up tracking mode (see git-pull(1))"),
823 BRANCH_TRACK_EXPLICIT
),
824 OPT_SET_INT( 0, "set-upstream", &track
, N_("change upstream info"),
825 BRANCH_TRACK_OVERRIDE
),
826 OPT_STRING('u', "set-upstream-to", &new_upstream
, "upstream", "change the upstream info"),
827 OPT_BOOL(0, "unset-upstream", &unset_upstream
, "Unset the upstream info"),
828 OPT__COLOR(&branch_use_color
, N_("use colored output")),
829 OPT_SET_INT('r', "remotes", &kinds
, N_("act on remote-tracking branches"),
832 OPTION_CALLBACK
, 0, "contains", &with_commit
, N_("commit"),
833 N_("print only branches that contain the commit"),
834 PARSE_OPT_LASTARG_DEFAULT
,
835 parse_opt_with_commit
, (intptr_t)"HEAD",
838 OPTION_CALLBACK
, 0, "with", &with_commit
, N_("commit"),
839 N_("print only branches that contain the commit"),
840 PARSE_OPT_HIDDEN
| PARSE_OPT_LASTARG_DEFAULT
,
841 parse_opt_with_commit
, (intptr_t) "HEAD",
843 OPT__ABBREV(&abbrev
),
845 OPT_GROUP(N_("Specific git-branch actions:")),
846 OPT_SET_INT('a', "all", &kinds
, N_("list both remote-tracking and local branches"),
847 REF_REMOTE_BRANCH
| REF_LOCAL_BRANCH
),
848 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
849 OPT_BIT('D', NULL
, &delete, N_("delete branch (even if not merged)"), 2),
850 OPT_BIT('m', "move", &rename
, N_("move/rename a branch and its reflog"), 1),
851 OPT_BIT('M', NULL
, &rename
, N_("move/rename a branch, even if target exists"), 2),
852 OPT_BOOL(0, "list", &list
, N_("list branch names")),
853 OPT_BOOL('l', "create-reflog", &reflog
, N_("create the branch's reflog")),
854 OPT_BOOL(0, "edit-description", &edit_description
,
855 N_("edit the description for the branch")),
856 OPT__FORCE(&force
, N_("force creation, move/rename, deletion")),
858 OPTION_CALLBACK
, 0, "no-merged", &merge_filter_ref
,
859 N_("commit"), N_("print only not merged branches"),
860 PARSE_OPT_LASTARG_DEFAULT
| PARSE_OPT_NONEG
,
861 opt_parse_merge_filter
, (intptr_t) "HEAD",
864 OPTION_CALLBACK
, 0, "merged", &merge_filter_ref
,
865 N_("commit"), N_("print only merged branches"),
866 PARSE_OPT_LASTARG_DEFAULT
| PARSE_OPT_NONEG
,
867 opt_parse_merge_filter
, (intptr_t) "HEAD",
869 OPT_COLUMN(0, "column", &colopts
, N_("list branches in columns")),
873 if (argc
== 2 && !strcmp(argv
[1], "-h"))
874 usage_with_options(builtin_branch_usage
, options
);
876 git_config(git_branch_config
, NULL
);
878 track
= git_branch_track
;
880 head
= resolve_refdup("HEAD", 0, head_sha1
, NULL
);
882 die(_("Failed to resolve HEAD as a valid ref."));
883 if (!strcmp(head
, "HEAD"))
885 else if (!skip_prefix(head
, "refs/heads/", &head
))
886 die(_("HEAD not found below refs/heads!"));
887 hashcpy(merge_filter_ref
, head_sha1
);
890 argc
= parse_options(argc
, argv
, prefix
, options
, builtin_branch_usage
,
893 if (!delete && !rename
&& !edit_description
&& !new_upstream
&& !unset_upstream
&& argc
== 0)
896 if (with_commit
|| merge_filter
!= NO_FILTER
)
899 if (!!delete + !!rename
+ !!new_upstream
+
900 list
+ unset_upstream
> 1)
901 usage_with_options(builtin_branch_usage
, options
);
904 abbrev
= DEFAULT_ABBREV
;
905 finalize_colopts(&colopts
, -1);
907 if (explicitly_enable_column(colopts
))
908 die(_("--column and --verbose are incompatible"));
919 die(_("branch name required"));
920 return delete_branches(argc
, argv
, delete > 1, kinds
, quiet
);
922 int ret
= print_ref_list(kinds
, detached
, verbose
, abbrev
,
924 print_columns(&output
, colopts
, NULL
);
925 string_list_clear(&output
, 0);
928 else if (edit_description
) {
929 const char *branch_name
;
930 struct strbuf branch_ref
= STRBUF_INIT
;
934 die(_("Cannot give description to detached HEAD"));
936 } else if (argc
== 1)
937 branch_name
= argv
[0];
939 die(_("cannot edit description of more than one branch"));
941 strbuf_addf(&branch_ref
, "refs/heads/%s", branch_name
);
942 if (!ref_exists(branch_ref
.buf
)) {
943 strbuf_release(&branch_ref
);
946 return error(_("No commit on branch '%s' yet."),
949 return error(_("No branch named '%s'."),
952 strbuf_release(&branch_ref
);
954 if (edit_branch_description(branch_name
))
958 die(_("branch name required"));
960 rename_branch(head
, argv
[0], rename
> 1);
962 rename_branch(argv
[0], argv
[1], rename
> 1);
964 die(_("too many branches for a rename operation"));
965 } else if (new_upstream
) {
966 struct branch
*branch
= branch_get(argv
[0]);
969 die(_("too many branches to set new upstream"));
972 if (!argc
|| !strcmp(argv
[0], "HEAD"))
973 die(_("could not set upstream of HEAD to %s when "
974 "it does not point to any branch."),
976 die(_("no such branch '%s'"), argv
[0]);
979 if (!ref_exists(branch
->refname
))
980 die(_("branch '%s' does not exist"), branch
->name
);
983 * create_branch takes care of setting up the tracking
984 * info and making sure new_upstream is correct
986 create_branch(head
, branch
->name
, new_upstream
, 0, 0, 0, quiet
, BRANCH_TRACK_OVERRIDE
);
987 } else if (unset_upstream
) {
988 struct branch
*branch
= branch_get(argv
[0]);
989 struct strbuf buf
= STRBUF_INIT
;
992 die(_("too many branches to unset upstream"));
995 if (!argc
|| !strcmp(argv
[0], "HEAD"))
996 die(_("could not unset upstream of HEAD when "
997 "it does not point to any branch."));
998 die(_("no such branch '%s'"), argv
[0]);
1001 if (!branch_has_merge_config(branch
))
1002 die(_("Branch '%s' has no upstream information"), branch
->name
);
1004 strbuf_addf(&buf
, "branch.%s.remote", branch
->name
);
1005 git_config_set_multivar(buf
.buf
, NULL
, NULL
, 1);
1007 strbuf_addf(&buf
, "branch.%s.merge", branch
->name
);
1008 git_config_set_multivar(buf
.buf
, NULL
, NULL
, 1);
1009 strbuf_release(&buf
);
1010 } else if (argc
> 0 && argc
<= 2) {
1011 struct branch
*branch
= branch_get(argv
[0]);
1012 int branch_existed
= 0, remote_tracking
= 0;
1013 struct strbuf buf
= STRBUF_INIT
;
1015 if (!strcmp(argv
[0], "HEAD"))
1016 die(_("it does not make sense to create 'HEAD' manually"));
1019 die(_("no such branch '%s'"), argv
[0]);
1021 if (kinds
!= REF_LOCAL_BRANCH
)
1022 die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
1024 if (track
== BRANCH_TRACK_OVERRIDE
)
1025 fprintf(stderr
, _("The --set-upstream flag is deprecated and will be removed. Consider using --track or --set-upstream-to\n"));
1027 strbuf_addf(&buf
, "refs/remotes/%s", branch
->name
);
1028 remote_tracking
= ref_exists(buf
.buf
);
1029 strbuf_release(&buf
);
1031 branch_existed
= ref_exists(branch
->refname
);
1032 create_branch(head
, argv
[0], (argc
== 2) ? argv
[1] : head
,
1033 force
, reflog
, 0, quiet
, track
);
1036 * We only show the instructions if the user gave us
1037 * one branch which doesn't exist locally, but is the
1038 * name of a remote-tracking branch.
1040 if (argc
== 1 && track
== BRANCH_TRACK_OVERRIDE
&&
1041 !branch_existed
&& remote_tracking
) {
1042 fprintf(stderr
, _("\nIf you wanted to make '%s' track '%s', do this:\n\n"), head
, branch
->name
);
1043 fprintf(stderr
, _(" git branch -d %s\n"), branch
->name
);
1044 fprintf(stderr
, _(" git branch --set-upstream-to %s\n"), branch
->name
);
1048 usage_with_options(builtin_branch_usage
, options
);