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