Merge branch 'mt/dir-iterator-updates'
[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         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
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
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
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
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 (!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
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
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
206         switch (kinds) {
207         case FILTER_REFS_REMOTES:
208                 fmt = "refs/remotes/%s";
209                 /* For subsequent UI messages */
210                 remote_branch = 1;
211                 allowed_interpret = INTERPRET_BRANCH_REMOTE;
212
213                 force = 1;
214                 break;
215         case FILTER_REFS_BRANCHES:
216                 fmt = "refs/heads/%s";
217                 allowed_interpret = INTERPRET_BRANCH_LOCAL;
218                 break;
219         default:
220                 die(_("cannot use -a with -d"));
221         }
222
223         if (!force) {
224                 head_rev = lookup_commit_reference(the_repository, &head_oid);
225                 if (!head_rev)
226                         die(_("Couldn't look up commit object for HEAD"));
227         }
228         for (i = 0; i < argc; i++, strbuf_reset(&bname)) {
229                 char *target = NULL;
230                 int flags = 0;
231
232                 strbuf_branchname(&bname, argv[i], allowed_interpret);
233                 free(name);
234                 name = mkpathdup(fmt, bname.buf);
235
236                 if (kinds == FILTER_REFS_BRANCHES) {
237                         const struct worktree *wt =
238                                 find_shared_symref("HEAD", name);
239                         if (wt) {
240                                 error(_("Cannot delete branch '%s' "
241                                         "checked out at '%s'"),
242                                       bname.buf, wt->path);
243                                 ret = 1;
244                                 continue;
245                         }
246                 }
247
248                 target = resolve_refdup(name,
249                                         RESOLVE_REF_READING
250                                         | RESOLVE_REF_NO_RECURSE
251                                         | RESOLVE_REF_ALLOW_BAD_NAME,
252                                         &oid, &flags);
253                 if (!target) {
254                         error(remote_branch
255                               ? _("remote-tracking branch '%s' not found.")
256                               : _("branch '%s' not found."), bname.buf);
257                         ret = 1;
258                         continue;
259                 }
260
261                 if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
262                     check_branch_commit(bname.buf, name, &oid, head_rev, kinds,
263                                         force)) {
264                         ret = 1;
265                         goto next;
266                 }
267
268                 if (delete_ref(NULL, name, is_null_oid(&oid) ? NULL : &oid,
269                                REF_NO_DEREF)) {
270                         error(remote_branch
271                               ? _("Error deleting remote-tracking branch '%s'")
272                               : _("Error deleting branch '%s'"),
273                               bname.buf);
274                         ret = 1;
275                         goto next;
276                 }
277                 if (!quiet) {
278                         printf(remote_branch
279                                ? _("Deleted remote-tracking branch %s (was %s).\n")
280                                : _("Deleted branch %s (was %s).\n"),
281                                bname.buf,
282                                (flags & REF_ISBROKEN) ? "broken"
283                                : (flags & REF_ISSYMREF) ? target
284                                : find_unique_abbrev(&oid, DEFAULT_ABBREV));
285                 }
286                 delete_branch_config(bname.buf);
287
288         next:
289                 free(target);
290         }
291
292         free(name);
293         strbuf_release(&bname);
294
295         return ret;
296 }
297
298 static int calc_maxwidth(struct ref_array *refs, int remote_bonus)
299 {
300         int i, max = 0;
301         for (i = 0; i < refs->nr; i++) {
302                 struct ref_array_item *it = refs->items[i];
303                 const char *desc = it->refname;
304                 int w;
305
306                 skip_prefix(it->refname, "refs/heads/", &desc);
307                 skip_prefix(it->refname, "refs/remotes/", &desc);
308                 if (it->kind == FILTER_REFS_DETACHED_HEAD) {
309                         char *head_desc = get_head_description();
310                         w = utf8_strwidth(head_desc);
311                         free(head_desc);
312                 } else
313                         w = utf8_strwidth(desc);
314
315                 if (it->kind == FILTER_REFS_REMOTES)
316                         w += remote_bonus;
317                 if (w > max)
318                         max = w;
319         }
320         return max;
321 }
322
323 static const char *quote_literal_for_format(const char *s)
324 {
325         static struct strbuf buf = STRBUF_INIT;
326
327         strbuf_reset(&buf);
328         while (*s) {
329                 const char *ep = strchrnul(s, '%');
330                 if (s < ep)
331                         strbuf_add(&buf, s, ep - s);
332                 if (*ep == '%') {
333                         strbuf_addstr(&buf, "%%");
334                         s = ep + 1;
335                 } else {
336                         s = ep;
337                 }
338         }
339         return buf.buf;
340 }
341
342 static char *build_format(struct ref_filter *filter, int maxwidth, const char *remote_prefix)
343 {
344         struct strbuf fmt = STRBUF_INIT;
345         struct strbuf local = STRBUF_INIT;
346         struct strbuf remote = STRBUF_INIT;
347
348         strbuf_addf(&local, "%%(if)%%(HEAD)%%(then)* %s%%(else)%%(if)%%(worktreepath)%%(then)+ %s%%(else)  %s%%(end)%%(end)",
349                         branch_get_color(BRANCH_COLOR_CURRENT),
350                         branch_get_color(BRANCH_COLOR_WORKTREE),
351                         branch_get_color(BRANCH_COLOR_LOCAL));
352         strbuf_addf(&remote, "  %s",
353                     branch_get_color(BRANCH_COLOR_REMOTE));
354
355         if (filter->verbose) {
356                 struct strbuf obname = STRBUF_INIT;
357
358                 if (filter->abbrev < 0)
359                         strbuf_addf(&obname, "%%(objectname:short)");
360                 else if (!filter->abbrev)
361                         strbuf_addf(&obname, "%%(objectname)");
362                 else
363                         strbuf_addf(&obname, "%%(objectname:short=%d)", filter->abbrev);
364
365                 strbuf_addf(&local, "%%(align:%d,left)%%(refname:lstrip=2)%%(end)", maxwidth);
366                 strbuf_addstr(&local, branch_get_color(BRANCH_COLOR_RESET));
367                 strbuf_addf(&local, " %s ", obname.buf);
368
369                 if (filter->verbose > 1)
370                 {
371                         strbuf_addf(&local, "%%(if:notequals=*)%%(HEAD)%%(then)%%(if)%%(worktreepath)%%(then)(%s%%(worktreepath)%s) %%(end)%%(end)",
372                                     branch_get_color(BRANCH_COLOR_WORKTREE), branch_get_color(BRANCH_COLOR_RESET));
373                         strbuf_addf(&local, "%%(if)%%(upstream)%%(then)[%s%%(upstream:short)%s%%(if)%%(upstream:track)"
374                                     "%%(then): %%(upstream:track,nobracket)%%(end)] %%(end)%%(contents:subject)",
375                                     branch_get_color(BRANCH_COLOR_UPSTREAM), branch_get_color(BRANCH_COLOR_RESET));
376                 }
377                 else
378                         strbuf_addf(&local, "%%(if)%%(upstream:track)%%(then)%%(upstream:track) %%(end)%%(contents:subject)");
379
380                 strbuf_addf(&remote, "%%(align:%d,left)%s%%(refname:lstrip=2)%%(end)%s"
381                             "%%(if)%%(symref)%%(then) -> %%(symref:short)"
382                             "%%(else) %s %%(contents:subject)%%(end)",
383                             maxwidth, quote_literal_for_format(remote_prefix),
384                             branch_get_color(BRANCH_COLOR_RESET), obname.buf);
385                 strbuf_release(&obname);
386         } else {
387                 strbuf_addf(&local, "%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
388                             branch_get_color(BRANCH_COLOR_RESET));
389                 strbuf_addf(&remote, "%s%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
390                             quote_literal_for_format(remote_prefix),
391                             branch_get_color(BRANCH_COLOR_RESET));
392         }
393
394         strbuf_addf(&fmt, "%%(if:notequals=refs/remotes)%%(refname:rstrip=-2)%%(then)%s%%(else)%s%%(end)", local.buf, remote.buf);
395
396         strbuf_release(&local);
397         strbuf_release(&remote);
398         return strbuf_detach(&fmt, NULL);
399 }
400
401 static void print_ref_list(struct ref_filter *filter, struct ref_sorting *sorting, struct ref_format *format)
402 {
403         int i;
404         struct ref_array array;
405         int maxwidth = 0;
406         const char *remote_prefix = "";
407         char *to_free = NULL;
408
409         /*
410          * If we are listing more than just remote branches,
411          * then remote branches will have a "remotes/" prefix.
412          * We need to account for this in the width.
413          */
414         if (filter->kind != FILTER_REFS_REMOTES)
415                 remote_prefix = "remotes/";
416
417         memset(&array, 0, sizeof(array));
418
419         filter_refs(&array, filter, filter->kind | FILTER_REFS_INCLUDE_BROKEN);
420
421         if (filter->verbose)
422                 maxwidth = calc_maxwidth(&array, strlen(remote_prefix));
423
424         if (!format->format)
425                 format->format = to_free = build_format(filter, maxwidth, remote_prefix);
426         format->use_color = branch_use_color;
427
428         if (verify_ref_format(format))
429                 die(_("unable to parse format string"));
430
431         ref_array_sort(sorting, &array);
432
433         for (i = 0; i < array.nr; i++) {
434                 struct strbuf out = STRBUF_INIT;
435                 struct strbuf err = STRBUF_INIT;
436                 if (format_ref_array_item(array.items[i], format, &out, &err))
437                         die("%s", err.buf);
438                 if (column_active(colopts)) {
439                         assert(!filter->verbose && "--column and --verbose are incompatible");
440                          /* format to a string_list to let print_columns() do its job */
441                         string_list_append(&output, out.buf);
442                 } else {
443                         fwrite(out.buf, 1, out.len, stdout);
444                         putchar('\n');
445                 }
446                 strbuf_release(&err);
447                 strbuf_release(&out);
448         }
449
450         ref_array_clear(&array);
451         free(to_free);
452 }
453
454 static void print_current_branch_name(void)
455 {
456         int flags;
457         const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
458         const char *shortname;
459         if (!refname)
460                 die(_("could not resolve HEAD"));
461         else if (!(flags & REF_ISSYMREF))
462                 return;
463         else if (skip_prefix(refname, "refs/heads/", &shortname))
464                 puts(shortname);
465         else
466                 die(_("HEAD (%s) points outside of refs/heads/"), refname);
467 }
468
469 static void reject_rebase_or_bisect_branch(const char *target)
470 {
471         struct worktree **worktrees = get_worktrees(0);
472         int i;
473
474         for (i = 0; worktrees[i]; i++) {
475                 struct worktree *wt = worktrees[i];
476
477                 if (!wt->is_detached)
478                         continue;
479
480                 if (is_worktree_being_rebased(wt, target))
481                         die(_("Branch %s is being rebased at %s"),
482                             target, wt->path);
483
484                 if (is_worktree_being_bisected(wt, target))
485                         die(_("Branch %s is being bisected at %s"),
486                             target, wt->path);
487         }
488
489         free_worktrees(worktrees);
490 }
491
492 static void copy_or_rename_branch(const char *oldname, const char *newname, int copy, int force)
493 {
494         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
495         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
496         const char *interpreted_oldname = NULL;
497         const char *interpreted_newname = NULL;
498         int recovery = 0;
499
500         if (!oldname) {
501                 if (copy)
502                         die(_("cannot copy the current branch while not on any."));
503                 else
504                         die(_("cannot rename the current branch while not on any."));
505         }
506
507         if (strbuf_check_branch_ref(&oldref, oldname)) {
508                 /*
509                  * Bad name --- this could be an attempt to rename a
510                  * ref that we used to allow to be created by accident.
511                  */
512                 if (ref_exists(oldref.buf))
513                         recovery = 1;
514                 else
515                         die(_("Invalid branch name: '%s'"), oldname);
516         }
517
518         /*
519          * A command like "git branch -M currentbranch currentbranch" cannot
520          * cause the worktree to become inconsistent with HEAD, so allow it.
521          */
522         if (!strcmp(oldname, newname))
523                 validate_branchname(newname, &newref);
524         else
525                 validate_new_branchname(newname, &newref, force);
526
527         reject_rebase_or_bisect_branch(oldref.buf);
528
529         if (!skip_prefix(oldref.buf, "refs/heads/", &interpreted_oldname) ||
530             !skip_prefix(newref.buf, "refs/heads/", &interpreted_newname)) {
531                 BUG("expected prefix missing for refs");
532         }
533
534         if (copy)
535                 strbuf_addf(&logmsg, "Branch: copied %s to %s",
536                             oldref.buf, newref.buf);
537         else
538                 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
539                             oldref.buf, newref.buf);
540
541         if (!copy && rename_ref(oldref.buf, newref.buf, logmsg.buf))
542                 die(_("Branch rename failed"));
543         if (copy && copy_existing_ref(oldref.buf, newref.buf, logmsg.buf))
544                 die(_("Branch copy failed"));
545
546         if (recovery) {
547                 if (copy)
548                         warning(_("Created a copy of a misnamed branch '%s'"),
549                                 interpreted_oldname);
550                 else
551                         warning(_("Renamed a misnamed branch '%s' away"),
552                                 interpreted_oldname);
553         }
554
555         if (!copy &&
556             replace_each_worktree_head_symref(oldref.buf, newref.buf, logmsg.buf))
557                 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
558
559         strbuf_release(&logmsg);
560
561         strbuf_addf(&oldsection, "branch.%s", interpreted_oldname);
562         strbuf_release(&oldref);
563         strbuf_addf(&newsection, "branch.%s", interpreted_newname);
564         strbuf_release(&newref);
565         if (!copy && git_config_rename_section(oldsection.buf, newsection.buf) < 0)
566                 die(_("Branch is renamed, but update of config-file failed"));
567         if (copy && strcmp(oldname, newname) && git_config_copy_section(oldsection.buf, newsection.buf) < 0)
568                 die(_("Branch is copied, but update of config-file failed"));
569         strbuf_release(&oldsection);
570         strbuf_release(&newsection);
571 }
572
573 static GIT_PATH_FUNC(edit_description, "EDIT_DESCRIPTION")
574
575 static int edit_branch_description(const char *branch_name)
576 {
577         struct strbuf buf = STRBUF_INIT;
578         struct strbuf name = STRBUF_INIT;
579
580         read_branch_desc(&buf, branch_name);
581         if (!buf.len || buf.buf[buf.len-1] != '\n')
582                 strbuf_addch(&buf, '\n');
583         strbuf_commented_addf(&buf,
584                     _("Please edit the description for the branch\n"
585                       "  %s\n"
586                       "Lines starting with '%c' will be stripped.\n"),
587                     branch_name, comment_line_char);
588         write_file_buf(edit_description(), buf.buf, buf.len);
589         strbuf_reset(&buf);
590         if (launch_editor(edit_description(), &buf, NULL)) {
591                 strbuf_release(&buf);
592                 return -1;
593         }
594         strbuf_stripspace(&buf, 1);
595
596         strbuf_addf(&name, "branch.%s.description", branch_name);
597         git_config_set(name.buf, buf.len ? buf.buf : NULL);
598         strbuf_release(&name);
599         strbuf_release(&buf);
600
601         return 0;
602 }
603
604 int cmd_branch(int argc, const char **argv, const char *prefix)
605 {
606         int delete = 0, rename = 0, copy = 0, force = 0, list = 0;
607         int show_current = 0;
608         int reflog = 0, edit_description = 0;
609         int quiet = 0, unset_upstream = 0;
610         const char *new_upstream = NULL;
611         enum branch_track track;
612         struct ref_filter filter;
613         int icase = 0;
614         static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
615         struct ref_format format = REF_FORMAT_INIT;
616
617         struct option options[] = {
618                 OPT_GROUP(N_("Generic options")),
619                 OPT__VERBOSE(&filter.verbose,
620                         N_("show hash and subject, give twice for upstream branch")),
621                 OPT__QUIET(&quiet, N_("suppress informational messages")),
622                 OPT_SET_INT('t', "track",  &track, N_("set up tracking mode (see git-pull(1))"),
623                         BRANCH_TRACK_EXPLICIT),
624                 OPT_SET_INT_F(0, "set-upstream", &track, N_("do not use"),
625                         BRANCH_TRACK_OVERRIDE, PARSE_OPT_HIDDEN),
626                 OPT_STRING('u', "set-upstream-to", &new_upstream, N_("upstream"), N_("change the upstream info")),
627                 OPT_BOOL(0, "unset-upstream", &unset_upstream, N_("Unset the upstream info")),
628                 OPT__COLOR(&branch_use_color, N_("use colored output")),
629                 OPT_SET_INT('r', "remotes",     &filter.kind, N_("act on remote-tracking branches"),
630                         FILTER_REFS_REMOTES),
631                 OPT_CONTAINS(&filter.with_commit, N_("print only branches that contain the commit")),
632                 OPT_NO_CONTAINS(&filter.no_commit, N_("print only branches that don't contain the commit")),
633                 OPT_WITH(&filter.with_commit, N_("print only branches that contain the commit")),
634                 OPT_WITHOUT(&filter.no_commit, N_("print only branches that don't contain the commit")),
635                 OPT__ABBREV(&filter.abbrev),
636
637                 OPT_GROUP(N_("Specific git-branch actions:")),
638                 OPT_SET_INT('a', "all", &filter.kind, N_("list both remote-tracking and local branches"),
639                         FILTER_REFS_REMOTES | FILTER_REFS_BRANCHES),
640                 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
641                 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
642                 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
643                 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
644                 OPT_BIT('c', "copy", &copy, N_("copy a branch and its reflog"), 1),
645                 OPT_BIT('C', NULL, &copy, N_("copy a branch, even if target exists"), 2),
646                 OPT_BOOL('l', "list", &list, N_("list branch names")),
647                 OPT_BOOL(0, "show-current", &show_current, N_("show current branch name")),
648                 OPT_BOOL(0, "create-reflog", &reflog, N_("create the branch's reflog")),
649                 OPT_BOOL(0, "edit-description", &edit_description,
650                          N_("edit the description for the branch")),
651                 OPT__FORCE(&force, N_("force creation, move/rename, deletion"), PARSE_OPT_NOCOMPLETE),
652                 OPT_MERGED(&filter, N_("print only branches that are merged")),
653                 OPT_NO_MERGED(&filter, N_("print only branches that are not merged")),
654                 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
655                 OPT_REF_SORT(sorting_tail),
656                 {
657                         OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
658                         N_("print only branches of the object"), 0, parse_opt_object_name
659                 },
660                 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
661                 OPT_STRING(  0 , "format", &format.format, N_("format"), N_("format to use for the output")),
662                 OPT_END(),
663         };
664
665         setup_ref_filter_porcelain_msg();
666
667         memset(&filter, 0, sizeof(filter));
668         filter.kind = FILTER_REFS_BRANCHES;
669         filter.abbrev = -1;
670
671         if (argc == 2 && !strcmp(argv[1], "-h"))
672                 usage_with_options(builtin_branch_usage, options);
673
674         git_config(git_branch_config, sorting_tail);
675
676         track = git_branch_track;
677
678         head = resolve_refdup("HEAD", 0, &head_oid, NULL);
679         if (!head)
680                 die(_("Failed to resolve HEAD as a valid ref."));
681         if (!strcmp(head, "HEAD"))
682                 filter.detached = 1;
683         else if (!skip_prefix(head, "refs/heads/", &head))
684                 die(_("HEAD not found below refs/heads!"));
685
686         argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
687                              0);
688
689         if (!delete && !rename && !copy && !edit_description && !new_upstream &&
690             !show_current && !unset_upstream && argc == 0)
691                 list = 1;
692
693         if (filter.with_commit || filter.merge != REF_FILTER_MERGED_NONE || filter.points_at.nr ||
694             filter.no_commit)
695                 list = 1;
696
697         if (!!delete + !!rename + !!copy + !!new_upstream + !!show_current +
698             list + unset_upstream > 1)
699                 usage_with_options(builtin_branch_usage, options);
700
701         if (filter.abbrev == -1)
702                 filter.abbrev = DEFAULT_ABBREV;
703         filter.ignore_case = icase;
704
705         finalize_colopts(&colopts, -1);
706         if (filter.verbose) {
707                 if (explicitly_enable_column(colopts))
708                         die(_("--column and --verbose are incompatible"));
709                 colopts = 0;
710         }
711
712         if (force) {
713                 delete *= 2;
714                 rename *= 2;
715                 copy *= 2;
716         }
717
718         if (list)
719                 setup_auto_pager("branch", 1);
720
721         if (delete) {
722                 if (!argc)
723                         die(_("branch name required"));
724                 return delete_branches(argc, argv, delete > 1, filter.kind, quiet);
725         } else if (show_current) {
726                 print_current_branch_name();
727                 return 0;
728         } else if (list) {
729                 /*  git branch --local also shows HEAD when it is detached */
730                 if ((filter.kind & FILTER_REFS_BRANCHES) && filter.detached)
731                         filter.kind |= FILTER_REFS_DETACHED_HEAD;
732                 filter.name_patterns = argv;
733                 /*
734                  * If no sorting parameter is given then we default to sorting
735                  * by 'refname'. This would give us an alphabetically sorted
736                  * array with the 'HEAD' ref at the beginning followed by
737                  * local branches 'refs/heads/...' and finally remote-tracking
738                  * branches 'refs/remotes/...'.
739                  */
740                 if (!sorting)
741                         sorting = ref_default_sorting();
742                 sorting->ignore_case = icase;
743                 print_ref_list(&filter, sorting, &format);
744                 print_columns(&output, colopts, NULL);
745                 string_list_clear(&output, 0);
746                 return 0;
747         } else if (edit_description) {
748                 const char *branch_name;
749                 struct strbuf branch_ref = STRBUF_INIT;
750
751                 if (!argc) {
752                         if (filter.detached)
753                                 die(_("Cannot give description to detached HEAD"));
754                         branch_name = head;
755                 } else if (argc == 1)
756                         branch_name = argv[0];
757                 else
758                         die(_("cannot edit description of more than one branch"));
759
760                 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
761                 if (!ref_exists(branch_ref.buf)) {
762                         strbuf_release(&branch_ref);
763
764                         if (!argc)
765                                 return error(_("No commit on branch '%s' yet."),
766                                              branch_name);
767                         else
768                                 return error(_("No branch named '%s'."),
769                                              branch_name);
770                 }
771                 strbuf_release(&branch_ref);
772
773                 if (edit_branch_description(branch_name))
774                         return 1;
775         } else if (copy) {
776                 if (!argc)
777                         die(_("branch name required"));
778                 else if (argc == 1)
779                         copy_or_rename_branch(head, argv[0], 1, copy > 1);
780                 else if (argc == 2)
781                         copy_or_rename_branch(argv[0], argv[1], 1, copy > 1);
782                 else
783                         die(_("too many branches for a copy operation"));
784         } else if (rename) {
785                 if (!argc)
786                         die(_("branch name required"));
787                 else if (argc == 1)
788                         copy_or_rename_branch(head, argv[0], 0, rename > 1);
789                 else if (argc == 2)
790                         copy_or_rename_branch(argv[0], argv[1], 0, rename > 1);
791                 else
792                         die(_("too many arguments for a rename operation"));
793         } else if (new_upstream) {
794                 struct branch *branch = branch_get(argv[0]);
795
796                 if (argc > 1)
797                         die(_("too many arguments to set new upstream"));
798
799                 if (!branch) {
800                         if (!argc || !strcmp(argv[0], "HEAD"))
801                                 die(_("could not set upstream of HEAD to %s when "
802                                       "it does not point to any branch."),
803                                     new_upstream);
804                         die(_("no such branch '%s'"), argv[0]);
805                 }
806
807                 if (!ref_exists(branch->refname))
808                         die(_("branch '%s' does not exist"), branch->name);
809
810                 /*
811                  * create_branch takes care of setting up the tracking
812                  * info and making sure new_upstream is correct
813                  */
814                 create_branch(the_repository, branch->name, new_upstream,
815                               0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
816         } else if (unset_upstream) {
817                 struct branch *branch = branch_get(argv[0]);
818                 struct strbuf buf = STRBUF_INIT;
819
820                 if (argc > 1)
821                         die(_("too many arguments to unset upstream"));
822
823                 if (!branch) {
824                         if (!argc || !strcmp(argv[0], "HEAD"))
825                                 die(_("could not unset upstream of HEAD when "
826                                       "it does not point to any branch."));
827                         die(_("no such branch '%s'"), argv[0]);
828                 }
829
830                 if (!branch_has_merge_config(branch))
831                         die(_("Branch '%s' has no upstream information"), branch->name);
832
833                 strbuf_addf(&buf, "branch.%s.remote", branch->name);
834                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
835                 strbuf_reset(&buf);
836                 strbuf_addf(&buf, "branch.%s.merge", branch->name);
837                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
838                 strbuf_release(&buf);
839         } else if (argc > 0 && argc <= 2) {
840                 if (filter.kind != FILTER_REFS_BRANCHES)
841                         die(_("The -a, and -r, options to 'git branch' do not take a branch name.\n"
842                                   "Did you mean to use: -a|-r --list <pattern>?"));
843
844                 if (track == BRANCH_TRACK_OVERRIDE)
845                         die(_("the '--set-upstream' option is no longer supported. Please use '--track' or '--set-upstream-to' instead."));
846
847                 create_branch(the_repository,
848                               argv[0], (argc == 2) ? argv[1] : head,
849                               force, 0, reflog, quiet, track);
850
851         } else
852                 usage_with_options(builtin_branch_usage, options);
853
854         return 0;
855 }