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