Merge branch 'jk/filter-branch-come-back-to-original'
[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
23 static const char * const builtin_branch_usage[] = {
24         N_("git branch [options] [-r | -a] [--merged | --no-merged]"),
25         N_("git branch [options] [-l] [-f] <branchname> [<start-point>]"),
26         N_("git branch [options] [-r] (-d | -D) <branchname>..."),
27         N_("git branch [options] (-m | -M) [<oldbranch>] <newbranch>"),
28         NULL
29 };
30
31 #define REF_LOCAL_BRANCH    0x01
32 #define REF_REMOTE_BRANCH   0x02
33
34 static const char *head;
35 static unsigned char head_sha1[20];
36
37 static int branch_use_color = -1;
38 static char branch_colors[][COLOR_MAXLEN] = {
39         GIT_COLOR_RESET,
40         GIT_COLOR_NORMAL,       /* PLAIN */
41         GIT_COLOR_RED,          /* REMOTE */
42         GIT_COLOR_NORMAL,       /* LOCAL */
43         GIT_COLOR_GREEN,        /* CURRENT */
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 };
52
53 static enum merge_filter {
54         NO_FILTER = 0,
55         SHOW_NOT_MERGED,
56         SHOW_MERGED
57 } merge_filter;
58 static unsigned char merge_filter_ref[20];
59
60 static struct string_list output = STRING_LIST_INIT_DUP;
61 static unsigned int colopts;
62
63 static int parse_branch_color_slot(const char *var, int ofs)
64 {
65         if (!strcasecmp(var+ofs, "plain"))
66                 return BRANCH_COLOR_PLAIN;
67         if (!strcasecmp(var+ofs, "reset"))
68                 return BRANCH_COLOR_RESET;
69         if (!strcasecmp(var+ofs, "remote"))
70                 return BRANCH_COLOR_REMOTE;
71         if (!strcasecmp(var+ofs, "local"))
72                 return BRANCH_COLOR_LOCAL;
73         if (!strcasecmp(var+ofs, "current"))
74                 return BRANCH_COLOR_CURRENT;
75         return -1;
76 }
77
78 static int git_branch_config(const char *var, const char *value, void *cb)
79 {
80         if (!prefixcmp(var, "column."))
81                 return git_column_config(var, value, "branch", &colopts);
82         if (!strcmp(var, "color.branch")) {
83                 branch_use_color = git_config_colorbool(var, value);
84                 return 0;
85         }
86         if (!prefixcmp(var, "color.branch.")) {
87                 int slot = parse_branch_color_slot(var, 13);
88                 if (slot < 0)
89                         return 0;
90                 if (!value)
91                         return config_error_nonbool(var);
92                 color_parse(value, var, branch_colors[slot]);
93                 return 0;
94         }
95         return git_color_default_config(var, value, cb);
96 }
97
98 static const char *branch_get_color(enum color_branch ix)
99 {
100         if (want_color(branch_use_color))
101                 return branch_colors[ix];
102         return "";
103 }
104
105 static int branch_merged(int kind, const char *name,
106                          struct commit *rev, struct commit *head_rev)
107 {
108         /*
109          * This checks whether the merge bases of branch and HEAD (or
110          * the other branch this branch builds upon) contains the
111          * branch, which means that the branch has already been merged
112          * safely to HEAD (or the other branch).
113          */
114         struct commit *reference_rev = NULL;
115         const char *reference_name = NULL;
116         void *reference_name_to_free = NULL;
117         int merged;
118
119         if (kind == REF_LOCAL_BRANCH) {
120                 struct branch *branch = branch_get(name);
121                 unsigned char sha1[20];
122
123                 if (branch &&
124                     branch->merge &&
125                     branch->merge[0] &&
126                     branch->merge[0]->dst &&
127                     (reference_name = reference_name_to_free =
128                      resolve_refdup(branch->merge[0]->dst, sha1, 1, NULL)) != NULL)
129                         reference_rev = lookup_commit_reference(sha1);
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                                unsigned char *sha1, struct commit *head_rev,
160                                int kinds, int force)
161 {
162         struct commit *rev = lookup_commit_reference(sha1);
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         unsigned char sha1[20];
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
197         switch (kinds) {
198         case REF_REMOTE_BRANCH:
199                 fmt = "refs/remotes/%s";
200                 /* For subsequent UI messages */
201                 remote_branch = 1;
202
203                 force = 1;
204                 break;
205         case REF_LOCAL_BRANCH:
206                 fmt = "refs/heads/%s";
207                 break;
208         default:
209                 die(_("cannot use -a with -d"));
210         }
211
212         if (!force) {
213                 head_rev = lookup_commit_reference(head_sha1);
214                 if (!head_rev)
215                         die(_("Couldn't look up commit object for HEAD"));
216         }
217         for (i = 0; i < argc; i++, strbuf_release(&bname)) {
218                 const char *target;
219                 int flags = 0;
220
221                 strbuf_branchname(&bname, argv[i]);
222                 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
223                         error(_("Cannot delete the branch '%s' "
224                               "which you are currently on."), bname.buf);
225                         ret = 1;
226                         continue;
227                 }
228
229                 free(name);
230
231                 name = mkpathdup(fmt, bname.buf);
232                 target = resolve_ref_unsafe(name, sha1, 0, &flags);
233                 if (!target ||
234                     (!(flags & REF_ISSYMREF) && is_null_sha1(sha1))) {
235                         error(remote_branch
236                               ? _("remote branch '%s' not found.")
237                               : _("branch '%s' not found."), bname.buf);
238                         ret = 1;
239                         continue;
240                 }
241
242                 if (!(flags & REF_ISSYMREF) &&
243                     check_branch_commit(bname.buf, name, sha1, head_rev, kinds,
244                                         force)) {
245                         ret = 1;
246                         continue;
247                 }
248
249                 if (delete_ref(name, sha1, REF_NODEREF)) {
250                         error(remote_branch
251                               ? _("Error deleting remote 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 branch %s (was %s).\n")
260                                : _("Deleted branch %s (was %s).\n"),
261                                bname.buf,
262                                (flags & REF_ISSYMREF)
263                                ? 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 struct ref_item {
275         char *name;
276         char *dest;
277         unsigned int kind, width;
278         struct commit *commit;
279 };
280
281 struct ref_list {
282         struct rev_info revs;
283         int index, alloc, maxwidth, verbose, abbrev;
284         struct ref_item *list;
285         struct commit_list *with_commit;
286         int kinds;
287 };
288
289 static char *resolve_symref(const char *src, const char *prefix)
290 {
291         unsigned char sha1[20];
292         int flag;
293         const char *dst, *cp;
294
295         dst = resolve_ref_unsafe(src, sha1, 0, &flag);
296         if (!(dst && (flag & REF_ISSYMREF)))
297                 return NULL;
298         if (prefix && (cp = skip_prefix(dst, prefix)))
299                 dst = cp;
300         return xstrdup(dst);
301 }
302
303 struct append_ref_cb {
304         struct ref_list *ref_list;
305         const char **pattern;
306         int ret;
307 };
308
309 static int match_patterns(const char **pattern, const char *refname)
310 {
311         if (!*pattern)
312                 return 1; /* no pattern always matches */
313         while (*pattern) {
314                 if (!fnmatch(*pattern, refname, 0))
315                         return 1;
316                 pattern++;
317         }
318         return 0;
319 }
320
321 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
322 {
323         struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
324         struct ref_list *ref_list = cb->ref_list;
325         struct ref_item *newitem;
326         struct commit *commit;
327         int kind, i;
328         const char *prefix, *orig_refname = refname;
329
330         static struct {
331                 int kind;
332                 const char *prefix;
333                 int pfxlen;
334         } ref_kind[] = {
335                 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
336                 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
337         };
338
339         /* Detect kind */
340         for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
341                 prefix = ref_kind[i].prefix;
342                 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
343                         continue;
344                 kind = ref_kind[i].kind;
345                 refname += ref_kind[i].pfxlen;
346                 break;
347         }
348         if (ARRAY_SIZE(ref_kind) <= i)
349                 return 0;
350
351         /* Don't add types the caller doesn't want */
352         if ((kind & ref_list->kinds) == 0)
353                 return 0;
354
355         if (!match_patterns(cb->pattern, refname))
356                 return 0;
357
358         commit = NULL;
359         if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
360                 commit = lookup_commit_reference_gently(sha1, 1);
361                 if (!commit) {
362                         cb->ret = error(_("branch '%s' does not point at a commit"), refname);
363                         return 0;
364                 }
365
366                 /* Filter with with_commit if specified */
367                 if (!is_descendant_of(commit, ref_list->with_commit))
368                         return 0;
369
370                 if (merge_filter != NO_FILTER)
371                         add_pending_object(&ref_list->revs,
372                                            (struct object *)commit, refname);
373         }
374
375         ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
376
377         /* Record the new item */
378         newitem = &(ref_list->list[ref_list->index++]);
379         newitem->name = xstrdup(refname);
380         newitem->kind = kind;
381         newitem->commit = commit;
382         newitem->width = utf8_strwidth(refname);
383         newitem->dest = resolve_symref(orig_refname, prefix);
384         /* adjust for "remotes/" */
385         if (newitem->kind == REF_REMOTE_BRANCH &&
386             ref_list->kinds != REF_REMOTE_BRANCH)
387                 newitem->width += 8;
388         if (newitem->width > ref_list->maxwidth)
389                 ref_list->maxwidth = newitem->width;
390
391         return 0;
392 }
393
394 static void free_ref_list(struct ref_list *ref_list)
395 {
396         int i;
397
398         for (i = 0; i < ref_list->index; i++) {
399                 free(ref_list->list[i].name);
400                 free(ref_list->list[i].dest);
401         }
402         free(ref_list->list);
403 }
404
405 static int ref_cmp(const void *r1, const void *r2)
406 {
407         struct ref_item *c1 = (struct ref_item *)(r1);
408         struct ref_item *c2 = (struct ref_item *)(r2);
409
410         if (c1->kind != c2->kind)
411                 return c1->kind - c2->kind;
412         return strcmp(c1->name, c2->name);
413 }
414
415 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
416                 int show_upstream_ref)
417 {
418         int ours, theirs;
419         char *ref = NULL;
420         struct branch *branch = branch_get(branch_name);
421
422         if (!stat_tracking_info(branch, &ours, &theirs)) {
423                 if (branch && branch->merge && branch->merge[0]->dst &&
424                     show_upstream_ref)
425                         strbuf_addf(stat, "[%s] ",
426                             shorten_unambiguous_ref(branch->merge[0]->dst, 0));
427                 return;
428         }
429
430         if (show_upstream_ref)
431                 ref = shorten_unambiguous_ref(branch->merge[0]->dst, 0);
432         if (!ours) {
433                 if (ref)
434                         strbuf_addf(stat, _("[%s: behind %d]"), ref, theirs);
435                 else
436                         strbuf_addf(stat, _("[behind %d]"), theirs);
437
438         } else if (!theirs) {
439                 if (ref)
440                         strbuf_addf(stat, _("[%s: ahead %d]"), ref, ours);
441                 else
442                         strbuf_addf(stat, _("[ahead %d]"), ours);
443         } else {
444                 if (ref)
445                         strbuf_addf(stat, _("[%s: ahead %d, behind %d]"),
446                                     ref, ours, theirs);
447                 else
448                         strbuf_addf(stat, _("[ahead %d, behind %d]"),
449                                     ours, theirs);
450         }
451         strbuf_addch(stat, ' ');
452         free(ref);
453 }
454
455 static int matches_merge_filter(struct commit *commit)
456 {
457         int is_merged;
458
459         if (merge_filter == NO_FILTER)
460                 return 1;
461
462         is_merged = !!(commit->object.flags & UNINTERESTING);
463         return (is_merged == (merge_filter == SHOW_MERGED));
464 }
465
466 static void add_verbose_info(struct strbuf *out, struct ref_item *item,
467                              int verbose, int abbrev)
468 {
469         struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
470         const char *sub = _(" **** invalid ref ****");
471         struct commit *commit = item->commit;
472
473         if (commit && !parse_commit(commit)) {
474                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
475                 sub = subject.buf;
476         }
477
478         if (item->kind == REF_LOCAL_BRANCH)
479                 fill_tracking_info(&stat, item->name, verbose > 1);
480
481         strbuf_addf(out, " %s %s%s",
482                 find_unique_abbrev(item->commit->object.sha1, abbrev),
483                 stat.buf, sub);
484         strbuf_release(&stat);
485         strbuf_release(&subject);
486 }
487
488 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
489                            int abbrev, int current, char *prefix)
490 {
491         char c;
492         int color;
493         struct commit *commit = item->commit;
494         struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
495
496         if (!matches_merge_filter(commit))
497                 return;
498
499         switch (item->kind) {
500         case REF_LOCAL_BRANCH:
501                 color = BRANCH_COLOR_LOCAL;
502                 break;
503         case REF_REMOTE_BRANCH:
504                 color = BRANCH_COLOR_REMOTE;
505                 break;
506         default:
507                 color = BRANCH_COLOR_PLAIN;
508                 break;
509         }
510
511         c = ' ';
512         if (current) {
513                 c = '*';
514                 color = BRANCH_COLOR_CURRENT;
515         }
516
517         strbuf_addf(&name, "%s%s", prefix, item->name);
518         if (verbose) {
519                 int utf8_compensation = strlen(name.buf) - utf8_strwidth(name.buf);
520                 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
521                             maxwidth + utf8_compensation, name.buf,
522                             branch_get_color(BRANCH_COLOR_RESET));
523         } else
524                 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
525                             name.buf, branch_get_color(BRANCH_COLOR_RESET));
526
527         if (item->dest)
528                 strbuf_addf(&out, " -> %s", item->dest);
529         else if (verbose)
530                 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
531                 add_verbose_info(&out, item, verbose, abbrev);
532         if (column_active(colopts)) {
533                 assert(!verbose && "--column and --verbose are incompatible");
534                 string_list_append(&output, out.buf);
535         } else {
536                 printf("%s\n", out.buf);
537         }
538         strbuf_release(&name);
539         strbuf_release(&out);
540 }
541
542 static int calc_maxwidth(struct ref_list *refs)
543 {
544         int i, w = 0;
545         for (i = 0; i < refs->index; i++) {
546                 if (!matches_merge_filter(refs->list[i].commit))
547                         continue;
548                 if (refs->list[i].width > w)
549                         w = refs->list[i].width;
550         }
551         return w;
552 }
553
554 static char *get_head_description(void)
555 {
556         struct strbuf desc = STRBUF_INIT;
557         struct wt_status_state state;
558         memset(&state, 0, sizeof(state));
559         wt_status_get_state(&state, 1);
560         if (state.rebase_in_progress ||
561             state.rebase_interactive_in_progress)
562                 strbuf_addf(&desc, _("(no branch, rebasing %s)"),
563                             state.branch);
564         else if (state.bisect_in_progress)
565                 strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
566                             state.branch);
567         else if (state.detached_from)
568                 strbuf_addf(&desc, _("(detached from %s)"),
569                             state.detached_from);
570         else
571                 strbuf_addstr(&desc, _("(no branch)"));
572         free(state.branch);
573         free(state.onto);
574         free(state.detached_from);
575         return strbuf_detach(&desc, NULL);
576 }
577
578 static void show_detached(struct ref_list *ref_list)
579 {
580         struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
581
582         if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
583                 struct ref_item item;
584                 item.name = get_head_description();
585                 item.width = utf8_strwidth(item.name);
586                 item.kind = REF_LOCAL_BRANCH;
587                 item.dest = NULL;
588                 item.commit = head_commit;
589                 if (item.width > ref_list->maxwidth)
590                         ref_list->maxwidth = item.width;
591                 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
592                 free(item.name);
593         }
594 }
595
596 static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit, const char **pattern)
597 {
598         int i;
599         struct append_ref_cb cb;
600         struct ref_list ref_list;
601
602         memset(&ref_list, 0, sizeof(ref_list));
603         ref_list.kinds = kinds;
604         ref_list.verbose = verbose;
605         ref_list.abbrev = abbrev;
606         ref_list.with_commit = with_commit;
607         if (merge_filter != NO_FILTER)
608                 init_revisions(&ref_list.revs, NULL);
609         cb.ref_list = &ref_list;
610         cb.pattern = pattern;
611         cb.ret = 0;
612         for_each_rawref(append_ref, &cb);
613         if (merge_filter != NO_FILTER) {
614                 struct commit *filter;
615                 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
616                 if (!filter)
617                         die(_("object '%s' does not point to a commit"),
618                             sha1_to_hex(merge_filter_ref));
619
620                 filter->object.flags |= UNINTERESTING;
621                 add_pending_object(&ref_list.revs,
622                                    (struct object *) filter, "");
623                 ref_list.revs.limited = 1;
624                 prepare_revision_walk(&ref_list.revs);
625                 if (verbose)
626                         ref_list.maxwidth = calc_maxwidth(&ref_list);
627         }
628
629         qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
630
631         detached = (detached && (kinds & REF_LOCAL_BRANCH));
632         if (detached && match_patterns(pattern, "HEAD"))
633                 show_detached(&ref_list);
634
635         for (i = 0; i < ref_list.index; i++) {
636                 int current = !detached &&
637                         (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
638                         !strcmp(ref_list.list[i].name, head);
639                 char *prefix = (kinds != REF_REMOTE_BRANCH &&
640                                 ref_list.list[i].kind == REF_REMOTE_BRANCH)
641                                 ? "remotes/" : "";
642                 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
643                                abbrev, current, prefix);
644         }
645
646         free_ref_list(&ref_list);
647
648         if (cb.ret)
649                 error(_("some refs could not be read"));
650
651         return cb.ret;
652 }
653
654 static void rename_branch(const char *oldname, const char *newname, int force)
655 {
656         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
657         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
658         int recovery = 0;
659         int clobber_head_ok;
660
661         if (!oldname)
662                 die(_("cannot rename the current branch while not on any."));
663
664         if (strbuf_check_branch_ref(&oldref, oldname)) {
665                 /*
666                  * Bad name --- this could be an attempt to rename a
667                  * ref that we used to allow to be created by accident.
668                  */
669                 if (ref_exists(oldref.buf))
670                         recovery = 1;
671                 else
672                         die(_("Invalid branch name: '%s'"), oldname);
673         }
674
675         /*
676          * A command like "git branch -M currentbranch currentbranch" cannot
677          * cause the worktree to become inconsistent with HEAD, so allow it.
678          */
679         clobber_head_ok = !strcmp(oldname, newname);
680
681         validate_new_branchname(newname, &newref, force, clobber_head_ok);
682
683         strbuf_addf(&logmsg, "Branch: renamed %s to %s",
684                  oldref.buf, newref.buf);
685
686         if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
687                 die(_("Branch rename failed"));
688         strbuf_release(&logmsg);
689
690         if (recovery)
691                 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
692
693         /* no need to pass logmsg here as HEAD didn't really move */
694         if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
695                 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
696
697         strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
698         strbuf_release(&oldref);
699         strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
700         strbuf_release(&newref);
701         if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
702                 die(_("Branch is renamed, but update of config-file failed"));
703         strbuf_release(&oldsection);
704         strbuf_release(&newsection);
705 }
706
707 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
708 {
709         merge_filter = ((opt->long_name[0] == 'n')
710                         ? SHOW_NOT_MERGED
711                         : SHOW_MERGED);
712         if (unset)
713                 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
714         if (!arg)
715                 arg = "HEAD";
716         if (get_sha1(arg, merge_filter_ref))
717                 die(_("malformed object name %s"), arg);
718         return 0;
719 }
720
721 static const char edit_description[] = "BRANCH_DESCRIPTION";
722
723 static int edit_branch_description(const char *branch_name)
724 {
725         FILE *fp;
726         int status;
727         struct strbuf buf = STRBUF_INIT;
728         struct strbuf name = STRBUF_INIT;
729
730         read_branch_desc(&buf, branch_name);
731         if (!buf.len || buf.buf[buf.len-1] != '\n')
732                 strbuf_addch(&buf, '\n');
733         strbuf_commented_addf(&buf,
734                     "Please edit the description for the branch\n"
735                     "  %s\n"
736                     "Lines starting with '%c' will be stripped.\n",
737                     branch_name, comment_line_char);
738         fp = fopen(git_path(edit_description), "w");
739         if ((fwrite(buf.buf, 1, buf.len, fp) < buf.len) || fclose(fp)) {
740                 strbuf_release(&buf);
741                 return error(_("could not write branch description template: %s"),
742                              strerror(errno));
743         }
744         strbuf_reset(&buf);
745         if (launch_editor(git_path(edit_description), &buf, NULL)) {
746                 strbuf_release(&buf);
747                 return -1;
748         }
749         stripspace(&buf, 1);
750
751         strbuf_addf(&name, "branch.%s.description", branch_name);
752         status = git_config_set(name.buf, buf.len ? buf.buf : NULL);
753         strbuf_release(&name);
754         strbuf_release(&buf);
755
756         return status;
757 }
758
759 int cmd_branch(int argc, const char **argv, const char *prefix)
760 {
761         int delete = 0, rename = 0, force_create = 0, list = 0;
762         int verbose = 0, abbrev = -1, detached = 0;
763         int reflog = 0, edit_description = 0;
764         int quiet = 0, unset_upstream = 0;
765         const char *new_upstream = NULL;
766         enum branch_track track;
767         int kinds = REF_LOCAL_BRANCH;
768         struct commit_list *with_commit = NULL;
769
770         struct option options[] = {
771                 OPT_GROUP(N_("Generic options")),
772                 OPT__VERBOSE(&verbose,
773                         N_("show hash and subject, give twice for upstream branch")),
774                 OPT__QUIET(&quiet, N_("suppress informational messages")),
775                 OPT_SET_INT('t', "track",  &track, N_("set up tracking mode (see git-pull(1))"),
776                         BRANCH_TRACK_EXPLICIT),
777                 OPT_SET_INT( 0, "set-upstream",  &track, N_("change upstream info"),
778                         BRANCH_TRACK_OVERRIDE),
779                 OPT_STRING('u', "set-upstream-to", &new_upstream, "upstream", "change the upstream info"),
780                 OPT_BOOLEAN(0, "unset-upstream", &unset_upstream, "Unset the upstream info"),
781                 OPT__COLOR(&branch_use_color, N_("use colored output")),
782                 OPT_SET_INT('r', "remotes",     &kinds, N_("act on remote-tracking branches"),
783                         REF_REMOTE_BRANCH),
784                 {
785                         OPTION_CALLBACK, 0, "contains", &with_commit, N_("commit"),
786                         N_("print only branches that contain the commit"),
787                         PARSE_OPT_LASTARG_DEFAULT,
788                         parse_opt_with_commit, (intptr_t)"HEAD",
789                 },
790                 {
791                         OPTION_CALLBACK, 0, "with", &with_commit, N_("commit"),
792                         N_("print only branches that contain the commit"),
793                         PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
794                         parse_opt_with_commit, (intptr_t) "HEAD",
795                 },
796                 OPT__ABBREV(&abbrev),
797
798                 OPT_GROUP(N_("Specific git-branch actions:")),
799                 OPT_SET_INT('a', "all", &kinds, N_("list both remote-tracking and local branches"),
800                         REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
801                 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
802                 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
803                 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
804                 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
805                 OPT_BOOLEAN(0, "list", &list, N_("list branch names")),
806                 OPT_BOOLEAN('l', "create-reflog", &reflog, N_("create the branch's reflog")),
807                 OPT_BOOLEAN(0, "edit-description", &edit_description,
808                             N_("edit the description for the branch")),
809                 OPT__FORCE(&force_create, N_("force creation (when already exists)")),
810                 {
811                         OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
812                         N_("commit"), N_("print only not merged branches"),
813                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
814                         opt_parse_merge_filter, (intptr_t) "HEAD",
815                 },
816                 {
817                         OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
818                         N_("commit"), N_("print only merged branches"),
819                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
820                         opt_parse_merge_filter, (intptr_t) "HEAD",
821                 },
822                 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
823                 OPT_END(),
824         };
825
826         if (argc == 2 && !strcmp(argv[1], "-h"))
827                 usage_with_options(builtin_branch_usage, options);
828
829         git_config(git_branch_config, NULL);
830
831         track = git_branch_track;
832
833         head = resolve_refdup("HEAD", head_sha1, 0, NULL);
834         if (!head)
835                 die(_("Failed to resolve HEAD as a valid ref."));
836         if (!strcmp(head, "HEAD")) {
837                 detached = 1;
838         } else {
839                 if (prefixcmp(head, "refs/heads/"))
840                         die(_("HEAD not found below refs/heads!"));
841                 head += 11;
842         }
843         hashcpy(merge_filter_ref, head_sha1);
844
845
846         argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
847                              0);
848
849         if (!delete && !rename && !edit_description && !new_upstream && !unset_upstream && argc == 0)
850                 list = 1;
851
852         if (with_commit || merge_filter != NO_FILTER)
853                 list = 1;
854
855         if (!!delete + !!rename + !!force_create + !!list + !!new_upstream + !!unset_upstream > 1)
856                 usage_with_options(builtin_branch_usage, options);
857
858         if (abbrev == -1)
859                 abbrev = DEFAULT_ABBREV;
860         finalize_colopts(&colopts, -1);
861         if (verbose) {
862                 if (explicitly_enable_column(colopts))
863                         die(_("--column and --verbose are incompatible"));
864                 colopts = 0;
865         }
866
867         if (delete) {
868                 if (!argc)
869                         die(_("branch name required"));
870                 return delete_branches(argc, argv, delete > 1, kinds, quiet);
871         } else if (list) {
872                 int ret = print_ref_list(kinds, detached, verbose, abbrev,
873                                          with_commit, argv);
874                 print_columns(&output, colopts, NULL);
875                 string_list_clear(&output, 0);
876                 return ret;
877         }
878         else if (edit_description) {
879                 const char *branch_name;
880                 struct strbuf branch_ref = STRBUF_INIT;
881
882                 if (!argc) {
883                         if (detached)
884                                 die(_("Cannot give description to detached HEAD"));
885                         branch_name = head;
886                 } else if (argc == 1)
887                         branch_name = argv[0];
888                 else
889                         die(_("cannot edit description of more than one branch"));
890
891                 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
892                 if (!ref_exists(branch_ref.buf)) {
893                         strbuf_release(&branch_ref);
894
895                         if (!argc)
896                                 return error(_("No commit on branch '%s' yet."),
897                                              branch_name);
898                         else
899                                 return error(_("No branch named '%s'."),
900                                              branch_name);
901                 }
902                 strbuf_release(&branch_ref);
903
904                 if (edit_branch_description(branch_name))
905                         return 1;
906         } else if (rename) {
907                 if (!argc)
908                         die(_("branch name required"));
909                 else if (argc == 1)
910                         rename_branch(head, argv[0], rename > 1);
911                 else if (argc == 2)
912                         rename_branch(argv[0], argv[1], rename > 1);
913                 else
914                         die(_("too many branches for a rename operation"));
915         } else if (new_upstream) {
916                 struct branch *branch = branch_get(argv[0]);
917
918                 if (argc > 1)
919                         die(_("too many branches to set new upstream"));
920
921                 if (!branch) {
922                         if (!argc || !strcmp(argv[0], "HEAD"))
923                                 die(_("could not set upstream of HEAD to %s when "
924                                       "it does not point to any branch."),
925                                     new_upstream);
926                         die(_("no such branch '%s'"), argv[0]);
927                 }
928
929                 if (!ref_exists(branch->refname))
930                         die(_("branch '%s' does not exist"), branch->name);
931
932                 /*
933                  * create_branch takes care of setting up the tracking
934                  * info and making sure new_upstream is correct
935                  */
936                 create_branch(head, branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
937         } else if (unset_upstream) {
938                 struct branch *branch = branch_get(argv[0]);
939                 struct strbuf buf = STRBUF_INIT;
940
941                 if (argc > 1)
942                         die(_("too many branches to unset upstream"));
943
944                 if (!branch) {
945                         if (!argc || !strcmp(argv[0], "HEAD"))
946                                 die(_("could not unset upstream of HEAD when "
947                                       "it does not point to any branch."));
948                         die(_("no such branch '%s'"), argv[0]);
949                 }
950
951                 if (!branch_has_merge_config(branch)) {
952                         die(_("Branch '%s' has no upstream information"), branch->name);
953                 }
954
955                 strbuf_addf(&buf, "branch.%s.remote", branch->name);
956                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
957                 strbuf_reset(&buf);
958                 strbuf_addf(&buf, "branch.%s.merge", branch->name);
959                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
960                 strbuf_release(&buf);
961         } else if (argc > 0 && argc <= 2) {
962                 struct branch *branch = branch_get(argv[0]);
963                 int branch_existed = 0, remote_tracking = 0;
964                 struct strbuf buf = STRBUF_INIT;
965
966                 if (!strcmp(argv[0], "HEAD"))
967                         die(_("it does not make sense to create 'HEAD' manually"));
968
969                 if (!branch)
970                         die(_("no such branch '%s'"), argv[0]);
971
972                 if (kinds != REF_LOCAL_BRANCH)
973                         die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
974
975                 if (track == BRANCH_TRACK_OVERRIDE)
976                         fprintf(stderr, _("The --set-upstream flag is deprecated and will be removed. Consider using --track or --set-upstream-to\n"));
977
978                 strbuf_addf(&buf, "refs/remotes/%s", branch->name);
979                 remote_tracking = ref_exists(buf.buf);
980                 strbuf_release(&buf);
981
982                 branch_existed = ref_exists(branch->refname);
983                 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
984                               force_create, reflog, 0, quiet, track);
985
986                 /*
987                  * We only show the instructions if the user gave us
988                  * one branch which doesn't exist locally, but is the
989                  * name of a remote-tracking branch.
990                  */
991                 if (argc == 1 && track == BRANCH_TRACK_OVERRIDE &&
992                     !branch_existed && remote_tracking) {
993                         fprintf(stderr, _("\nIf you wanted to make '%s' track '%s', do this:\n\n"), head, branch->name);
994                         fprintf(stderr, _("    git branch -d %s\n"), branch->name);
995                         fprintf(stderr, _("    git branch --set-upstream-to %s\n"), branch->name);
996                 }
997
998         } else
999                 usage_with_options(builtin_branch_usage, options);
1000
1001         return 0;
1002 }