4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-branch.sh by Junio C Hamano.
15 #include "parse-options.h"
19 #include "string-list.h"
22 #include "wt-status.h"
23 #include "ref-filter.h"
26 #include "commit-reach.h"
28 static const char * const builtin_branch_usage
[] = {
29 N_("git branch [<options>] [-r | -a] [--merged] [--no-merged]"),
30 N_("git branch [<options>] [-f] [--recurse-submodules] <branch-name> [<start-point>]"),
31 N_("git branch [<options>] [-l] [<pattern>...]"),
32 N_("git branch [<options>] [-r] (-d | -D) <branch-name>..."),
33 N_("git branch [<options>] (-m | -M) [<old-branch>] <new-branch>"),
34 N_("git branch [<options>] (-c | -C) [<old-branch>] <new-branch>"),
35 N_("git branch [<options>] [-r | -a] [--points-at]"),
36 N_("git branch [<options>] [-r | -a] [--format]"),
40 static const char *head
;
41 static struct object_id head_oid
;
42 static int recurse_submodules
= 0;
43 static int submodule_propagate_branches
= 0;
45 static int branch_use_color
= -1;
46 static char branch_colors
[][COLOR_MAXLEN
] = {
48 GIT_COLOR_NORMAL
, /* PLAIN */
49 GIT_COLOR_RED
, /* REMOTE */
50 GIT_COLOR_NORMAL
, /* LOCAL */
51 GIT_COLOR_GREEN
, /* CURRENT */
52 GIT_COLOR_BLUE
, /* UPSTREAM */
53 GIT_COLOR_CYAN
, /* WORKTREE */
56 BRANCH_COLOR_RESET
= 0,
57 BRANCH_COLOR_PLAIN
= 1,
58 BRANCH_COLOR_REMOTE
= 2,
59 BRANCH_COLOR_LOCAL
= 3,
60 BRANCH_COLOR_CURRENT
= 4,
61 BRANCH_COLOR_UPSTREAM
= 5,
62 BRANCH_COLOR_WORKTREE
= 6
65 static const char *color_branch_slots
[] = {
66 [BRANCH_COLOR_RESET
] = "reset",
67 [BRANCH_COLOR_PLAIN
] = "plain",
68 [BRANCH_COLOR_REMOTE
] = "remote",
69 [BRANCH_COLOR_LOCAL
] = "local",
70 [BRANCH_COLOR_CURRENT
] = "current",
71 [BRANCH_COLOR_UPSTREAM
] = "upstream",
72 [BRANCH_COLOR_WORKTREE
] = "worktree",
75 static struct string_list output
= STRING_LIST_INIT_DUP
;
76 static unsigned int colopts
;
78 define_list_config_array(color_branch_slots
);
80 static int git_branch_config(const char *var
, const char *value
, void *cb
)
82 const char *slot_name
;
84 if (!strcmp(var
, "branch.sort")) {
86 return config_error_nonbool(var
);
87 string_list_append(cb
, value
);
91 if (starts_with(var
, "column."))
92 return git_column_config(var
, value
, "branch", &colopts
);
93 if (!strcmp(var
, "color.branch")) {
94 branch_use_color
= git_config_colorbool(var
, value
);
97 if (skip_prefix(var
, "color.branch.", &slot_name
)) {
98 int slot
= LOOKUP_CONFIG(color_branch_slots
, slot_name
);
102 return config_error_nonbool(var
);
103 return color_parse(value
, branch_colors
[slot
]);
105 if (!strcmp(var
, "submodule.recurse")) {
106 recurse_submodules
= git_config_bool(var
, value
);
109 if (!strcasecmp(var
, "submodule.propagateBranches")) {
110 submodule_propagate_branches
= git_config_bool(var
, value
);
114 return git_color_default_config(var
, value
, cb
);
117 static const char *branch_get_color(enum color_branch ix
)
119 if (want_color(branch_use_color
))
120 return branch_colors
[ix
];
124 static int branch_merged(int kind
, const char *name
,
125 struct commit
*rev
, struct commit
*head_rev
)
128 * This checks whether the merge bases of branch and HEAD (or
129 * the other branch this branch builds upon) contains the
130 * branch, which means that the branch has already been merged
131 * safely to HEAD (or the other branch).
133 struct commit
*reference_rev
= NULL
;
134 const char *reference_name
= NULL
;
135 void *reference_name_to_free
= NULL
;
138 if (kind
== FILTER_REFS_BRANCHES
) {
139 struct branch
*branch
= branch_get(name
);
140 const char *upstream
= branch_get_upstream(branch
, NULL
);
141 struct object_id oid
;
144 (reference_name
= reference_name_to_free
=
145 resolve_refdup(upstream
, RESOLVE_REF_READING
,
146 &oid
, NULL
)) != NULL
)
147 reference_rev
= lookup_commit_reference(the_repository
,
151 reference_rev
= head_rev
;
153 merged
= in_merge_bases(rev
, reference_rev
);
156 * After the safety valve is fully redefined to "check with
157 * upstream, if any, otherwise with HEAD", we should just
158 * return the result of the in_merge_bases() above without
159 * any of the following code, but during the transition period,
160 * a gentle reminder is in order.
162 if ((head_rev
!= reference_rev
) &&
163 in_merge_bases(rev
, head_rev
) != merged
) {
165 warning(_("deleting branch '%s' that has been merged to\n"
166 " '%s', but not yet merged to HEAD."),
167 name
, reference_name
);
169 warning(_("not deleting branch '%s' that is not yet merged to\n"
170 " '%s', even though it is merged to HEAD."),
171 name
, reference_name
);
173 free(reference_name_to_free
);
177 static int check_branch_commit(const char *branchname
, const char *refname
,
178 const struct object_id
*oid
, struct commit
*head_rev
,
179 int kinds
, int force
)
181 struct commit
*rev
= lookup_commit_reference(the_repository
, oid
);
182 if (!force
&& !rev
) {
183 error(_("Couldn't look up commit object for '%s'"), refname
);
186 if (!force
&& !branch_merged(kinds
, branchname
, rev
, head_rev
)) {
187 error(_("The branch '%s' is not fully merged.\n"
188 "If you are sure you want to delete it, "
189 "run 'git branch -D %s'."), branchname
, branchname
);
195 static void delete_branch_config(const char *branchname
)
197 struct strbuf buf
= STRBUF_INIT
;
198 strbuf_addf(&buf
, "branch.%s", branchname
);
199 if (git_config_rename_section(buf
.buf
, NULL
) < 0)
200 warning(_("Update of config-file failed"));
201 strbuf_release(&buf
);
204 static int delete_branches(int argc
, const char **argv
, int force
, int kinds
,
207 struct commit
*head_rev
= NULL
;
208 struct object_id oid
;
213 int remote_branch
= 0;
214 struct strbuf bname
= STRBUF_INIT
;
215 unsigned allowed_interpret
;
216 struct string_list refs_to_delete
= STRING_LIST_INIT_DUP
;
217 struct string_list_item
*item
;
221 case FILTER_REFS_REMOTES
:
222 fmt
= "refs/remotes/%s";
223 /* For subsequent UI messages */
225 allowed_interpret
= INTERPRET_BRANCH_REMOTE
;
229 case FILTER_REFS_BRANCHES
:
230 fmt
= "refs/heads/%s";
231 allowed_interpret
= INTERPRET_BRANCH_LOCAL
;
234 die(_("cannot use -a with -d"));
236 branch_name_pos
= strcspn(fmt
, "%");
239 head_rev
= lookup_commit_reference(the_repository
, &head_oid
);
241 die(_("Couldn't look up commit object for HEAD"));
244 for (i
= 0; i
< argc
; i
++, strbuf_reset(&bname
)) {
248 strbuf_branchname(&bname
, argv
[i
], allowed_interpret
);
250 name
= mkpathdup(fmt
, bname
.buf
);
252 if (kinds
== FILTER_REFS_BRANCHES
) {
254 if ((path
= branch_checked_out(name
))) {
255 error(_("Cannot delete branch '%s' "
256 "checked out at '%s'"),
263 target
= resolve_refdup(name
,
265 | RESOLVE_REF_NO_RECURSE
266 | RESOLVE_REF_ALLOW_BAD_NAME
,
270 ? _("remote-tracking branch '%s' not found.")
271 : _("branch '%s' not found."), bname
.buf
);
276 if (!(flags
& (REF_ISSYMREF
|REF_ISBROKEN
)) &&
277 check_branch_commit(bname
.buf
, name
, &oid
, head_rev
, kinds
,
283 item
= string_list_append(&refs_to_delete
, name
);
284 item
->util
= xstrdup((flags
& REF_ISBROKEN
) ? "broken"
285 : (flags
& REF_ISSYMREF
) ? target
286 : find_unique_abbrev(&oid
, DEFAULT_ABBREV
));
292 if (delete_refs(NULL
, &refs_to_delete
, REF_NO_DEREF
))
295 for_each_string_list_item(item
, &refs_to_delete
) {
296 char *describe_ref
= item
->util
;
297 char *name
= item
->string
;
298 if (!ref_exists(name
)) {
299 char *refname
= name
+ branch_name_pos
;
302 ? _("Deleted remote-tracking branch %s (was %s).\n")
303 : _("Deleted branch %s (was %s).\n"),
304 name
+ branch_name_pos
, describe_ref
);
306 delete_branch_config(refname
);
310 string_list_clear(&refs_to_delete
, 0);
313 strbuf_release(&bname
);
318 static int calc_maxwidth(struct ref_array
*refs
, int remote_bonus
)
321 for (i
= 0; i
< refs
->nr
; i
++) {
322 struct ref_array_item
*it
= refs
->items
[i
];
323 const char *desc
= it
->refname
;
326 skip_prefix(it
->refname
, "refs/heads/", &desc
);
327 skip_prefix(it
->refname
, "refs/remotes/", &desc
);
328 if (it
->kind
== FILTER_REFS_DETACHED_HEAD
) {
329 char *head_desc
= get_head_description();
330 w
= utf8_strwidth(head_desc
);
333 w
= utf8_strwidth(desc
);
335 if (it
->kind
== FILTER_REFS_REMOTES
)
343 static const char *quote_literal_for_format(const char *s
)
345 static struct strbuf buf
= STRBUF_INIT
;
349 const char *ep
= strchrnul(s
, '%');
351 strbuf_add(&buf
, s
, ep
- s
);
353 strbuf_addstr(&buf
, "%%");
362 static char *build_format(struct ref_filter
*filter
, int maxwidth
, const char *remote_prefix
)
364 struct strbuf fmt
= STRBUF_INIT
;
365 struct strbuf local
= STRBUF_INIT
;
366 struct strbuf remote
= STRBUF_INIT
;
368 strbuf_addf(&local
, "%%(if)%%(HEAD)%%(then)* %s%%(else)%%(if)%%(worktreepath)%%(then)+ %s%%(else) %s%%(end)%%(end)",
369 branch_get_color(BRANCH_COLOR_CURRENT
),
370 branch_get_color(BRANCH_COLOR_WORKTREE
),
371 branch_get_color(BRANCH_COLOR_LOCAL
));
372 strbuf_addf(&remote
, " %s",
373 branch_get_color(BRANCH_COLOR_REMOTE
));
375 if (filter
->verbose
) {
376 struct strbuf obname
= STRBUF_INIT
;
378 if (filter
->abbrev
< 0)
379 strbuf_addf(&obname
, "%%(objectname:short)");
380 else if (!filter
->abbrev
)
381 strbuf_addf(&obname
, "%%(objectname)");
383 strbuf_addf(&obname
, "%%(objectname:short=%d)", filter
->abbrev
);
385 strbuf_addf(&local
, "%%(align:%d,left)%%(refname:lstrip=2)%%(end)", maxwidth
);
386 strbuf_addstr(&local
, branch_get_color(BRANCH_COLOR_RESET
));
387 strbuf_addf(&local
, " %s ", obname
.buf
);
389 if (filter
->verbose
> 1)
391 strbuf_addf(&local
, "%%(if:notequals=*)%%(HEAD)%%(then)%%(if)%%(worktreepath)%%(then)(%s%%(worktreepath)%s) %%(end)%%(end)",
392 branch_get_color(BRANCH_COLOR_WORKTREE
), branch_get_color(BRANCH_COLOR_RESET
));
393 strbuf_addf(&local
, "%%(if)%%(upstream)%%(then)[%s%%(upstream:short)%s%%(if)%%(upstream:track)"
394 "%%(then): %%(upstream:track,nobracket)%%(end)] %%(end)%%(contents:subject)",
395 branch_get_color(BRANCH_COLOR_UPSTREAM
), branch_get_color(BRANCH_COLOR_RESET
));
398 strbuf_addf(&local
, "%%(if)%%(upstream:track)%%(then)%%(upstream:track) %%(end)%%(contents:subject)");
400 strbuf_addf(&remote
, "%%(align:%d,left)%s%%(refname:lstrip=2)%%(end)%s"
401 "%%(if)%%(symref)%%(then) -> %%(symref:short)"
402 "%%(else) %s %%(contents:subject)%%(end)",
403 maxwidth
, quote_literal_for_format(remote_prefix
),
404 branch_get_color(BRANCH_COLOR_RESET
), obname
.buf
);
405 strbuf_release(&obname
);
407 strbuf_addf(&local
, "%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
408 branch_get_color(BRANCH_COLOR_RESET
));
409 strbuf_addf(&remote
, "%s%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
410 quote_literal_for_format(remote_prefix
),
411 branch_get_color(BRANCH_COLOR_RESET
));
414 strbuf_addf(&fmt
, "%%(if:notequals=refs/remotes)%%(refname:rstrip=-2)%%(then)%s%%(else)%s%%(end)", local
.buf
, remote
.buf
);
416 strbuf_release(&local
);
417 strbuf_release(&remote
);
418 return strbuf_detach(&fmt
, NULL
);
421 static void print_ref_list(struct ref_filter
*filter
, struct ref_sorting
*sorting
,
422 struct ref_format
*format
, struct string_list
*output
)
425 struct ref_array array
;
426 struct strbuf out
= STRBUF_INIT
;
427 struct strbuf err
= STRBUF_INIT
;
429 const char *remote_prefix
= "";
430 char *to_free
= NULL
;
433 * If we are listing more than just remote branches,
434 * then remote branches will have a "remotes/" prefix.
435 * We need to account for this in the width.
437 if (filter
->kind
!= FILTER_REFS_REMOTES
)
438 remote_prefix
= "remotes/";
440 memset(&array
, 0, sizeof(array
));
442 filter_refs(&array
, filter
, filter
->kind
);
445 maxwidth
= calc_maxwidth(&array
, strlen(remote_prefix
));
448 format
->format
= to_free
= build_format(filter
, maxwidth
, remote_prefix
);
449 format
->use_color
= branch_use_color
;
451 if (verify_ref_format(format
))
452 die(_("unable to parse format string"));
454 ref_array_sort(sorting
, &array
);
456 for (i
= 0; i
< array
.nr
; i
++) {
459 if (format_ref_array_item(array
.items
[i
], format
, &out
, &err
))
461 if (column_active(colopts
)) {
462 assert(!filter
->verbose
&& "--column and --verbose are incompatible");
463 /* format to a string_list to let print_columns() do its job */
464 string_list_append(output
, out
.buf
);
466 fwrite(out
.buf
, 1, out
.len
, stdout
);
471 strbuf_release(&err
);
472 strbuf_release(&out
);
473 ref_array_clear(&array
);
477 static void print_current_branch_name(void)
480 const char *refname
= resolve_ref_unsafe("HEAD", 0, NULL
, &flags
);
481 const char *shortname
;
483 die(_("could not resolve HEAD"));
484 else if (!(flags
& REF_ISSYMREF
))
486 else if (skip_prefix(refname
, "refs/heads/", &shortname
))
489 die(_("HEAD (%s) points outside of refs/heads/"), refname
);
492 static void reject_rebase_or_bisect_branch(const char *target
)
494 struct worktree
**worktrees
= get_worktrees();
497 for (i
= 0; worktrees
[i
]; i
++) {
498 struct worktree
*wt
= worktrees
[i
];
500 if (!wt
->is_detached
)
503 if (is_worktree_being_rebased(wt
, target
))
504 die(_("Branch %s is being rebased at %s"),
507 if (is_worktree_being_bisected(wt
, target
))
508 die(_("Branch %s is being bisected at %s"),
512 free_worktrees(worktrees
);
515 static void copy_or_rename_branch(const char *oldname
, const char *newname
, int copy
, int force
)
517 struct strbuf oldref
= STRBUF_INIT
, newref
= STRBUF_INIT
, logmsg
= STRBUF_INIT
;
518 struct strbuf oldsection
= STRBUF_INIT
, newsection
= STRBUF_INIT
;
519 const char *interpreted_oldname
= NULL
;
520 const char *interpreted_newname
= NULL
;
525 die(_("cannot copy the current branch while not on any."));
527 die(_("cannot rename the current branch while not on any."));
530 if (strbuf_check_branch_ref(&oldref
, oldname
)) {
532 * Bad name --- this could be an attempt to rename a
533 * ref that we used to allow to be created by accident.
535 if (ref_exists(oldref
.buf
))
538 die(_("Invalid branch name: '%s'"), oldname
);
541 if ((copy
|| strcmp(head
, oldname
)) && !ref_exists(oldref
.buf
)) {
542 if (copy
&& !strcmp(head
, oldname
))
543 die(_("No commit on branch '%s' yet."), oldname
);
545 die(_("No branch named '%s'."), oldname
);
549 * A command like "git branch -M currentbranch currentbranch" cannot
550 * cause the worktree to become inconsistent with HEAD, so allow it.
552 if (!strcmp(oldname
, newname
))
553 validate_branchname(newname
, &newref
);
555 validate_new_branchname(newname
, &newref
, force
);
557 reject_rebase_or_bisect_branch(oldref
.buf
);
559 if (!skip_prefix(oldref
.buf
, "refs/heads/", &interpreted_oldname
) ||
560 !skip_prefix(newref
.buf
, "refs/heads/", &interpreted_newname
)) {
561 BUG("expected prefix missing for refs");
565 strbuf_addf(&logmsg
, "Branch: copied %s to %s",
566 oldref
.buf
, newref
.buf
);
568 strbuf_addf(&logmsg
, "Branch: renamed %s to %s",
569 oldref
.buf
, newref
.buf
);
572 (!head
|| strcmp(oldname
, head
) || !is_null_oid(&head_oid
)) &&
573 rename_ref(oldref
.buf
, newref
.buf
, logmsg
.buf
))
574 die(_("Branch rename failed"));
575 if (copy
&& copy_existing_ref(oldref
.buf
, newref
.buf
, logmsg
.buf
))
576 die(_("Branch copy failed"));
580 warning(_("Created a copy of a misnamed branch '%s'"),
581 interpreted_oldname
);
583 warning(_("Renamed a misnamed branch '%s' away"),
584 interpreted_oldname
);
588 replace_each_worktree_head_symref(oldref
.buf
, newref
.buf
, logmsg
.buf
))
589 die(_("Branch renamed to %s, but HEAD is not updated!"), newname
);
591 strbuf_release(&logmsg
);
593 strbuf_addf(&oldsection
, "branch.%s", interpreted_oldname
);
594 strbuf_release(&oldref
);
595 strbuf_addf(&newsection
, "branch.%s", interpreted_newname
);
596 strbuf_release(&newref
);
597 if (!copy
&& git_config_rename_section(oldsection
.buf
, newsection
.buf
) < 0)
598 die(_("Branch is renamed, but update of config-file failed"));
599 if (copy
&& strcmp(oldname
, newname
) && git_config_copy_section(oldsection
.buf
, newsection
.buf
) < 0)
600 die(_("Branch is copied, but update of config-file failed"));
601 strbuf_release(&oldsection
);
602 strbuf_release(&newsection
);
605 static GIT_PATH_FUNC(edit_description
, "EDIT_DESCRIPTION")
607 static int edit_branch_description(const char *branch_name
)
610 struct strbuf buf
= STRBUF_INIT
;
611 struct strbuf name
= STRBUF_INIT
;
613 exists
= !read_branch_desc(&buf
, branch_name
);
614 if (!buf
.len
|| buf
.buf
[buf
.len
-1] != '\n')
615 strbuf_addch(&buf
, '\n');
616 strbuf_commented_addf(&buf
,
617 _("Please edit the description for the branch\n"
619 "Lines starting with '%c' will be stripped.\n"),
620 branch_name
, comment_line_char
);
621 write_file_buf(edit_description(), buf
.buf
, buf
.len
);
623 if (launch_editor(edit_description(), &buf
, NULL
)) {
624 strbuf_release(&buf
);
627 strbuf_stripspace(&buf
, 1);
629 strbuf_addf(&name
, "branch.%s.description", branch_name
);
630 if (buf
.len
|| exists
)
631 git_config_set(name
.buf
, buf
.len
? buf
.buf
: NULL
);
632 strbuf_release(&name
);
633 strbuf_release(&buf
);
638 int cmd_branch(int argc
, const char **argv
, const char *prefix
)
640 /* possible actions */
641 int delete = 0, rename
= 0, copy
= 0, list
= 0,
642 unset_upstream
= 0, show_current
= 0, edit_description
= 0;
643 const char *new_upstream
= NULL
;
644 int noncreate_actions
= 0;
645 /* possible options */
646 int reflog
= 0, quiet
= 0, icase
= 0, force
= 0,
647 recurse_submodules_explicit
= 0;
648 enum branch_track track
;
649 struct ref_filter filter
;
650 static struct ref_sorting
*sorting
;
651 struct string_list sorting_options
= STRING_LIST_INIT_DUP
;
652 struct ref_format format
= REF_FORMAT_INIT
;
654 struct option options
[] = {
655 OPT_GROUP(N_("Generic options")),
656 OPT__VERBOSE(&filter
.verbose
,
657 N_("show hash and subject, give twice for upstream branch")),
658 OPT__QUIET(&quiet
, N_("suppress informational messages")),
659 OPT_CALLBACK_F('t', "track", &track
, "(direct|inherit)",
660 N_("set branch tracking configuration"),
662 parse_opt_tracking_mode
),
663 OPT_SET_INT_F(0, "set-upstream", &track
, N_("do not use"),
664 BRANCH_TRACK_OVERRIDE
, PARSE_OPT_HIDDEN
),
665 OPT_STRING('u', "set-upstream-to", &new_upstream
, N_("upstream"), N_("change the upstream info")),
666 OPT_BOOL(0, "unset-upstream", &unset_upstream
, N_("unset the upstream info")),
667 OPT__COLOR(&branch_use_color
, N_("use colored output")),
668 OPT_SET_INT('r', "remotes", &filter
.kind
, N_("act on remote-tracking branches"),
669 FILTER_REFS_REMOTES
),
670 OPT_CONTAINS(&filter
.with_commit
, N_("print only branches that contain the commit")),
671 OPT_NO_CONTAINS(&filter
.no_commit
, N_("print only branches that don't contain the commit")),
672 OPT_WITH(&filter
.with_commit
, N_("print only branches that contain the commit")),
673 OPT_WITHOUT(&filter
.no_commit
, N_("print only branches that don't contain the commit")),
674 OPT__ABBREV(&filter
.abbrev
),
676 OPT_GROUP(N_("Specific git-branch actions:")),
677 OPT_SET_INT('a', "all", &filter
.kind
, N_("list both remote-tracking and local branches"),
678 FILTER_REFS_REMOTES
| FILTER_REFS_BRANCHES
),
679 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
680 OPT_BIT('D', NULL
, &delete, N_("delete branch (even if not merged)"), 2),
681 OPT_BIT('m', "move", &rename
, N_("move/rename a branch and its reflog"), 1),
682 OPT_BIT('M', NULL
, &rename
, N_("move/rename a branch, even if target exists"), 2),
683 OPT_BIT('c', "copy", ©
, N_("copy a branch and its reflog"), 1),
684 OPT_BIT('C', NULL
, ©
, N_("copy a branch, even if target exists"), 2),
685 OPT_BOOL('l', "list", &list
, N_("list branch names")),
686 OPT_BOOL(0, "show-current", &show_current
, N_("show current branch name")),
687 OPT_BOOL(0, "create-reflog", &reflog
, N_("create the branch's reflog")),
688 OPT_BOOL(0, "edit-description", &edit_description
,
689 N_("edit the description for the branch")),
690 OPT__FORCE(&force
, N_("force creation, move/rename, deletion"), PARSE_OPT_NOCOMPLETE
),
691 OPT_MERGED(&filter
, N_("print only branches that are merged")),
692 OPT_NO_MERGED(&filter
, N_("print only branches that are not merged")),
693 OPT_COLUMN(0, "column", &colopts
, N_("list branches in columns")),
694 OPT_REF_SORT(&sorting_options
),
695 OPT_CALLBACK(0, "points-at", &filter
.points_at
, N_("object"),
696 N_("print only branches of the object"), parse_opt_object_name
),
697 OPT_BOOL('i', "ignore-case", &icase
, N_("sorting and filtering are case insensitive")),
698 OPT_BOOL(0, "recurse-submodules", &recurse_submodules_explicit
, N_("recurse through submodules")),
699 OPT_STRING( 0 , "format", &format
.format
, N_("format"), N_("format to use for the output")),
703 setup_ref_filter_porcelain_msg();
705 memset(&filter
, 0, sizeof(filter
));
706 filter
.kind
= FILTER_REFS_BRANCHES
;
709 if (argc
== 2 && !strcmp(argv
[1], "-h"))
710 usage_with_options(builtin_branch_usage
, options
);
712 git_config(git_branch_config
, &sorting_options
);
714 track
= git_branch_track
;
716 head
= resolve_refdup("HEAD", 0, &head_oid
, NULL
);
718 die(_("Failed to resolve HEAD as a valid ref."));
719 if (!strcmp(head
, "HEAD"))
721 else if (!skip_prefix(head
, "refs/heads/", &head
))
722 die(_("HEAD not found below refs/heads!"));
724 argc
= parse_options(argc
, argv
, prefix
, options
, builtin_branch_usage
,
727 if (!delete && !rename
&& !copy
&& !edit_description
&& !new_upstream
&&
728 !show_current
&& !unset_upstream
&& argc
== 0)
731 if (filter
.with_commit
|| filter
.no_commit
||
732 filter
.reachable_from
|| filter
.unreachable_from
|| filter
.points_at
.nr
)
735 noncreate_actions
= !!delete + !!rename
+ !!copy
+ !!new_upstream
+
736 !!show_current
+ !!list
+ !!edit_description
+
738 if (noncreate_actions
> 1)
739 usage_with_options(builtin_branch_usage
, options
);
741 if (recurse_submodules_explicit
) {
742 if (!submodule_propagate_branches
)
743 die(_("branch with --recurse-submodules can only be used if submodule.propagateBranches is enabled"));
744 if (noncreate_actions
)
745 die(_("--recurse-submodules can only be used to create branches"));
749 (recurse_submodules
|| recurse_submodules_explicit
) &&
750 submodule_propagate_branches
;
752 if (filter
.abbrev
== -1)
753 filter
.abbrev
= DEFAULT_ABBREV
;
754 filter
.ignore_case
= icase
;
756 finalize_colopts(&colopts
, -1);
757 if (filter
.verbose
) {
758 if (explicitly_enable_column(colopts
))
759 die(_("options '%s' and '%s' cannot be used together"), "--column", "--verbose");
770 setup_auto_pager("branch", 1);
774 die(_("branch name required"));
775 return delete_branches(argc
, argv
, delete > 1, filter
.kind
, quiet
);
776 } else if (show_current
) {
777 print_current_branch_name();
780 /* git branch --list also shows HEAD when it is detached */
781 if ((filter
.kind
& FILTER_REFS_BRANCHES
) && filter
.detached
)
782 filter
.kind
|= FILTER_REFS_DETACHED_HEAD
;
783 filter
.name_patterns
= argv
;
785 * If no sorting parameter is given then we default to sorting
786 * by 'refname'. This would give us an alphabetically sorted
787 * array with the 'HEAD' ref at the beginning followed by
788 * local branches 'refs/heads/...' and finally remote-tracking
789 * branches 'refs/remotes/...'.
791 sorting
= ref_sorting_options(&sorting_options
);
792 ref_sorting_set_sort_flags_all(sorting
, REF_SORTING_ICASE
, icase
);
793 ref_sorting_set_sort_flags_all(
794 sorting
, REF_SORTING_DETACHED_HEAD_FIRST
, 1);
795 print_ref_list(&filter
, sorting
, &format
, &output
);
796 print_columns(&output
, colopts
, NULL
);
797 string_list_clear(&output
, 0);
798 ref_sorting_release(sorting
);
800 } else if (edit_description
) {
801 const char *branch_name
;
802 struct strbuf branch_ref
= STRBUF_INIT
;
803 struct strbuf buf
= STRBUF_INIT
;
804 int ret
= 1; /* assume failure */
808 die(_("Cannot give description to detached HEAD"));
810 } else if (argc
== 1) {
811 strbuf_branchname(&buf
, argv
[0], INTERPRET_BRANCH_LOCAL
);
812 branch_name
= buf
.buf
;
814 die(_("cannot edit description of more than one branch"));
817 strbuf_addf(&branch_ref
, "refs/heads/%s", branch_name
);
818 if (!ref_exists(branch_ref
.buf
))
819 ret
= error((!argc
|| !strcmp(head
, branch_name
))
820 ? _("No commit on branch '%s' yet.")
821 : _("No branch named '%s'."),
823 else if (!edit_branch_description(branch_name
))
826 strbuf_release(&branch_ref
);
827 strbuf_release(&buf
);
832 die(_("branch name required"));
834 copy_or_rename_branch(head
, argv
[0], 1, copy
> 1);
836 copy_or_rename_branch(argv
[0], argv
[1], 1, copy
> 1);
838 die(_("too many branches for a copy operation"));
841 die(_("branch name required"));
843 copy_or_rename_branch(head
, argv
[0], 0, rename
> 1);
845 copy_or_rename_branch(argv
[0], argv
[1], 0, rename
> 1);
847 die(_("too many arguments for a rename operation"));
848 } else if (new_upstream
) {
849 struct branch
*branch
;
850 struct strbuf buf
= STRBUF_INIT
;
853 branch
= branch_get(NULL
);
854 else if (argc
== 1) {
855 strbuf_branchname(&buf
, argv
[0], INTERPRET_BRANCH_LOCAL
);
856 branch
= branch_get(buf
.buf
);
858 die(_("too many arguments to set new upstream"));
861 if (!argc
|| !strcmp(argv
[0], "HEAD"))
862 die(_("could not set upstream of HEAD to %s when "
863 "it does not point to any branch."),
865 die(_("no such branch '%s'"), argv
[0]);
868 if (!ref_exists(branch
->refname
)) {
869 if (!argc
|| !strcmp(head
, branch
->name
))
870 die(_("No commit on branch '%s' yet."), branch
->name
);
871 die(_("branch '%s' does not exist"), branch
->name
);
874 dwim_and_setup_tracking(the_repository
, branch
->name
,
875 new_upstream
, BRANCH_TRACK_OVERRIDE
,
877 strbuf_release(&buf
);
878 } else if (unset_upstream
) {
879 struct branch
*branch
;
880 struct strbuf buf
= STRBUF_INIT
;
883 branch
= branch_get(NULL
);
884 else if (argc
== 1) {
885 strbuf_branchname(&buf
, argv
[0], INTERPRET_BRANCH_LOCAL
);
886 branch
= branch_get(buf
.buf
);
888 die(_("too many arguments to unset upstream"));
891 if (!argc
|| !strcmp(argv
[0], "HEAD"))
892 die(_("could not unset upstream of HEAD when "
893 "it does not point to any branch."));
894 die(_("no such branch '%s'"), argv
[0]);
897 if (!branch_has_merge_config(branch
))
898 die(_("Branch '%s' has no upstream information"), branch
->name
);
901 strbuf_addf(&buf
, "branch.%s.remote", branch
->name
);
902 git_config_set_multivar(buf
.buf
, NULL
, NULL
, CONFIG_FLAGS_MULTI_REPLACE
);
904 strbuf_addf(&buf
, "branch.%s.merge", branch
->name
);
905 git_config_set_multivar(buf
.buf
, NULL
, NULL
, CONFIG_FLAGS_MULTI_REPLACE
);
906 strbuf_release(&buf
);
907 } else if (!noncreate_actions
&& argc
> 0 && argc
<= 2) {
908 const char *branch_name
= argv
[0];
909 const char *start_name
= argc
== 2 ? argv
[1] : head
;
911 if (filter
.kind
!= FILTER_REFS_BRANCHES
)
912 die(_("The -a, and -r, options to 'git branch' do not take a branch name.\n"
913 "Did you mean to use: -a|-r --list <pattern>?"));
915 if (track
== BRANCH_TRACK_OVERRIDE
)
916 die(_("the '--set-upstream' option is no longer supported. Please use '--track' or '--set-upstream-to' instead."));
918 if (recurse_submodules
) {
919 create_branches_recursively(the_repository
, branch_name
,
920 start_name
, NULL
, force
,
921 reflog
, quiet
, track
, 0);
924 create_branch(the_repository
, branch_name
, start_name
, force
, 0,
925 reflog
, quiet
, track
, 0);
927 usage_with_options(builtin_branch_usage
, options
);