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