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