4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-branch.sh by Junio C Hamano.
14 #include "parse-options.h"
19 static const char * const builtin_branch_usage
[] = {
20 "git branch [options] [-r | -a] [--merged | --no-merged]",
21 "git branch [options] [-l] [-f] <branchname> [<start-point>]",
22 "git branch [options] [-r] (-d | -D) <branchname>",
23 "git branch [options] (-m | -M) [<oldbranch>] <newbranch>",
27 #define REF_LOCAL_BRANCH 0x01
28 #define REF_REMOTE_BRANCH 0x02
30 static const char *head
;
31 static unsigned char head_sha1
[20];
33 static int branch_use_color
= -1;
34 static char branch_colors
[][COLOR_MAXLEN
] = {
36 GIT_COLOR_NORMAL
, /* PLAIN */
37 GIT_COLOR_RED
, /* REMOTE */
38 GIT_COLOR_NORMAL
, /* LOCAL */
39 GIT_COLOR_GREEN
, /* CURRENT */
42 BRANCH_COLOR_RESET
= 0,
43 BRANCH_COLOR_PLAIN
= 1,
44 BRANCH_COLOR_REMOTE
= 2,
45 BRANCH_COLOR_LOCAL
= 3,
46 BRANCH_COLOR_CURRENT
= 4,
49 static enum merge_filter
{
54 static unsigned char merge_filter_ref
[20];
56 static int parse_branch_color_slot(const char *var
, int ofs
)
58 if (!strcasecmp(var
+ofs
, "plain"))
59 return BRANCH_COLOR_PLAIN
;
60 if (!strcasecmp(var
+ofs
, "reset"))
61 return BRANCH_COLOR_RESET
;
62 if (!strcasecmp(var
+ofs
, "remote"))
63 return BRANCH_COLOR_REMOTE
;
64 if (!strcasecmp(var
+ofs
, "local"))
65 return BRANCH_COLOR_LOCAL
;
66 if (!strcasecmp(var
+ofs
, "current"))
67 return BRANCH_COLOR_CURRENT
;
71 static int git_branch_config(const char *var
, const char *value
, void *cb
)
73 if (!strcmp(var
, "color.branch")) {
74 branch_use_color
= git_config_colorbool(var
, value
, -1);
77 if (!prefixcmp(var
, "color.branch.")) {
78 int slot
= parse_branch_color_slot(var
, 13);
82 return config_error_nonbool(var
);
83 color_parse(value
, var
, branch_colors
[slot
]);
86 return git_color_default_config(var
, value
, cb
);
89 static const char *branch_get_color(enum color_branch ix
)
91 if (branch_use_color
> 0)
92 return branch_colors
[ix
];
96 static int delete_branches(int argc
, const char **argv
, int force
, int kinds
)
98 struct commit
*rev
, *head_rev
= head_rev
;
99 unsigned char sha1
[20];
101 const char *fmt
, *remote
;
104 struct strbuf bname
= STRBUF_INIT
;
107 case REF_REMOTE_BRANCH
:
108 fmt
= "refs/remotes/%s";
112 case REF_LOCAL_BRANCH
:
113 fmt
= "refs/heads/%s";
117 die("cannot use -a with -d");
121 head_rev
= lookup_commit_reference(head_sha1
);
123 die("Couldn't look up commit object for HEAD");
125 for (i
= 0; i
< argc
; i
++, strbuf_release(&bname
)) {
126 strbuf_branchname(&bname
, argv
[i
]);
127 if (kinds
== REF_LOCAL_BRANCH
&& !strcmp(head
, bname
.buf
)) {
128 error("Cannot delete the branch '%s' "
129 "which you are currently on.", bname
.buf
);
136 name
= xstrdup(mkpath(fmt
, bname
.buf
));
137 if (!resolve_ref(name
, sha1
, 1, NULL
)) {
138 error("%sbranch '%s' not found.",
144 rev
= lookup_commit_reference(sha1
);
146 error("Couldn't look up commit object for '%s'", name
);
151 /* This checks whether the merge bases of branch and
152 * HEAD contains branch -- which means that the HEAD
153 * contains everything in both.
157 !in_merge_bases(rev
, &head_rev
, 1)) {
158 error("The branch '%s' is not an ancestor of "
159 "your current HEAD.\n"
160 "If you are sure you want to delete it, "
161 "run 'git branch -D %s'.", bname
.buf
, bname
.buf
);
166 if (delete_ref(name
, sha1
, 0)) {
167 error("Error deleting %sbranch '%s'", remote
,
171 struct strbuf buf
= STRBUF_INIT
;
172 printf("Deleted %sbranch %s (was %s).\n", remote
,
174 find_unique_abbrev(sha1
, DEFAULT_ABBREV
));
175 strbuf_addf(&buf
, "branch.%s", bname
.buf
);
176 if (git_config_rename_section(buf
.buf
, NULL
) < 0)
177 warning("Update of config-file failed");
178 strbuf_release(&buf
);
190 unsigned int kind
, len
;
191 struct commit
*commit
;
195 struct rev_info revs
;
196 int index
, alloc
, maxwidth
, verbose
, abbrev
;
197 struct ref_item
*list
;
198 struct commit_list
*with_commit
;
202 static char *resolve_symref(const char *src
, const char *prefix
)
204 unsigned char sha1
[20];
206 const char *dst
, *cp
;
208 dst
= resolve_ref(src
, sha1
, 0, &flag
);
209 if (!(dst
&& (flag
& REF_ISSYMREF
)))
211 if (prefix
&& (cp
= skip_prefix(dst
, prefix
)))
216 static int append_ref(const char *refname
, const unsigned char *sha1
, int flags
, void *cb_data
)
218 struct ref_list
*ref_list
= (struct ref_list
*)(cb_data
);
219 struct ref_item
*newitem
;
220 struct commit
*commit
;
222 const char *prefix
, *orig_refname
= refname
;
229 { REF_LOCAL_BRANCH
, "refs/heads/", 11 },
230 { REF_REMOTE_BRANCH
, "refs/remotes/", 13 },
234 for (i
= 0; i
< ARRAY_SIZE(ref_kind
); i
++) {
235 prefix
= ref_kind
[i
].prefix
;
236 if (strncmp(refname
, prefix
, ref_kind
[i
].pfxlen
))
238 kind
= ref_kind
[i
].kind
;
239 refname
+= ref_kind
[i
].pfxlen
;
242 if (ARRAY_SIZE(ref_kind
) <= i
)
245 /* Don't add types the caller doesn't want */
246 if ((kind
& ref_list
->kinds
) == 0)
250 if (ref_list
->verbose
|| ref_list
->with_commit
|| merge_filter
!= NO_FILTER
) {
251 commit
= lookup_commit_reference_gently(sha1
, 1);
253 return error("branch '%s' does not point at a commit", refname
);
255 /* Filter with with_commit if specified */
256 if (!is_descendant_of(commit
, ref_list
->with_commit
))
259 if (merge_filter
!= NO_FILTER
)
260 add_pending_object(&ref_list
->revs
,
261 (struct object
*)commit
, refname
);
265 if (ref_list
->index
>= ref_list
->alloc
) {
266 ref_list
->alloc
= alloc_nr(ref_list
->alloc
);
267 ref_list
->list
= xrealloc(ref_list
->list
,
268 ref_list
->alloc
* sizeof(struct ref_item
));
271 /* Record the new item */
272 newitem
= &(ref_list
->list
[ref_list
->index
++]);
273 newitem
->name
= xstrdup(refname
);
274 newitem
->kind
= kind
;
275 newitem
->commit
= commit
;
276 newitem
->len
= strlen(refname
);
277 newitem
->dest
= resolve_symref(orig_refname
, prefix
);
278 /* adjust for "remotes/" */
279 if (newitem
->kind
== REF_REMOTE_BRANCH
&&
280 ref_list
->kinds
!= REF_REMOTE_BRANCH
)
282 if (newitem
->len
> ref_list
->maxwidth
)
283 ref_list
->maxwidth
= newitem
->len
;
288 static void free_ref_list(struct ref_list
*ref_list
)
292 for (i
= 0; i
< ref_list
->index
; i
++) {
293 free(ref_list
->list
[i
].name
);
294 free(ref_list
->list
[i
].dest
);
296 free(ref_list
->list
);
299 static int ref_cmp(const void *r1
, const void *r2
)
301 struct ref_item
*c1
= (struct ref_item
*)(r1
);
302 struct ref_item
*c2
= (struct ref_item
*)(r2
);
304 if (c1
->kind
!= c2
->kind
)
305 return c1
->kind
- c2
->kind
;
306 return strcmp(c1
->name
, c2
->name
);
309 static void fill_tracking_info(struct strbuf
*stat
, const char *branch_name
,
310 int show_upstream_ref
)
313 struct branch
*branch
= branch_get(branch_name
);
315 if (!stat_tracking_info(branch
, &ours
, &theirs
)) {
316 if (branch
&& branch
->merge
&& branch
->merge
[0]->dst
&&
318 strbuf_addf(stat
, "[%s] ",
319 shorten_unambiguous_ref(branch
->merge
[0]->dst
, 0));
323 strbuf_addch(stat
, '[');
324 if (show_upstream_ref
)
325 strbuf_addf(stat
, "%s: ",
326 shorten_unambiguous_ref(branch
->merge
[0]->dst
, 0));
328 strbuf_addf(stat
, "behind %d] ", theirs
);
330 strbuf_addf(stat
, "ahead %d] ", ours
);
332 strbuf_addf(stat
, "ahead %d, behind %d] ", ours
, theirs
);
335 static int matches_merge_filter(struct commit
*commit
)
339 if (merge_filter
== NO_FILTER
)
342 is_merged
= !!(commit
->object
.flags
& UNINTERESTING
);
343 return (is_merged
== (merge_filter
== SHOW_MERGED
));
346 static void print_ref_item(struct ref_item
*item
, int maxwidth
, int verbose
,
347 int abbrev
, int current
, char *prefix
)
351 struct commit
*commit
= item
->commit
;
352 struct strbuf out
= STRBUF_INIT
, name
= STRBUF_INIT
;
354 if (!matches_merge_filter(commit
))
357 switch (item
->kind
) {
358 case REF_LOCAL_BRANCH
:
359 color
= BRANCH_COLOR_LOCAL
;
361 case REF_REMOTE_BRANCH
:
362 color
= BRANCH_COLOR_REMOTE
;
365 color
= BRANCH_COLOR_PLAIN
;
372 color
= BRANCH_COLOR_CURRENT
;
375 strbuf_addf(&name
, "%s%s", prefix
, item
->name
);
377 strbuf_addf(&out
, "%c %s%-*s%s", c
, branch_get_color(color
),
379 branch_get_color(BRANCH_COLOR_RESET
));
381 strbuf_addf(&out
, "%c %s%s%s", c
, branch_get_color(color
),
382 name
.buf
, branch_get_color(BRANCH_COLOR_RESET
));
385 strbuf_addf(&out
, " -> %s", item
->dest
);
387 struct strbuf subject
= STRBUF_INIT
, stat
= STRBUF_INIT
;
388 const char *sub
= " **** invalid ref ****";
390 commit
= item
->commit
;
391 if (commit
&& !parse_commit(commit
)) {
392 struct pretty_print_context ctx
= {0};
393 pretty_print_commit(CMIT_FMT_ONELINE
, commit
,
398 if (item
->kind
== REF_LOCAL_BRANCH
)
399 fill_tracking_info(&stat
, item
->name
, verbose
> 1);
401 strbuf_addf(&out
, " %s %s%s",
402 find_unique_abbrev(item
->commit
->object
.sha1
, abbrev
),
404 strbuf_release(&stat
);
405 strbuf_release(&subject
);
407 printf("%s\n", out
.buf
);
408 strbuf_release(&name
);
409 strbuf_release(&out
);
412 static int calc_maxwidth(struct ref_list
*refs
)
415 for (i
= 0; i
< refs
->index
; i
++) {
416 if (!matches_merge_filter(refs
->list
[i
].commit
))
418 if (refs
->list
[i
].len
> w
)
419 w
= refs
->list
[i
].len
;
425 static void show_detached(struct ref_list
*ref_list
)
427 struct commit
*head_commit
= lookup_commit_reference_gently(head_sha1
, 1);
429 if (head_commit
&& is_descendant_of(head_commit
, ref_list
->with_commit
)) {
430 struct ref_item item
;
431 item
.name
= xstrdup("(no branch)");
432 item
.len
= strlen(item
.name
);
433 item
.kind
= REF_LOCAL_BRANCH
;
435 item
.commit
= head_commit
;
436 if (item
.len
> ref_list
->maxwidth
)
437 ref_list
->maxwidth
= item
.len
;
438 print_ref_item(&item
, ref_list
->maxwidth
, ref_list
->verbose
, ref_list
->abbrev
, 1, "");
443 static void print_ref_list(int kinds
, int detached
, int verbose
, int abbrev
, struct commit_list
*with_commit
)
446 struct ref_list ref_list
;
448 memset(&ref_list
, 0, sizeof(ref_list
));
449 ref_list
.kinds
= kinds
;
450 ref_list
.verbose
= verbose
;
451 ref_list
.abbrev
= abbrev
;
452 ref_list
.with_commit
= with_commit
;
453 if (merge_filter
!= NO_FILTER
)
454 init_revisions(&ref_list
.revs
, NULL
);
455 for_each_rawref(append_ref
, &ref_list
);
456 if (merge_filter
!= NO_FILTER
) {
457 struct commit
*filter
;
458 filter
= lookup_commit_reference_gently(merge_filter_ref
, 0);
459 filter
->object
.flags
|= UNINTERESTING
;
460 add_pending_object(&ref_list
.revs
,
461 (struct object
*) filter
, "");
462 ref_list
.revs
.limited
= 1;
463 prepare_revision_walk(&ref_list
.revs
);
465 ref_list
.maxwidth
= calc_maxwidth(&ref_list
);
468 qsort(ref_list
.list
, ref_list
.index
, sizeof(struct ref_item
), ref_cmp
);
470 detached
= (detached
&& (kinds
& REF_LOCAL_BRANCH
));
472 show_detached(&ref_list
);
474 for (i
= 0; i
< ref_list
.index
; i
++) {
475 int current
= !detached
&&
476 (ref_list
.list
[i
].kind
== REF_LOCAL_BRANCH
) &&
477 !strcmp(ref_list
.list
[i
].name
, head
);
478 char *prefix
= (kinds
!= REF_REMOTE_BRANCH
&&
479 ref_list
.list
[i
].kind
== REF_REMOTE_BRANCH
)
481 print_ref_item(&ref_list
.list
[i
], ref_list
.maxwidth
, verbose
,
482 abbrev
, current
, prefix
);
485 free_ref_list(&ref_list
);
488 static void rename_branch(const char *oldname
, const char *newname
, int force
)
490 struct strbuf oldref
= STRBUF_INIT
, newref
= STRBUF_INIT
, logmsg
= STRBUF_INIT
;
491 unsigned char sha1
[20];
492 struct strbuf oldsection
= STRBUF_INIT
, newsection
= STRBUF_INIT
;
496 die("cannot rename the current branch while not on any.");
498 if (strbuf_check_branch_ref(&oldref
, oldname
)) {
500 * Bad name --- this could be an attempt to rename a
501 * ref that we used to allow to be created by accident.
503 if (resolve_ref(oldref
.buf
, sha1
, 1, NULL
))
506 die("Invalid branch name: '%s'", oldname
);
509 if (strbuf_check_branch_ref(&newref
, newname
))
510 die("Invalid branch name: '%s'", newname
);
512 if (resolve_ref(newref
.buf
, sha1
, 1, NULL
) && !force
)
513 die("A branch named '%s' already exists.", newref
.buf
+ 11);
515 strbuf_addf(&logmsg
, "Branch: renamed %s to %s",
516 oldref
.buf
, newref
.buf
);
518 if (rename_ref(oldref
.buf
, newref
.buf
, logmsg
.buf
))
519 die("Branch rename failed");
520 strbuf_release(&logmsg
);
523 warning("Renamed a misnamed branch '%s' away", oldref
.buf
+ 11);
525 /* no need to pass logmsg here as HEAD didn't really move */
526 if (!strcmp(oldname
, head
) && create_symref("HEAD", newref
.buf
, NULL
))
527 die("Branch renamed to %s, but HEAD is not updated!", newname
);
529 strbuf_addf(&oldsection
, "branch.%s", oldref
.buf
+ 11);
530 strbuf_release(&oldref
);
531 strbuf_addf(&newsection
, "branch.%s", newref
.buf
+ 11);
532 strbuf_release(&newref
);
533 if (git_config_rename_section(oldsection
.buf
, newsection
.buf
) < 0)
534 die("Branch is renamed, but update of config-file failed");
535 strbuf_release(&oldsection
);
536 strbuf_release(&newsection
);
539 static int opt_parse_merge_filter(const struct option
*opt
, const char *arg
, int unset
)
541 merge_filter
= ((opt
->long_name
[0] == 'n')
545 merge_filter
= SHOW_NOT_MERGED
; /* b/c for --no-merged */
548 if (get_sha1(arg
, merge_filter_ref
))
549 die("malformed object name %s", arg
);
553 int cmd_branch(int argc
, const char **argv
, const char *prefix
)
555 int delete = 0, rename
= 0, force_create
= 0;
556 int verbose
= 0, abbrev
= DEFAULT_ABBREV
, detached
= 0;
558 enum branch_track track
;
559 int kinds
= REF_LOCAL_BRANCH
;
560 struct commit_list
*with_commit
= NULL
;
562 struct option options
[] = {
563 OPT_GROUP("Generic options"),
564 OPT__VERBOSE(&verbose
),
565 OPT_SET_INT('t', "track", &track
, "set up tracking mode (see git-pull(1))",
566 BRANCH_TRACK_EXPLICIT
),
567 OPT_BOOLEAN( 0 , "color", &branch_use_color
, "use colored output"),
568 OPT_SET_INT('r', NULL
, &kinds
, "act on remote-tracking branches",
571 OPTION_CALLBACK
, 0, "contains", &with_commit
, "commit",
572 "print only branches that contain the commit",
573 PARSE_OPT_LASTARG_DEFAULT
,
574 parse_opt_with_commit
, (intptr_t)"HEAD",
577 OPTION_CALLBACK
, 0, "with", &with_commit
, "commit",
578 "print only branches that contain the commit",
579 PARSE_OPT_HIDDEN
| PARSE_OPT_LASTARG_DEFAULT
,
580 parse_opt_with_commit
, (intptr_t) "HEAD",
582 OPT__ABBREV(&abbrev
),
584 OPT_GROUP("Specific git-branch actions:"),
585 OPT_SET_INT('a', NULL
, &kinds
, "list both remote-tracking and local branches",
586 REF_REMOTE_BRANCH
| REF_LOCAL_BRANCH
),
587 OPT_BIT('d', NULL
, &delete, "delete fully merged branch", 1),
588 OPT_BIT('D', NULL
, &delete, "delete branch (even if not merged)", 2),
589 OPT_BIT('m', NULL
, &rename
, "move/rename a branch and its reflog", 1),
590 OPT_BIT('M', NULL
, &rename
, "move/rename a branch, even if target exists", 2),
591 OPT_BOOLEAN('l', NULL
, &reflog
, "create the branch's reflog"),
592 OPT_BOOLEAN('f', "force", &force_create
, "force creation (when already exists)"),
594 OPTION_CALLBACK
, 0, "no-merged", &merge_filter_ref
,
595 "commit", "print only not merged branches",
596 PARSE_OPT_LASTARG_DEFAULT
| PARSE_OPT_NONEG
,
597 opt_parse_merge_filter
, (intptr_t) "HEAD",
600 OPTION_CALLBACK
, 0, "merged", &merge_filter_ref
,
601 "commit", "print only merged branches",
602 PARSE_OPT_LASTARG_DEFAULT
| PARSE_OPT_NONEG
,
603 opt_parse_merge_filter
, (intptr_t) "HEAD",
608 git_config(git_branch_config
, NULL
);
610 if (branch_use_color
== -1)
611 branch_use_color
= git_use_color_default
;
613 track
= git_branch_track
;
615 head
= resolve_ref("HEAD", head_sha1
, 0, NULL
);
617 die("Failed to resolve HEAD as a valid ref.");
618 head
= xstrdup(head
);
619 if (!strcmp(head
, "HEAD")) {
622 if (prefixcmp(head
, "refs/heads/"))
623 die("HEAD not found below refs/heads!");
626 hashcpy(merge_filter_ref
, head_sha1
);
628 argc
= parse_options(argc
, argv
, prefix
, options
, builtin_branch_usage
,
630 if (!!delete + !!rename
+ !!force_create
> 1)
631 usage_with_options(builtin_branch_usage
, options
);
634 return delete_branches(argc
, argv
, delete > 1, kinds
);
636 print_ref_list(kinds
, detached
, verbose
, abbrev
, with_commit
);
637 else if (rename
&& (argc
== 1))
638 rename_branch(head
, argv
[0], rename
> 1);
639 else if (rename
&& (argc
== 2))
640 rename_branch(argv
[0], argv
[1], rename
> 1);
641 else if (argc
<= 2) {
642 if (kinds
!= REF_LOCAL_BRANCH
)
643 die("-a and -r options to 'git branch' do not make sense with a branch name");
644 create_branch(head
, argv
[0], (argc
== 2) ? argv
[1] : head
,
645 force_create
, reflog
, track
);
647 usage_with_options(builtin_branch_usage
, options
);