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