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