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