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
;
68 die("bad config variable '%s'", var
);
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);
80 return config_error_nonbool(var
);
81 color_parse(value
, var
, branch_colors
[slot
]);
84 return git_color_default_config(var
, value
, cb
);
87 static const char *branch_get_color(enum color_branch ix
)
89 if (branch_use_color
> 0)
90 return branch_colors
[ix
];
94 static int delete_branches(int argc
, const char **argv
, int force
, int kinds
)
96 struct commit
*rev
, *head_rev
= head_rev
;
97 unsigned char sha1
[20];
99 const char *fmt
, *remote
;
102 struct strbuf bname
= STRBUF_INIT
;
105 case REF_REMOTE_BRANCH
:
106 fmt
= "refs/remotes/%s";
110 case REF_LOCAL_BRANCH
:
111 fmt
= "refs/heads/%s";
115 die("cannot use -a with -d");
119 head_rev
= lookup_commit_reference(head_sha1
);
121 die("Couldn't look up commit object for HEAD");
123 for (i
= 0; i
< argc
; i
++, strbuf_release(&bname
)) {
124 strbuf_branchname(&bname
, argv
[i
]);
125 if (kinds
== REF_LOCAL_BRANCH
&& !strcmp(head
, bname
.buf
)) {
126 error("Cannot delete the branch '%s' "
127 "which you are currently on.", bname
.buf
);
134 name
= xstrdup(mkpath(fmt
, bname
.buf
));
135 if (!resolve_ref(name
, sha1
, 1, NULL
)) {
136 error("%sbranch '%s' not found.",
142 rev
= lookup_commit_reference(sha1
);
144 error("Couldn't look up commit object for '%s'", name
);
149 /* This checks whether the merge bases of branch and
150 * HEAD contains branch -- which means that the HEAD
151 * contains everything in both.
155 !in_merge_bases(rev
, &head_rev
, 1)) {
156 error("The branch '%s' is not an ancestor of "
157 "your current HEAD.\n"
158 "If you are sure you want to delete it, "
159 "run 'git branch -D %s'.", bname
.buf
, bname
.buf
);
164 if (delete_ref(name
, sha1
, 0)) {
165 error("Error deleting %sbranch '%s'", remote
,
169 struct strbuf buf
= STRBUF_INIT
;
170 printf("Deleted %sbranch %s (%s).\n", remote
,
172 find_unique_abbrev(sha1
, DEFAULT_ABBREV
));
173 strbuf_addf(&buf
, "branch.%s", bname
.buf
);
174 if (git_config_rename_section(buf
.buf
, NULL
) < 0)
175 warning("Update of config-file failed");
176 strbuf_release(&buf
);
188 unsigned int kind
, len
;
189 struct commit
*commit
;
193 struct rev_info revs
;
194 int index
, alloc
, maxwidth
;
195 struct ref_item
*list
;
196 struct commit_list
*with_commit
;
200 static char *resolve_symref(const char *src
, const char *prefix
)
202 unsigned char sha1
[20];
204 const char *dst
, *cp
;
206 dst
= resolve_ref(src
, sha1
, 0, &flag
);
207 if (!(dst
&& (flag
& REF_ISSYMREF
)))
209 if (prefix
&& (cp
= skip_prefix(dst
, prefix
)))
214 static int append_ref(const char *refname
, const unsigned char *sha1
, int flags
, void *cb_data
)
216 struct ref_list
*ref_list
= (struct ref_list
*)(cb_data
);
217 struct ref_item
*newitem
;
218 struct commit
*commit
;
220 const char *prefix
, *orig_refname
= refname
;
227 { REF_LOCAL_BRANCH
, "refs/heads/", 11 },
228 { REF_REMOTE_BRANCH
, "refs/remotes/", 13 },
232 for (i
= 0; i
< ARRAY_SIZE(ref_kind
); i
++) {
233 prefix
= ref_kind
[i
].prefix
;
234 if (strncmp(refname
, prefix
, ref_kind
[i
].pfxlen
))
236 kind
= ref_kind
[i
].kind
;
237 refname
+= ref_kind
[i
].pfxlen
;
240 if (ARRAY_SIZE(ref_kind
) <= i
)
243 commit
= lookup_commit_reference_gently(sha1
, 1);
245 return error("branch '%s' does not point at a commit", refname
);
247 /* Filter with with_commit if specified */
248 if (!is_descendant_of(commit
, ref_list
->with_commit
))
251 /* Don't add types the caller doesn't want */
252 if ((kind
& ref_list
->kinds
) == 0)
255 if (merge_filter
!= NO_FILTER
)
256 add_pending_object(&ref_list
->revs
,
257 (struct object
*)commit
, refname
);
260 if (ref_list
->index
>= ref_list
->alloc
) {
261 ref_list
->alloc
= alloc_nr(ref_list
->alloc
);
262 ref_list
->list
= xrealloc(ref_list
->list
,
263 ref_list
->alloc
* sizeof(struct ref_item
));
266 /* Record the new item */
267 newitem
= &(ref_list
->list
[ref_list
->index
++]);
268 newitem
->name
= xstrdup(refname
);
269 newitem
->kind
= kind
;
270 newitem
->commit
= commit
;
271 newitem
->len
= strlen(refname
);
272 newitem
->dest
= resolve_symref(orig_refname
, prefix
);
273 /* adjust for "remotes/" */
274 if (newitem
->kind
== REF_REMOTE_BRANCH
&&
275 ref_list
->kinds
!= REF_REMOTE_BRANCH
)
277 if (newitem
->len
> ref_list
->maxwidth
)
278 ref_list
->maxwidth
= newitem
->len
;
283 static void free_ref_list(struct ref_list
*ref_list
)
287 for (i
= 0; i
< ref_list
->index
; i
++) {
288 free(ref_list
->list
[i
].name
);
289 free(ref_list
->list
[i
].dest
);
291 free(ref_list
->list
);
294 static int ref_cmp(const void *r1
, const void *r2
)
296 struct ref_item
*c1
= (struct ref_item
*)(r1
);
297 struct ref_item
*c2
= (struct ref_item
*)(r2
);
299 if (c1
->kind
!= c2
->kind
)
300 return c1
->kind
- c2
->kind
;
301 return strcmp(c1
->name
, c2
->name
);
304 static void fill_tracking_info(struct strbuf
*stat
, const char *branch_name
)
307 struct branch
*branch
= branch_get(branch_name
);
309 if (!stat_tracking_info(branch
, &ours
, &theirs
) || (!ours
&& !theirs
))
312 strbuf_addf(stat
, "[behind %d] ", theirs
);
314 strbuf_addf(stat
, "[ahead %d] ", ours
);
316 strbuf_addf(stat
, "[ahead %d, behind %d] ", ours
, theirs
);
319 static int matches_merge_filter(struct commit
*commit
)
323 if (merge_filter
== NO_FILTER
)
326 is_merged
= !!(commit
->object
.flags
& UNINTERESTING
);
327 return (is_merged
== (merge_filter
== SHOW_MERGED
));
330 static void print_ref_item(struct ref_item
*item
, int maxwidth
, int verbose
,
331 int abbrev
, int current
, char *prefix
)
335 struct commit
*commit
= item
->commit
;
336 struct strbuf out
= STRBUF_INIT
, name
= STRBUF_INIT
;
338 if (!matches_merge_filter(commit
))
341 switch (item
->kind
) {
342 case REF_LOCAL_BRANCH
:
343 color
= BRANCH_COLOR_LOCAL
;
345 case REF_REMOTE_BRANCH
:
346 color
= BRANCH_COLOR_REMOTE
;
349 color
= BRANCH_COLOR_PLAIN
;
356 color
= BRANCH_COLOR_CURRENT
;
359 strbuf_addf(&name
, "%s%s", prefix
, item
->name
);
361 strbuf_addf(&out
, "%c %s%-*s%s", c
, branch_get_color(color
),
363 branch_get_color(BRANCH_COLOR_RESET
));
365 strbuf_addf(&out
, "%c %s%s%s", c
, branch_get_color(color
),
366 name
.buf
, branch_get_color(BRANCH_COLOR_RESET
));
369 strbuf_addf(&out
, " -> %s", item
->dest
);
371 struct strbuf subject
= STRBUF_INIT
, stat
= STRBUF_INIT
;
372 const char *sub
= " **** invalid ref ****";
374 commit
= item
->commit
;
375 if (commit
&& !parse_commit(commit
)) {
376 pretty_print_commit(CMIT_FMT_ONELINE
, commit
,
377 &subject
, 0, NULL
, NULL
, 0, 0);
381 if (item
->kind
== REF_LOCAL_BRANCH
)
382 fill_tracking_info(&stat
, item
->name
);
384 strbuf_addf(&out
, " %s %s%s",
385 find_unique_abbrev(item
->commit
->object
.sha1
, abbrev
),
387 strbuf_release(&stat
);
388 strbuf_release(&subject
);
390 printf("%s\n", out
.buf
);
391 strbuf_release(&name
);
392 strbuf_release(&out
);
395 static int calc_maxwidth(struct ref_list
*refs
)
398 for (i
= 0; i
< refs
->index
; i
++) {
399 if (!matches_merge_filter(refs
->list
[i
].commit
))
401 if (refs
->list
[i
].len
> w
)
402 w
= refs
->list
[i
].len
;
407 static void print_ref_list(int kinds
, int detached
, int verbose
, int abbrev
, struct commit_list
*with_commit
)
410 struct ref_list ref_list
;
411 struct commit
*head_commit
= lookup_commit_reference_gently(head_sha1
, 1);
413 memset(&ref_list
, 0, sizeof(ref_list
));
414 ref_list
.kinds
= kinds
;
415 ref_list
.with_commit
= with_commit
;
416 if (merge_filter
!= NO_FILTER
)
417 init_revisions(&ref_list
.revs
, NULL
);
418 for_each_ref(append_ref
, &ref_list
);
419 if (merge_filter
!= NO_FILTER
) {
420 struct commit
*filter
;
421 filter
= lookup_commit_reference_gently(merge_filter_ref
, 0);
422 filter
->object
.flags
|= UNINTERESTING
;
423 add_pending_object(&ref_list
.revs
,
424 (struct object
*) filter
, "");
425 ref_list
.revs
.limited
= 1;
426 prepare_revision_walk(&ref_list
.revs
);
428 ref_list
.maxwidth
= calc_maxwidth(&ref_list
);
431 qsort(ref_list
.list
, ref_list
.index
, sizeof(struct ref_item
), ref_cmp
);
433 detached
= (detached
&& (kinds
& REF_LOCAL_BRANCH
));
434 if (detached
&& head_commit
&&
435 is_descendant_of(head_commit
, with_commit
)) {
436 struct ref_item item
;
437 item
.name
= xstrdup("(no branch)");
438 item
.len
= strlen(item
.name
);
439 item
.kind
= REF_LOCAL_BRANCH
;
441 item
.commit
= head_commit
;
442 if (item
.len
> ref_list
.maxwidth
)
443 ref_list
.maxwidth
= item
.len
;
444 print_ref_item(&item
, ref_list
.maxwidth
, verbose
, abbrev
, 1, "");
448 for (i
= 0; i
< ref_list
.index
; i
++) {
449 int current
= !detached
&&
450 (ref_list
.list
[i
].kind
== REF_LOCAL_BRANCH
) &&
451 !strcmp(ref_list
.list
[i
].name
, head
);
452 char *prefix
= (kinds
!= REF_REMOTE_BRANCH
&&
453 ref_list
.list
[i
].kind
== REF_REMOTE_BRANCH
)
455 print_ref_item(&ref_list
.list
[i
], ref_list
.maxwidth
, verbose
,
456 abbrev
, current
, prefix
);
459 free_ref_list(&ref_list
);
462 static void rename_branch(const char *oldname
, const char *newname
, int force
)
464 struct strbuf oldref
= STRBUF_INIT
, newref
= STRBUF_INIT
, logmsg
= STRBUF_INIT
;
465 unsigned char sha1
[20];
466 struct strbuf oldsection
= STRBUF_INIT
, newsection
= STRBUF_INIT
;
469 die("cannot rename the current branch while not on any.");
471 strbuf_branchname(&oldref
, oldname
);
472 strbuf_splice(&oldref
, 0, 0, "refs/heads/", 11);
473 if (check_ref_format(oldref
.buf
))
474 die("Invalid branch name: '%s'", oldname
);
476 strbuf_branchname(&newref
, newname
);
477 strbuf_splice(&newref
, 0, 0, "refs/heads/", 11);
478 if (check_ref_format(newref
.buf
))
479 die("Invalid branch name: '%s'", newname
);
481 if (resolve_ref(newref
.buf
, sha1
, 1, NULL
) && !force
)
482 die("A branch named '%s' already exists.", newref
.buf
+ 11);
484 strbuf_addf(&logmsg
, "Branch: renamed %s to %s",
485 oldref
.buf
, newref
.buf
);
487 if (rename_ref(oldref
.buf
, newref
.buf
, logmsg
.buf
))
488 die("Branch rename failed");
489 strbuf_release(&logmsg
);
491 /* no need to pass logmsg here as HEAD didn't really move */
492 if (!strcmp(oldname
, head
) && create_symref("HEAD", newref
.buf
, NULL
))
493 die("Branch renamed to %s, but HEAD is not updated!", newname
);
495 strbuf_addf(&oldsection
, "branch.%s", oldref
.buf
+ 11);
496 strbuf_release(&oldref
);
497 strbuf_addf(&newsection
, "branch.%s", newref
.buf
+ 11);
498 strbuf_release(&newref
);
499 if (git_config_rename_section(oldsection
.buf
, newsection
.buf
) < 0)
500 die("Branch is renamed, but update of config-file failed");
501 strbuf_release(&oldsection
);
502 strbuf_release(&newsection
);
505 static int opt_parse_merge_filter(const struct option
*opt
, const char *arg
, int unset
)
507 merge_filter
= ((opt
->long_name
[0] == 'n')
511 merge_filter
= SHOW_NOT_MERGED
; /* b/c for --no-merged */
514 if (get_sha1(arg
, merge_filter_ref
))
515 die("malformed object name %s", arg
);
519 int cmd_branch(int argc
, const char **argv
, const char *prefix
)
521 int delete = 0, rename
= 0, force_create
= 0;
522 int verbose
= 0, abbrev
= DEFAULT_ABBREV
, detached
= 0;
524 enum branch_track track
;
525 int kinds
= REF_LOCAL_BRANCH
;
526 struct commit_list
*with_commit
= NULL
;
528 struct option options
[] = {
529 OPT_GROUP("Generic options"),
530 OPT__VERBOSE(&verbose
),
531 OPT_SET_INT( 0 , "track", &track
, "set up tracking mode (see git-pull(1))",
532 BRANCH_TRACK_EXPLICIT
),
533 OPT_BOOLEAN( 0 , "color", &branch_use_color
, "use colored output"),
534 OPT_SET_INT('r', NULL
, &kinds
, "act on remote-tracking branches",
537 OPTION_CALLBACK
, 0, "contains", &with_commit
, "commit",
538 "print only branches that contain the commit",
539 PARSE_OPT_LASTARG_DEFAULT
,
540 parse_opt_with_commit
, (intptr_t)"HEAD",
543 OPTION_CALLBACK
, 0, "with", &with_commit
, "commit",
544 "print only branches that contain the commit",
545 PARSE_OPT_HIDDEN
| PARSE_OPT_LASTARG_DEFAULT
,
546 parse_opt_with_commit
, (intptr_t) "HEAD",
548 OPT__ABBREV(&abbrev
),
550 OPT_GROUP("Specific git-branch actions:"),
551 OPT_SET_INT('a', NULL
, &kinds
, "list both remote-tracking and local branches",
552 REF_REMOTE_BRANCH
| REF_LOCAL_BRANCH
),
553 OPT_BIT('d', NULL
, &delete, "delete fully merged branch", 1),
554 OPT_BIT('D', NULL
, &delete, "delete branch (even if not merged)", 2),
555 OPT_BIT('m', NULL
, &rename
, "move/rename a branch and its reflog", 1),
556 OPT_BIT('M', NULL
, &rename
, "move/rename a branch, even if target exists", 2),
557 OPT_BOOLEAN('l', NULL
, &reflog
, "create the branch's reflog"),
558 OPT_BOOLEAN('f', NULL
, &force_create
, "force creation (when already exists)"),
560 OPTION_CALLBACK
, 0, "no-merged", &merge_filter_ref
,
561 "commit", "print only not merged branches",
562 PARSE_OPT_LASTARG_DEFAULT
| PARSE_OPT_NONEG
,
563 opt_parse_merge_filter
, (intptr_t) "HEAD",
566 OPTION_CALLBACK
, 0, "merged", &merge_filter_ref
,
567 "commit", "print only merged branches",
568 PARSE_OPT_LASTARG_DEFAULT
| PARSE_OPT_NONEG
,
569 opt_parse_merge_filter
, (intptr_t) "HEAD",
574 git_config(git_branch_config
, NULL
);
576 if (branch_use_color
== -1)
577 branch_use_color
= git_use_color_default
;
579 track
= git_branch_track
;
581 head
= resolve_ref("HEAD", head_sha1
, 0, NULL
);
583 die("Failed to resolve HEAD as a valid ref.");
584 head
= xstrdup(head
);
585 if (!strcmp(head
, "HEAD")) {
588 if (prefixcmp(head
, "refs/heads/"))
589 die("HEAD not found below refs/heads!");
592 hashcpy(merge_filter_ref
, head_sha1
);
594 argc
= parse_options(argc
, argv
, options
, builtin_branch_usage
, 0);
595 if (!!delete + !!rename
+ !!force_create
> 1)
596 usage_with_options(builtin_branch_usage
, options
);
599 return delete_branches(argc
, argv
, delete > 1, kinds
);
601 print_ref_list(kinds
, detached
, verbose
, abbrev
, with_commit
);
602 else if (rename
&& (argc
== 1))
603 rename_branch(head
, argv
[0], rename
> 1);
604 else if (rename
&& (argc
== 2))
605 rename_branch(argv
[0], argv
[1], rename
> 1);
607 create_branch(head
, argv
[0], (argc
== 2) ? argv
[1] : head
,
608 force_create
, reflog
, track
);
610 usage_with_options(builtin_branch_usage
, options
);