Merge branch 'ps/contains-id-error-message'
[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         struct strbuf out = STRBUF_INIT;
395         char *to_free = NULL;
396
397         /*
398          * If we are listing more than just remote branches,
399          * then remote branches will have a "remotes/" prefix.
400          * We need to account for this in the width.
401          */
402         if (filter->kind != FILTER_REFS_REMOTES)
403                 remote_prefix = "remotes/";
404
405         memset(&array, 0, sizeof(array));
406
407         filter_refs(&array, filter, filter->kind | FILTER_REFS_INCLUDE_BROKEN);
408
409         if (filter->verbose)
410                 maxwidth = calc_maxwidth(&array, strlen(remote_prefix));
411
412         if (!format->format)
413                 format->format = to_free = build_format(filter, maxwidth, remote_prefix);
414         format->use_color = branch_use_color;
415
416         if (verify_ref_format(format))
417                 die(_("unable to parse format string"));
418
419         ref_array_sort(sorting, &array);
420
421         for (i = 0; i < array.nr; i++) {
422                 format_ref_array_item(array.items[i], format, &out);
423                 if (column_active(colopts)) {
424                         assert(!filter->verbose && "--column and --verbose are incompatible");
425                          /* format to a string_list to let print_columns() do its job */
426                         string_list_append(&output, out.buf);
427                 } else {
428                         fwrite(out.buf, 1, out.len, stdout);
429                         putchar('\n');
430                 }
431                 strbuf_release(&out);
432         }
433
434         ref_array_clear(&array);
435         free(to_free);
436 }
437
438 static void reject_rebase_or_bisect_branch(const char *target)
439 {
440         struct worktree **worktrees = get_worktrees(0);
441         int i;
442
443         for (i = 0; worktrees[i]; i++) {
444                 struct worktree *wt = worktrees[i];
445
446                 if (!wt->is_detached)
447                         continue;
448
449                 if (is_worktree_being_rebased(wt, target))
450                         die(_("Branch %s is being rebased at %s"),
451                             target, wt->path);
452
453                 if (is_worktree_being_bisected(wt, target))
454                         die(_("Branch %s is being bisected at %s"),
455                             target, wt->path);
456         }
457
458         free_worktrees(worktrees);
459 }
460
461 static void copy_or_rename_branch(const char *oldname, const char *newname, int copy, int force)
462 {
463         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
464         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
465         const char *interpreted_oldname = NULL;
466         const char *interpreted_newname = NULL;
467         int recovery = 0;
468
469         if (!oldname) {
470                 if (copy)
471                         die(_("cannot copy the current branch while not on any."));
472                 else
473                         die(_("cannot rename the current branch while not on any."));
474         }
475
476         if (strbuf_check_branch_ref(&oldref, oldname)) {
477                 /*
478                  * Bad name --- this could be an attempt to rename a
479                  * ref that we used to allow to be created by accident.
480                  */
481                 if (ref_exists(oldref.buf))
482                         recovery = 1;
483                 else
484                         die(_("Invalid branch name: '%s'"), oldname);
485         }
486
487         /*
488          * A command like "git branch -M currentbranch currentbranch" cannot
489          * cause the worktree to become inconsistent with HEAD, so allow it.
490          */
491         if (!strcmp(oldname, newname))
492                 validate_branchname(newname, &newref);
493         else
494                 validate_new_branchname(newname, &newref, force);
495
496         reject_rebase_or_bisect_branch(oldref.buf);
497
498         if (!skip_prefix(oldref.buf, "refs/heads/", &interpreted_oldname) ||
499             !skip_prefix(newref.buf, "refs/heads/", &interpreted_newname)) {
500                 die("BUG: expected prefix missing for refs");
501         }
502
503         if (copy)
504                 strbuf_addf(&logmsg, "Branch: copied %s to %s",
505                             oldref.buf, newref.buf);
506         else
507                 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
508                             oldref.buf, newref.buf);
509
510         if (!copy && rename_ref(oldref.buf, newref.buf, logmsg.buf))
511                 die(_("Branch rename failed"));
512         if (copy && copy_existing_ref(oldref.buf, newref.buf, logmsg.buf))
513                 die(_("Branch copy failed"));
514
515         if (recovery) {
516                 if (copy)
517                         warning(_("Created a copy of a misnamed branch '%s'"),
518                                 interpreted_oldname);
519                 else
520                         warning(_("Renamed a misnamed branch '%s' away"),
521                                 interpreted_oldname);
522         }
523
524         if (!copy &&
525             replace_each_worktree_head_symref(oldref.buf, newref.buf, logmsg.buf))
526                 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
527
528         strbuf_release(&logmsg);
529
530         strbuf_addf(&oldsection, "branch.%s", interpreted_oldname);
531         strbuf_release(&oldref);
532         strbuf_addf(&newsection, "branch.%s", interpreted_newname);
533         strbuf_release(&newref);
534         if (!copy && git_config_rename_section(oldsection.buf, newsection.buf) < 0)
535                 die(_("Branch is renamed, but update of config-file failed"));
536         if (copy && strcmp(oldname, newname) && git_config_copy_section(oldsection.buf, newsection.buf) < 0)
537                 die(_("Branch is copied, but update of config-file failed"));
538         strbuf_release(&oldsection);
539         strbuf_release(&newsection);
540 }
541
542 static GIT_PATH_FUNC(edit_description, "EDIT_DESCRIPTION")
543
544 static int edit_branch_description(const char *branch_name)
545 {
546         struct strbuf buf = STRBUF_INIT;
547         struct strbuf name = STRBUF_INIT;
548
549         read_branch_desc(&buf, branch_name);
550         if (!buf.len || buf.buf[buf.len-1] != '\n')
551                 strbuf_addch(&buf, '\n');
552         strbuf_commented_addf(&buf,
553                     _("Please edit the description for the branch\n"
554                       "  %s\n"
555                       "Lines starting with '%c' will be stripped.\n"),
556                     branch_name, comment_line_char);
557         write_file_buf(edit_description(), buf.buf, buf.len);
558         strbuf_reset(&buf);
559         if (launch_editor(edit_description(), &buf, NULL)) {
560                 strbuf_release(&buf);
561                 return -1;
562         }
563         strbuf_stripspace(&buf, 1);
564
565         strbuf_addf(&name, "branch.%s.description", branch_name);
566         git_config_set(name.buf, buf.len ? buf.buf : NULL);
567         strbuf_release(&name);
568         strbuf_release(&buf);
569
570         return 0;
571 }
572
573 int cmd_branch(int argc, const char **argv, const char *prefix)
574 {
575         int delete = 0, rename = 0, copy = 0, force = 0, list = 0;
576         int reflog = 0, edit_description = 0;
577         int quiet = 0, unset_upstream = 0;
578         const char *new_upstream = NULL;
579         enum branch_track track;
580         struct ref_filter filter;
581         int icase = 0;
582         static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
583         struct ref_format format = REF_FORMAT_INIT;
584
585         struct option options[] = {
586                 OPT_GROUP(N_("Generic options")),
587                 OPT__VERBOSE(&filter.verbose,
588                         N_("show hash and subject, give twice for upstream branch")),
589                 OPT__QUIET(&quiet, N_("suppress informational messages")),
590                 OPT_SET_INT('t', "track",  &track, N_("set up tracking mode (see git-pull(1))"),
591                         BRANCH_TRACK_EXPLICIT),
592                 { OPTION_SET_INT, 0, "set-upstream", &track, NULL, N_("do not use"),
593                         PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, BRANCH_TRACK_OVERRIDE },
594                 OPT_STRING('u', "set-upstream-to", &new_upstream, N_("upstream"), N_("change the upstream info")),
595                 OPT_BOOL(0, "unset-upstream", &unset_upstream, N_("Unset the upstream info")),
596                 OPT__COLOR(&branch_use_color, N_("use colored output")),
597                 OPT_SET_INT('r', "remotes",     &filter.kind, N_("act on remote-tracking branches"),
598                         FILTER_REFS_REMOTES),
599                 OPT_CONTAINS(&filter.with_commit, N_("print only branches that contain the commit")),
600                 OPT_NO_CONTAINS(&filter.no_commit, N_("print only branches that don't contain the commit")),
601                 OPT_WITH(&filter.with_commit, N_("print only branches that contain the commit")),
602                 OPT_WITHOUT(&filter.no_commit, N_("print only branches that don't contain the commit")),
603                 OPT__ABBREV(&filter.abbrev),
604
605                 OPT_GROUP(N_("Specific git-branch actions:")),
606                 OPT_SET_INT('a', "all", &filter.kind, N_("list both remote-tracking and local branches"),
607                         FILTER_REFS_REMOTES | FILTER_REFS_BRANCHES),
608                 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
609                 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
610                 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
611                 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
612                 OPT_BIT('c', "copy", &copy, N_("copy a branch and its reflog"), 1),
613                 OPT_BIT('C', NULL, &copy, N_("copy a branch, even if target exists"), 2),
614                 OPT_BOOL(0, "list", &list, N_("list branch names")),
615                 OPT_BOOL('l', "create-reflog", &reflog, N_("create the branch's reflog")),
616                 OPT_BOOL(0, "edit-description", &edit_description,
617                          N_("edit the description for the branch")),
618                 OPT__FORCE(&force, N_("force creation, move/rename, deletion"), PARSE_OPT_NOCOMPLETE),
619                 OPT_MERGED(&filter, N_("print only branches that are merged")),
620                 OPT_NO_MERGED(&filter, N_("print only branches that are not merged")),
621                 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
622                 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
623                              N_("field name to sort on"), &parse_opt_ref_sorting),
624                 {
625                         OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
626                         N_("print only branches of the object"), 0, parse_opt_object_name
627                 },
628                 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
629                 OPT_STRING(  0 , "format", &format.format, N_("format"), N_("format to use for the output")),
630                 OPT_END(),
631         };
632
633         setup_ref_filter_porcelain_msg();
634
635         memset(&filter, 0, sizeof(filter));
636         filter.kind = FILTER_REFS_BRANCHES;
637         filter.abbrev = -1;
638
639         if (argc == 2 && !strcmp(argv[1], "-h"))
640                 usage_with_options(builtin_branch_usage, options);
641
642         git_config(git_branch_config, NULL);
643
644         track = git_branch_track;
645
646         head = resolve_refdup("HEAD", 0, &head_oid, NULL);
647         if (!head)
648                 die(_("Failed to resolve HEAD as a valid ref."));
649         if (!strcmp(head, "HEAD"))
650                 filter.detached = 1;
651         else if (!skip_prefix(head, "refs/heads/", &head))
652                 die(_("HEAD not found below refs/heads!"));
653
654         argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
655                              0);
656
657         if (!delete && !rename && !copy && !edit_description && !new_upstream && !unset_upstream && argc == 0)
658                 list = 1;
659
660         if (filter.with_commit || filter.merge != REF_FILTER_MERGED_NONE || filter.points_at.nr ||
661             filter.no_commit)
662                 list = 1;
663
664         if (!!delete + !!rename + !!copy + !!new_upstream +
665             list + unset_upstream > 1)
666                 usage_with_options(builtin_branch_usage, options);
667
668         if (filter.abbrev == -1)
669                 filter.abbrev = DEFAULT_ABBREV;
670         filter.ignore_case = icase;
671
672         finalize_colopts(&colopts, -1);
673         if (filter.verbose) {
674                 if (explicitly_enable_column(colopts))
675                         die(_("--column and --verbose are incompatible"));
676                 colopts = 0;
677         }
678
679         if (force) {
680                 delete *= 2;
681                 rename *= 2;
682                 copy *= 2;
683         }
684
685         if (list)
686                 setup_auto_pager("branch", 1);
687
688         if (delete) {
689                 if (!argc)
690                         die(_("branch name required"));
691                 return delete_branches(argc, argv, delete > 1, filter.kind, quiet);
692         } else if (list) {
693                 /*  git branch --local also shows HEAD when it is detached */
694                 if ((filter.kind & FILTER_REFS_BRANCHES) && filter.detached)
695                         filter.kind |= FILTER_REFS_DETACHED_HEAD;
696                 filter.name_patterns = argv;
697                 /*
698                  * If no sorting parameter is given then we default to sorting
699                  * by 'refname'. This would give us an alphabetically sorted
700                  * array with the 'HEAD' ref at the beginning followed by
701                  * local branches 'refs/heads/...' and finally remote-tacking
702                  * branches 'refs/remotes/...'.
703                  */
704                 if (!sorting)
705                         sorting = ref_default_sorting();
706                 sorting->ignore_case = icase;
707                 print_ref_list(&filter, sorting, &format);
708                 print_columns(&output, colopts, NULL);
709                 string_list_clear(&output, 0);
710                 return 0;
711         }
712         else if (edit_description) {
713                 const char *branch_name;
714                 struct strbuf branch_ref = STRBUF_INIT;
715
716                 if (!argc) {
717                         if (filter.detached)
718                                 die(_("Cannot give description to detached HEAD"));
719                         branch_name = head;
720                 } else if (argc == 1)
721                         branch_name = argv[0];
722                 else
723                         die(_("cannot edit description of more than one branch"));
724
725                 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
726                 if (!ref_exists(branch_ref.buf)) {
727                         strbuf_release(&branch_ref);
728
729                         if (!argc)
730                                 return error(_("No commit on branch '%s' yet."),
731                                              branch_name);
732                         else
733                                 return error(_("No branch named '%s'."),
734                                              branch_name);
735                 }
736                 strbuf_release(&branch_ref);
737
738                 if (edit_branch_description(branch_name))
739                         return 1;
740         } else if (copy) {
741                 if (!argc)
742                         die(_("branch name required"));
743                 else if (argc == 1)
744                         copy_or_rename_branch(head, argv[0], 1, copy > 1);
745                 else if (argc == 2)
746                         copy_or_rename_branch(argv[0], argv[1], 1, copy > 1);
747                 else
748                         die(_("too many branches for a copy operation"));
749         } else if (rename) {
750                 if (!argc)
751                         die(_("branch name required"));
752                 else if (argc == 1)
753                         copy_or_rename_branch(head, argv[0], 0, rename > 1);
754                 else if (argc == 2)
755                         copy_or_rename_branch(argv[0], argv[1], 0, rename > 1);
756                 else
757                         die(_("too many arguments for a rename operation"));
758         } else if (new_upstream) {
759                 struct branch *branch = branch_get(argv[0]);
760
761                 if (argc > 1)
762                         die(_("too many arguments to set new upstream"));
763
764                 if (!branch) {
765                         if (!argc || !strcmp(argv[0], "HEAD"))
766                                 die(_("could not set upstream of HEAD to %s when "
767                                       "it does not point to any branch."),
768                                     new_upstream);
769                         die(_("no such branch '%s'"), argv[0]);
770                 }
771
772                 if (!ref_exists(branch->refname))
773                         die(_("branch '%s' does not exist"), branch->name);
774
775                 /*
776                  * create_branch takes care of setting up the tracking
777                  * info and making sure new_upstream is correct
778                  */
779                 create_branch(branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
780         } else if (unset_upstream) {
781                 struct branch *branch = branch_get(argv[0]);
782                 struct strbuf buf = STRBUF_INIT;
783
784                 if (argc > 1)
785                         die(_("too many arguments to unset upstream"));
786
787                 if (!branch) {
788                         if (!argc || !strcmp(argv[0], "HEAD"))
789                                 die(_("could not unset upstream of HEAD when "
790                                       "it does not point to any branch."));
791                         die(_("no such branch '%s'"), argv[0]);
792                 }
793
794                 if (!branch_has_merge_config(branch))
795                         die(_("Branch '%s' has no upstream information"), branch->name);
796
797                 strbuf_addf(&buf, "branch.%s.remote", branch->name);
798                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
799                 strbuf_reset(&buf);
800                 strbuf_addf(&buf, "branch.%s.merge", branch->name);
801                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
802                 strbuf_release(&buf);
803         } else if (argc > 0 && argc <= 2) {
804                 struct branch *branch = branch_get(argv[0]);
805
806                 if (!branch)
807                         die(_("no such branch '%s'"), argv[0]);
808
809                 if (filter.kind != FILTER_REFS_BRANCHES)
810                         die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
811
812                 if (track == BRANCH_TRACK_OVERRIDE)
813                         die(_("the '--set-upstream' option is no longer supported. Please use '--track' or '--set-upstream-to' instead."));
814
815                 create_branch(argv[0], (argc == 2) ? argv[1] : head,
816                               force, 0, reflog, quiet, track);
817
818         } else
819                 usage_with_options(builtin_branch_usage, options);
820
821         return 0;
822 }