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
8 #include "cache.h"
9 #include "config.h"
10 #include "color.h"
11 #include "refs.h"
12 #include "commit.h"
13 #include "builtin.h"
14 #include "remote.h"
15 #include "parse-options.h"
16 #include "branch.h"
17 #include "diff.h"
18 #include "revision.h"
19 #include "string-list.h"
20 #include "column.h"
21 #include "utf8.h"
22 #include "wt-status.h"
23 #include "ref-filter.h"
24 #include "worktree.h"
25 #include "help.h"
26 #include "commit-reach.h"
27
28 static const char * const builtin_branch_usage[] = {
29 N_("git branch [<options>] [-r | -a] [--merged] [--no-merged]"),
30 N_("git branch [<options>] [-l] [-f] <branch-name> [<start-point>]"),
31 N_("git branch [<options>] [-r] (-d | -D) <branch-name>..."),
32 N_("git branch [<options>] (-m | -M) [<old-branch>] <new-branch>"),
33 N_("git branch [<options>] (-c | -C) [<old-branch>] <new-branch>"),
34 N_("git branch [<options>] [-r | -a] [--points-at]"),
35 N_("git branch [<options>] [-r | -a] [--format]"),
36 NULL
37 };
38
39 static const char *head;
40 static struct object_id head_oid;
41
42 static int branch_use_color = -1;
43 static char branch_colors[][COLOR_MAXLEN] = {
44 GIT_COLOR_RESET,
45 GIT_COLOR_NORMAL, /* PLAIN */
46 GIT_COLOR_RED, /* REMOTE */
47 GIT_COLOR_NORMAL, /* LOCAL */
48 GIT_COLOR_GREEN, /* CURRENT */
49 GIT_COLOR_BLUE, /* UPSTREAM */
50 GIT_COLOR_CYAN, /* WORKTREE */
51 };
52 enum color_branch {
53 BRANCH_COLOR_RESET = 0,
54 BRANCH_COLOR_PLAIN = 1,
55 BRANCH_COLOR_REMOTE = 2,
56 BRANCH_COLOR_LOCAL = 3,
57 BRANCH_COLOR_CURRENT = 4,
58 BRANCH_COLOR_UPSTREAM = 5,
59 BRANCH_COLOR_WORKTREE = 6
60 };
61
62 static const char *color_branch_slots[] = {
63 [BRANCH_COLOR_RESET] = "reset",
64 [BRANCH_COLOR_PLAIN] = "plain",
65 [BRANCH_COLOR_REMOTE] = "remote",
66 [BRANCH_COLOR_LOCAL] = "local",
67 [BRANCH_COLOR_CURRENT] = "current",
68 [BRANCH_COLOR_UPSTREAM] = "upstream",
69 [BRANCH_COLOR_WORKTREE] = "worktree",
70 };
71
72 static struct string_list output = STRING_LIST_INIT_DUP;
73 static unsigned int colopts;
74
75 define_list_config_array(color_branch_slots);
76
git_branch_config(const char * var,const char * value,void * cb)77 static int git_branch_config(const char *var, const char *value, void *cb)
78 {
79 const char *slot_name;
80 struct ref_sorting **sorting_tail = (struct ref_sorting **)cb;
81
82 if (!strcmp(var, "branch.sort")) {
83 if (!value)
84 return config_error_nonbool(var);
85 parse_ref_sorting(sorting_tail, value);
86 return 0;
87 }
88
89 if (starts_with(var, "column."))
90 return git_column_config(var, value, "branch", &colopts);
91 if (!strcmp(var, "color.branch")) {
92 branch_use_color = git_config_colorbool(var, value);
93 return 0;
94 }
95 if (skip_prefix(var, "color.branch.", &slot_name)) {
96 int slot = LOOKUP_CONFIG(color_branch_slots, slot_name);
97 if (slot < 0)
98 return 0;
99 if (!value)
100 return config_error_nonbool(var);
101 return color_parse(value, branch_colors[slot]);
102 }
103 return git_color_default_config(var, value, cb);
104 }
105
branch_get_color(enum color_branch ix)106 static const char *branch_get_color(enum color_branch ix)
107 {
108 if (want_color(branch_use_color))
109 return branch_colors[ix];
110 return "";
111 }
112
branch_merged(int kind,const char * name,struct commit * rev,struct commit * head_rev)113 static int branch_merged(int kind, const char *name,
114 struct commit *rev, struct commit *head_rev)
115 {
116 /*
117 * This checks whether the merge bases of branch and HEAD (or
118 * the other branch this branch builds upon) contains the
119 * branch, which means that the branch has already been merged
120 * safely to HEAD (or the other branch).
121 */
122 struct commit *reference_rev = NULL;
123 const char *reference_name = NULL;
124 void *reference_name_to_free = NULL;
125 int merged;
126
127 if (kind == FILTER_REFS_BRANCHES) {
128 struct branch *branch = branch_get(name);
129 const char *upstream = branch_get_upstream(branch, NULL);
130 struct object_id oid;
131
132 if (upstream &&
133 (reference_name = reference_name_to_free =
134 resolve_refdup(upstream, RESOLVE_REF_READING,
135 &oid, NULL)) != NULL)
136 reference_rev = lookup_commit_reference(the_repository,
137 &oid);
138 }
139 if (!reference_rev)
140 reference_rev = head_rev;
141
142 merged = in_merge_bases(rev, reference_rev);
143
144 /*
145 * After the safety valve is fully redefined to "check with
146 * upstream, if any, otherwise with HEAD", we should just
147 * return the result of the in_merge_bases() above without
148 * any of the following code, but during the transition period,
149 * a gentle reminder is in order.
150 */
151 if ((head_rev != reference_rev) &&
152 in_merge_bases(rev, head_rev) != merged) {
153 if (merged)
154 warning(_("deleting branch '%s' that has been merged to\n"
155 " '%s', but not yet merged to HEAD."),
156 name, reference_name);
157 else
158 warning(_("not deleting branch '%s' that is not yet merged to\n"
159 " '%s', even though it is merged to HEAD."),
160 name, reference_name);
161 }
162 free(reference_name_to_free);
163 return merged;
164 }
165
check_branch_commit(const char * branchname,const char * refname,const struct object_id * oid,struct commit * head_rev,int kinds,int force)166 static int check_branch_commit(const char *branchname, const char *refname,
167 const struct object_id *oid, struct commit *head_rev,
168 int kinds, int force)
169 {
170 struct commit *rev = lookup_commit_reference(the_repository, oid);
171 if (!force && !rev) {
172 error(_("Couldn't look up commit object for '%s'"), refname);
173 return -1;
174 }
175 if (!force && !branch_merged(kinds, branchname, rev, head_rev)) {
176 error(_("The branch '%s' is not fully merged.\n"
177 "If you are sure you want to delete it, "
178 "run 'git branch -D %s'."), branchname, branchname);
179 return -1;
180 }
181 return 0;
182 }
183
delete_branch_config(const char * branchname)184 static void delete_branch_config(const char *branchname)
185 {
186 struct strbuf buf = STRBUF_INIT;
187 strbuf_addf(&buf, "branch.%s", branchname);
188 if (git_config_rename_section(buf.buf, NULL) < 0)
189 warning(_("Update of config-file failed"));
190 strbuf_release(&buf);
191 }
192
delete_branches(int argc,const char ** argv,int force,int kinds,int quiet)193 static int delete_branches(int argc, const char **argv, int force, int kinds,
194 int quiet)
195 {
196 struct commit *head_rev = NULL;
197 struct object_id oid;
198 char *name = NULL;
199 const char *fmt;
200 int i;
201 int ret = 0;
202 int remote_branch = 0;
203 struct strbuf bname = STRBUF_INIT;
204 unsigned allowed_interpret;
205 struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
206 struct string_list_item *item;
207 int branch_name_pos;
208
209 switch (kinds) {
210 case FILTER_REFS_REMOTES:
211 fmt = "refs/remotes/%s";
212 /* For subsequent UI messages */
213 remote_branch = 1;
214 allowed_interpret = INTERPRET_BRANCH_REMOTE;
215
216 force = 1;
217 break;
218 case FILTER_REFS_BRANCHES:
219 fmt = "refs/heads/%s";
220 allowed_interpret = INTERPRET_BRANCH_LOCAL;
221 break;
222 default:
223 die(_("cannot use -a with -d"));
224 }
225 branch_name_pos = strcspn(fmt, "%");
226
227 if (!force) {
228 head_rev = lookup_commit_reference(the_repository, &head_oid);
229 if (!head_rev)
230 die(_("Couldn't look up commit object for HEAD"));
231 }
232 for (i = 0; i < argc; i++, strbuf_reset(&bname)) {
233 char *target = NULL;
234 int flags = 0;
235
236 strbuf_branchname(&bname, argv[i], allowed_interpret);
237 free(name);
238 name = mkpathdup(fmt, bname.buf);
239
240 if (kinds == FILTER_REFS_BRANCHES) {
241 const struct worktree *wt =
242 find_shared_symref("HEAD", name);
243 if (wt) {
244 error(_("Cannot delete branch '%s' "
245 "checked out at '%s'"),
246 bname.buf, wt->path);
247 ret = 1;
248 continue;
249 }
250 }
251
252 target = resolve_refdup(name,
253 RESOLVE_REF_READING
254 | RESOLVE_REF_NO_RECURSE
255 | RESOLVE_REF_ALLOW_BAD_NAME,
256 &oid, &flags);
257 if (!target) {
258 error(remote_branch
259 ? _("remote-tracking branch '%s' not found.")
260 : _("branch '%s' not found."), bname.buf);
261 ret = 1;
262 continue;
263 }
264
265 if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
266 check_branch_commit(bname.buf, name, &oid, head_rev, kinds,
267 force)) {
268 ret = 1;
269 goto next;
270 }
271
272 item = string_list_append(&refs_to_delete, name);
273 item->util = xstrdup((flags & REF_ISBROKEN) ? "broken"
274 : (flags & REF_ISSYMREF) ? target
275 : find_unique_abbrev(&oid, DEFAULT_ABBREV));
276
277 next:
278 free(target);
279 }
280
281 if (delete_refs(NULL, &refs_to_delete, REF_NO_DEREF))
282 ret = 1;
283
284 for_each_string_list_item(item, &refs_to_delete) {
285 char *describe_ref = item->util;
286 char *name = item->string;
287 if (!ref_exists(name)) {
288 char *refname = name + branch_name_pos;
289 if (!quiet)
290 printf(remote_branch
291 ? _("Deleted remote-tracking branch %s (was %s).\n")
292 : _("Deleted branch %s (was %s).\n"),
293 name + branch_name_pos, describe_ref);
294
295 delete_branch_config(refname);
296 }
297 free(describe_ref);
298 }
299 string_list_clear(&refs_to_delete, 0);
300
301 free(name);
302 strbuf_release(&bname);
303
304 return ret;
305 }
306
calc_maxwidth(struct ref_array * refs,int remote_bonus)307 static int calc_maxwidth(struct ref_array *refs, int remote_bonus)
308 {
309 int i, max = 0;
310 for (i = 0; i < refs->nr; i++) {
311 struct ref_array_item *it = refs->items[i];
312 const char *desc = it->refname;
313 int w;
314
315 skip_prefix(it->refname, "refs/heads/", &desc);
316 skip_prefix(it->refname, "refs/remotes/", &desc);
317 if (it->kind == FILTER_REFS_DETACHED_HEAD) {
318 char *head_desc = get_head_description();
319 w = utf8_strwidth(head_desc);
320 free(head_desc);
321 } else
322 w = utf8_strwidth(desc);
323
324 if (it->kind == FILTER_REFS_REMOTES)
325 w += remote_bonus;
326 if (w > max)
327 max = w;
328 }
329 return max;
330 }
331
quote_literal_for_format(const char * s)332 static const char *quote_literal_for_format(const char *s)
333 {
334 static struct strbuf buf = STRBUF_INIT;
335
336 strbuf_reset(&buf);
337 while (*s) {
338 const char *ep = strchrnul(s, '%');
339 if (s < ep)
340 strbuf_add(&buf, s, ep - s);
341 if (*ep == '%') {
342 strbuf_addstr(&buf, "%%");
343 s = ep + 1;
344 } else {
345 s = ep;
346 }
347 }
348 return buf.buf;
349 }
350
build_format(struct ref_filter * filter,int maxwidth,const char * remote_prefix)351 static char *build_format(struct ref_filter *filter, int maxwidth, const char *remote_prefix)
352 {
353 struct strbuf fmt = STRBUF_INIT;
354 struct strbuf local = STRBUF_INIT;
355 struct strbuf remote = STRBUF_INIT;
356
357 strbuf_addf(&local, "%%(if)%%(HEAD)%%(then)* %s%%(else)%%(if)%%(worktreepath)%%(then)+ %s%%(else) %s%%(end)%%(end)",
358 branch_get_color(BRANCH_COLOR_CURRENT),
359 branch_get_color(BRANCH_COLOR_WORKTREE),
360 branch_get_color(BRANCH_COLOR_LOCAL));
361 strbuf_addf(&remote, " %s",
362 branch_get_color(BRANCH_COLOR_REMOTE));
363
364 if (filter->verbose) {
365 struct strbuf obname = STRBUF_INIT;
366
367 if (filter->abbrev < 0)
368 strbuf_addf(&obname, "%%(objectname:short)");
369 else if (!filter->abbrev)
370 strbuf_addf(&obname, "%%(objectname)");
371 else
372 strbuf_addf(&obname, "%%(objectname:short=%d)", filter->abbrev);
373
374 strbuf_addf(&local, "%%(align:%d,left)%%(refname:lstrip=2)%%(end)", maxwidth);
375 strbuf_addstr(&local, branch_get_color(BRANCH_COLOR_RESET));
376 strbuf_addf(&local, " %s ", obname.buf);
377
378 if (filter->verbose > 1)
379 {
380 strbuf_addf(&local, "%%(if:notequals=*)%%(HEAD)%%(then)%%(if)%%(worktreepath)%%(then)(%s%%(worktreepath)%s) %%(end)%%(end)",
381 branch_get_color(BRANCH_COLOR_WORKTREE), branch_get_color(BRANCH_COLOR_RESET));
382 strbuf_addf(&local, "%%(if)%%(upstream)%%(then)[%s%%(upstream:short)%s%%(if)%%(upstream:track)"
383 "%%(then): %%(upstream:track,nobracket)%%(end)] %%(end)%%(contents:subject)",
384 branch_get_color(BRANCH_COLOR_UPSTREAM), branch_get_color(BRANCH_COLOR_RESET));
385 }
386 else
387 strbuf_addf(&local, "%%(if)%%(upstream:track)%%(then)%%(upstream:track) %%(end)%%(contents:subject)");
388
389 strbuf_addf(&remote, "%%(align:%d,left)%s%%(refname:lstrip=2)%%(end)%s"
390 "%%(if)%%(symref)%%(then) -> %%(symref:short)"
391 "%%(else) %s %%(contents:subject)%%(end)",
392 maxwidth, quote_literal_for_format(remote_prefix),
393 branch_get_color(BRANCH_COLOR_RESET), obname.buf);
394 strbuf_release(&obname);
395 } else {
396 strbuf_addf(&local, "%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
397 branch_get_color(BRANCH_COLOR_RESET));
398 strbuf_addf(&remote, "%s%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
399 quote_literal_for_format(remote_prefix),
400 branch_get_color(BRANCH_COLOR_RESET));
401 }
402
403 strbuf_addf(&fmt, "%%(if:notequals=refs/remotes)%%(refname:rstrip=-2)%%(then)%s%%(else)%s%%(end)", local.buf, remote.buf);
404
405 strbuf_release(&local);
406 strbuf_release(&remote);
407 return strbuf_detach(&fmt, NULL);
408 }
409
print_ref_list(struct ref_filter * filter,struct ref_sorting * sorting,struct ref_format * format,struct string_list * output)410 static void print_ref_list(struct ref_filter *filter, struct ref_sorting *sorting,
411 struct ref_format *format, struct string_list *output)
412 {
413 int i;
414 struct ref_array array;
415 struct strbuf out = STRBUF_INIT;
416 struct strbuf err = STRBUF_INIT;
417 int maxwidth = 0;
418 const char *remote_prefix = "";
419 char *to_free = NULL;
420
421 /*
422 * If we are listing more than just remote branches,
423 * then remote branches will have a "remotes/" prefix.
424 * We need to account for this in the width.
425 */
426 if (filter->kind != FILTER_REFS_REMOTES)
427 remote_prefix = "remotes/";
428
429 memset(&array, 0, sizeof(array));
430
431 filter_refs(&array, filter, filter->kind);
432
433 if (filter->verbose)
434 maxwidth = calc_maxwidth(&array, strlen(remote_prefix));
435
436 if (!format->format)
437 format->format = to_free = build_format(filter, maxwidth, remote_prefix);
438 format->use_color = branch_use_color;
439
440 if (verify_ref_format(format))
441 die(_("unable to parse format string"));
442
443 ref_array_sort(sorting, &array);
444
445 for (i = 0; i < array.nr; i++) {
446 strbuf_reset(&err);
447 strbuf_reset(&out);
448 if (format_ref_array_item(array.items[i], format, &out, &err))
449 die("%s", err.buf);
450 if (column_active(colopts)) {
451 assert(!filter->verbose && "--column and --verbose are incompatible");
452 /* format to a string_list to let print_columns() do its job */
453 string_list_append(output, out.buf);
454 } else {
455 fwrite(out.buf, 1, out.len, stdout);
456 putchar('\n');
457 }
458 }
459
460 strbuf_release(&err);
461 strbuf_release(&out);
462 ref_array_clear(&array);
463 free(to_free);
464 }
465
print_current_branch_name(void)466 static void print_current_branch_name(void)
467 {
468 int flags;
469 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
470 const char *shortname;
471 if (!refname)
472 die(_("could not resolve HEAD"));
473 else if (!(flags & REF_ISSYMREF))
474 return;
475 else if (skip_prefix(refname, "refs/heads/", &shortname))
476 puts(shortname);
477 else
478 die(_("HEAD (%s) points outside of refs/heads/"), refname);
479 }
480
reject_rebase_or_bisect_branch(const char * target)481 static void reject_rebase_or_bisect_branch(const char *target)
482 {
483 struct worktree **worktrees = get_worktrees();
484 int i;
485
486 for (i = 0; worktrees[i]; i++) {
487 struct worktree *wt = worktrees[i];
488
489 if (!wt->is_detached)
490 continue;
491
492 if (is_worktree_being_rebased(wt, target))
493 die(_("Branch %s is being rebased at %s"),
494 target, wt->path);
495
496 if (is_worktree_being_bisected(wt, target))
497 die(_("Branch %s is being bisected at %s"),
498 target, wt->path);
499 }
500
501 free_worktrees(worktrees);
502 }
503
copy_or_rename_branch(const char * oldname,const char * newname,int copy,int force)504 static void copy_or_rename_branch(const char *oldname, const char *newname, int copy, int force)
505 {
506 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
507 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
508 const char *interpreted_oldname = NULL;
509 const char *interpreted_newname = NULL;
510 int recovery = 0;
511
512 if (!oldname) {
513 if (copy)
514 die(_("cannot copy the current branch while not on any."));
515 else
516 die(_("cannot rename the current branch while not on any."));
517 }
518
519 if (strbuf_check_branch_ref(&oldref, oldname)) {
520 /*
521 * Bad name --- this could be an attempt to rename a
522 * ref that we used to allow to be created by accident.
523 */
524 if (ref_exists(oldref.buf))
525 recovery = 1;
526 else
527 die(_("Invalid branch name: '%s'"), oldname);
528 }
529
530 /*
531 * A command like "git branch -M currentbranch currentbranch" cannot
532 * cause the worktree to become inconsistent with HEAD, so allow it.
533 */
534 if (!strcmp(oldname, newname))
535 validate_branchname(newname, &newref);
536 else
537 validate_new_branchname(newname, &newref, force);
538
539 reject_rebase_or_bisect_branch(oldref.buf);
540
541 if (!skip_prefix(oldref.buf, "refs/heads/", &interpreted_oldname) ||
542 !skip_prefix(newref.buf, "refs/heads/", &interpreted_newname)) {
543 BUG("expected prefix missing for refs");
544 }
545
546 if (copy)
547 strbuf_addf(&logmsg, "Branch: copied %s to %s",
548 oldref.buf, newref.buf);
549 else
550 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
551 oldref.buf, newref.buf);
552
553 if (!copy &&
554 (!head || strcmp(oldname, head) || !is_null_oid(&head_oid)) &&
555 rename_ref(oldref.buf, newref.buf, logmsg.buf))
556 die(_("Branch rename failed"));
557 if (copy && copy_existing_ref(oldref.buf, newref.buf, logmsg.buf))
558 die(_("Branch copy failed"));
559
560 if (recovery) {
561 if (copy)
562 warning(_("Created a copy of a misnamed branch '%s'"),
563 interpreted_oldname);
564 else
565 warning(_("Renamed a misnamed branch '%s' away"),
566 interpreted_oldname);
567 }
568
569 if (!copy &&
570 replace_each_worktree_head_symref(oldref.buf, newref.buf, logmsg.buf))
571 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
572
573 strbuf_release(&logmsg);
574
575 strbuf_addf(&oldsection, "branch.%s", interpreted_oldname);
576 strbuf_release(&oldref);
577 strbuf_addf(&newsection, "branch.%s", interpreted_newname);
578 strbuf_release(&newref);
579 if (!copy && git_config_rename_section(oldsection.buf, newsection.buf) < 0)
580 die(_("Branch is renamed, but update of config-file failed"));
581 if (copy && strcmp(oldname, newname) && git_config_copy_section(oldsection.buf, newsection.buf) < 0)
582 die(_("Branch is copied, but update of config-file failed"));
583 strbuf_release(&oldsection);
584 strbuf_release(&newsection);
585 }
586
587 static GIT_PATH_FUNC(edit_description, "EDIT_DESCRIPTION")
588
edit_branch_description(const char * branch_name)589 static int edit_branch_description(const char *branch_name)
590 {
591 struct strbuf buf = STRBUF_INIT;
592 struct strbuf name = STRBUF_INIT;
593
594 read_branch_desc(&buf, branch_name);
595 if (!buf.len || buf.buf[buf.len-1] != '\n')
596 strbuf_addch(&buf, '\n');
597 strbuf_commented_addf(&buf,
598 _("Please edit the description for the branch\n"
599 " %s\n"
600 "Lines starting with '%c' will be stripped.\n"),
601 branch_name, comment_line_char);
602 write_file_buf(edit_description(), buf.buf, buf.len);
603 strbuf_reset(&buf);
604 if (launch_editor(edit_description(), &buf, NULL)) {
605 strbuf_release(&buf);
606 return -1;
607 }
608 strbuf_stripspace(&buf, 1);
609
610 strbuf_addf(&name, "branch.%s.description", branch_name);
611 git_config_set(name.buf, buf.len ? buf.buf : NULL);
612 strbuf_release(&name);
613 strbuf_release(&buf);
614
615 return 0;
616 }
617
cmd_branch(int argc,const char ** argv,const char * prefix)618 int cmd_branch(int argc, const char **argv, const char *prefix)
619 {
620 int delete = 0, rename = 0, copy = 0, force = 0, list = 0;
621 int show_current = 0;
622 int reflog = 0, edit_description = 0;
623 int quiet = 0, unset_upstream = 0;
624 const char *new_upstream = NULL;
625 enum branch_track track;
626 struct ref_filter filter;
627 int icase = 0;
628 static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
629 struct ref_format format = REF_FORMAT_INIT;
630
631 struct option options[] = {
632 OPT_GROUP(N_("Generic options")),
633 OPT__VERBOSE(&filter.verbose,
634 N_("show hash and subject, give twice for upstream branch")),
635 OPT__QUIET(&quiet, N_("suppress informational messages")),
636 OPT_SET_INT('t', "track", &track, N_("set up tracking mode (see git-pull(1))"),
637 BRANCH_TRACK_EXPLICIT),
638 OPT_SET_INT_F(0, "set-upstream", &track, N_("do not use"),
639 BRANCH_TRACK_OVERRIDE, PARSE_OPT_HIDDEN),
640 OPT_STRING('u', "set-upstream-to", &new_upstream, N_("upstream"), N_("change the upstream info")),
641 OPT_BOOL(0, "unset-upstream", &unset_upstream, N_("unset the upstream info")),
642 OPT__COLOR(&branch_use_color, N_("use colored output")),
643 OPT_SET_INT('r', "remotes", &filter.kind, N_("act on remote-tracking branches"),
644 FILTER_REFS_REMOTES),
645 OPT_CONTAINS(&filter.with_commit, N_("print only branches that contain the commit")),
646 OPT_NO_CONTAINS(&filter.no_commit, N_("print only branches that don't contain the commit")),
647 OPT_WITH(&filter.with_commit, N_("print only branches that contain the commit")),
648 OPT_WITHOUT(&filter.no_commit, N_("print only branches that don't contain the commit")),
649 OPT__ABBREV(&filter.abbrev),
650
651 OPT_GROUP(N_("Specific git-branch actions:")),
652 OPT_SET_INT('a', "all", &filter.kind, N_("list both remote-tracking and local branches"),
653 FILTER_REFS_REMOTES | FILTER_REFS_BRANCHES),
654 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
655 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
656 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
657 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
658 OPT_BIT('c', "copy", ©, N_("copy a branch and its reflog"), 1),
659 OPT_BIT('C', NULL, ©, N_("copy a branch, even if target exists"), 2),
660 OPT_BOOL('l', "list", &list, N_("list branch names")),
661 OPT_BOOL(0, "show-current", &show_current, N_("show current branch name")),
662 OPT_BOOL(0, "create-reflog", &reflog, N_("create the branch's reflog")),
663 OPT_BOOL(0, "edit-description", &edit_description,
664 N_("edit the description for the branch")),
665 OPT__FORCE(&force, N_("force creation, move/rename, deletion"), PARSE_OPT_NOCOMPLETE),
666 OPT_MERGED(&filter, N_("print only branches that are merged")),
667 OPT_NO_MERGED(&filter, N_("print only branches that are not merged")),
668 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
669 OPT_REF_SORT(sorting_tail),
670 OPT_CALLBACK(0, "points-at", &filter.points_at, N_("object"),
671 N_("print only branches of the object"), parse_opt_object_name),
672 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
673 OPT_STRING( 0 , "format", &format.format, N_("format"), N_("format to use for the output")),
674 OPT_END(),
675 };
676
677 setup_ref_filter_porcelain_msg();
678
679 memset(&filter, 0, sizeof(filter));
680 filter.kind = FILTER_REFS_BRANCHES;
681 filter.abbrev = -1;
682
683 if (argc == 2 && !strcmp(argv[1], "-h"))
684 usage_with_options(builtin_branch_usage, options);
685
686 git_config(git_branch_config, sorting_tail);
687
688 track = git_branch_track;
689
690 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
691 if (!head)
692 die(_("Failed to resolve HEAD as a valid ref."));
693 if (!strcmp(head, "HEAD"))
694 filter.detached = 1;
695 else if (!skip_prefix(head, "refs/heads/", &head))
696 die(_("HEAD not found below refs/heads!"));
697
698 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
699 0);
700
701 if (!delete && !rename && !copy && !edit_description && !new_upstream &&
702 !show_current && !unset_upstream && argc == 0)
703 list = 1;
704
705 if (filter.with_commit || filter.no_commit ||
706 filter.reachable_from || filter.unreachable_from || filter.points_at.nr)
707 list = 1;
708
709 if (!!delete + !!rename + !!copy + !!new_upstream + !!show_current +
710 list + edit_description + unset_upstream > 1)
711 usage_with_options(builtin_branch_usage, options);
712
713 if (filter.abbrev == -1)
714 filter.abbrev = DEFAULT_ABBREV;
715 filter.ignore_case = icase;
716
717 finalize_colopts(&colopts, -1);
718 if (filter.verbose) {
719 if (explicitly_enable_column(colopts))
720 die(_("--column and --verbose are incompatible"));
721 colopts = 0;
722 }
723
724 if (force) {
725 delete *= 2;
726 rename *= 2;
727 copy *= 2;
728 }
729
730 if (list)
731 setup_auto_pager("branch", 1);
732
733 if (delete) {
734 if (!argc)
735 die(_("branch name required"));
736 return delete_branches(argc, argv, delete > 1, filter.kind, quiet);
737 } else if (show_current) {
738 print_current_branch_name();
739 return 0;
740 } else if (list) {
741 /* git branch --list also shows HEAD when it is detached */
742 if ((filter.kind & FILTER_REFS_BRANCHES) && filter.detached)
743 filter.kind |= FILTER_REFS_DETACHED_HEAD;
744 filter.name_patterns = argv;
745 /*
746 * If no sorting parameter is given then we default to sorting
747 * by 'refname'. This would give us an alphabetically sorted
748 * array with the 'HEAD' ref at the beginning followed by
749 * local branches 'refs/heads/...' and finally remote-tracking
750 * branches 'refs/remotes/...'.
751 */
752 if (!sorting)
753 sorting = ref_default_sorting();
754 ref_sorting_set_sort_flags_all(sorting, REF_SORTING_ICASE, icase);
755 ref_sorting_set_sort_flags_all(
756 sorting, REF_SORTING_DETACHED_HEAD_FIRST, 1);
757 print_ref_list(&filter, sorting, &format, &output);
758 print_columns(&output, colopts, NULL);
759 string_list_clear(&output, 0);
760 ref_sorting_release(sorting);
761 return 0;
762 } else if (edit_description) {
763 const char *branch_name;
764 struct strbuf branch_ref = STRBUF_INIT;
765
766 if (!argc) {
767 if (filter.detached)
768 die(_("Cannot give description to detached HEAD"));
769 branch_name = head;
770 } else if (argc == 1)
771 branch_name = argv[0];
772 else
773 die(_("cannot edit description of more than one branch"));
774
775 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
776 if (!ref_exists(branch_ref.buf)) {
777 strbuf_release(&branch_ref);
778
779 if (!argc)
780 return error(_("No commit on branch '%s' yet."),
781 branch_name);
782 else
783 return error(_("No branch named '%s'."),
784 branch_name);
785 }
786 strbuf_release(&branch_ref);
787
788 if (edit_branch_description(branch_name))
789 return 1;
790 } else if (copy) {
791 if (!argc)
792 die(_("branch name required"));
793 else if (argc == 1)
794 copy_or_rename_branch(head, argv[0], 1, copy > 1);
795 else if (argc == 2)
796 copy_or_rename_branch(argv[0], argv[1], 1, copy > 1);
797 else
798 die(_("too many branches for a copy operation"));
799 } else if (rename) {
800 if (!argc)
801 die(_("branch name required"));
802 else if (argc == 1)
803 copy_or_rename_branch(head, argv[0], 0, rename > 1);
804 else if (argc == 2)
805 copy_or_rename_branch(argv[0], argv[1], 0, rename > 1);
806 else
807 die(_("too many arguments for a rename operation"));
808 } else if (new_upstream) {
809 struct branch *branch = branch_get(argv[0]);
810
811 if (argc > 1)
812 die(_("too many arguments to set new upstream"));
813
814 if (!branch) {
815 if (!argc || !strcmp(argv[0], "HEAD"))
816 die(_("could not set upstream of HEAD to %s when "
817 "it does not point to any branch."),
818 new_upstream);
819 die(_("no such branch '%s'"), argv[0]);
820 }
821
822 if (!ref_exists(branch->refname))
823 die(_("branch '%s' does not exist"), branch->name);
824
825 /*
826 * create_branch takes care of setting up the tracking
827 * info and making sure new_upstream is correct
828 */
829 create_branch(the_repository, branch->name, new_upstream,
830 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
831 } else if (unset_upstream) {
832 struct branch *branch = branch_get(argv[0]);
833 struct strbuf buf = STRBUF_INIT;
834
835 if (argc > 1)
836 die(_("too many arguments to unset upstream"));
837
838 if (!branch) {
839 if (!argc || !strcmp(argv[0], "HEAD"))
840 die(_("could not unset upstream of HEAD when "
841 "it does not point to any branch."));
842 die(_("no such branch '%s'"), argv[0]);
843 }
844
845 if (!branch_has_merge_config(branch))
846 die(_("Branch '%s' has no upstream information"), branch->name);
847
848 strbuf_addf(&buf, "branch.%s.remote", branch->name);
849 git_config_set_multivar(buf.buf, NULL, NULL, CONFIG_FLAGS_MULTI_REPLACE);
850 strbuf_reset(&buf);
851 strbuf_addf(&buf, "branch.%s.merge", branch->name);
852 git_config_set_multivar(buf.buf, NULL, NULL, CONFIG_FLAGS_MULTI_REPLACE);
853 strbuf_release(&buf);
854 } else if (argc > 0 && argc <= 2) {
855 if (filter.kind != FILTER_REFS_BRANCHES)
856 die(_("The -a, and -r, options to 'git branch' do not take a branch name.\n"
857 "Did you mean to use: -a|-r --list <pattern>?"));
858
859 if (track == BRANCH_TRACK_OVERRIDE)
860 die(_("the '--set-upstream' option is no longer supported. Please use '--track' or '--set-upstream-to' instead."));
861
862 create_branch(the_repository,
863 argv[0], (argc == 2) ? argv[1] : head,
864 force, 0, reflog, quiet, track);
865
866 } else
867 usage_with_options(builtin_branch_usage, options);
868
869 return 0;
870 }
871