Merge branch 'tr/describe-advice'
[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
19 static const char * const builtin_branch_usage[] = {
20         "git branch [options] [-r | -a] [--merged | --no-merged]",
21         "git branch [options] [-l] [-f] <branchname> [<start-point>]",
22         "git branch [options] [-r] (-d | -D) <branchname>",
23         "git branch [options] (-m | -M) [<oldbranch>] <newbranch>",
24         NULL
25 };
26
27 #define REF_LOCAL_BRANCH    0x01
28 #define REF_REMOTE_BRANCH   0x02
29
30 static const char *head;
31 static unsigned char head_sha1[20];
32
33 static int branch_use_color = -1;
34 static char branch_colors[][COLOR_MAXLEN] = {
35         GIT_COLOR_RESET,
36         GIT_COLOR_NORMAL,       /* PLAIN */
37         GIT_COLOR_RED,          /* REMOTE */
38         GIT_COLOR_NORMAL,       /* LOCAL */
39         GIT_COLOR_GREEN,        /* CURRENT */
40 };
41 enum color_branch {
42         BRANCH_COLOR_RESET = 0,
43         BRANCH_COLOR_PLAIN = 1,
44         BRANCH_COLOR_REMOTE = 2,
45         BRANCH_COLOR_LOCAL = 3,
46         BRANCH_COLOR_CURRENT = 4,
47 };
48
49 static enum merge_filter {
50         NO_FILTER = 0,
51         SHOW_NOT_MERGED,
52         SHOW_MERGED,
53 } merge_filter;
54 static unsigned char merge_filter_ref[20];
55
56 static int parse_branch_color_slot(const char *var, int ofs)
57 {
58         if (!strcasecmp(var+ofs, "plain"))
59                 return BRANCH_COLOR_PLAIN;
60         if (!strcasecmp(var+ofs, "reset"))
61                 return BRANCH_COLOR_RESET;
62         if (!strcasecmp(var+ofs, "remote"))
63                 return BRANCH_COLOR_REMOTE;
64         if (!strcasecmp(var+ofs, "local"))
65                 return BRANCH_COLOR_LOCAL;
66         if (!strcasecmp(var+ofs, "current"))
67                 return BRANCH_COLOR_CURRENT;
68         die("bad config variable '%s'", var);
69 }
70
71 static int git_branch_config(const char *var, const char *value, void *cb)
72 {
73         if (!strcmp(var, "color.branch")) {
74                 branch_use_color = git_config_colorbool(var, value, -1);
75                 return 0;
76         }
77         if (!prefixcmp(var, "color.branch.")) {
78                 int slot = parse_branch_color_slot(var, 13);
79                 if (!value)
80                         return config_error_nonbool(var);
81                 color_parse(value, var, branch_colors[slot]);
82                 return 0;
83         }
84         return git_color_default_config(var, value, cb);
85 }
86
87 static const char *branch_get_color(enum color_branch ix)
88 {
89         if (branch_use_color > 0)
90                 return branch_colors[ix];
91         return "";
92 }
93
94 static int delete_branches(int argc, const char **argv, int force, int kinds)
95 {
96         struct commit *rev, *head_rev = head_rev;
97         unsigned char sha1[20];
98         char *name = NULL;
99         const char *fmt, *remote;
100         int i;
101         int ret = 0;
102         struct strbuf bname = STRBUF_INIT;
103
104         switch (kinds) {
105         case REF_REMOTE_BRANCH:
106                 fmt = "refs/remotes/%s";
107                 remote = "remote ";
108                 force = 1;
109                 break;
110         case REF_LOCAL_BRANCH:
111                 fmt = "refs/heads/%s";
112                 remote = "";
113                 break;
114         default:
115                 die("cannot use -a with -d");
116         }
117
118         if (!force) {
119                 head_rev = lookup_commit_reference(head_sha1);
120                 if (!head_rev)
121                         die("Couldn't look up commit object for HEAD");
122         }
123         for (i = 0; i < argc; i++, strbuf_release(&bname)) {
124                 strbuf_branchname(&bname, argv[i]);
125                 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
126                         error("Cannot delete the branch '%s' "
127                               "which you are currently on.", bname.buf);
128                         ret = 1;
129                         continue;
130                 }
131
132                 free(name);
133
134                 name = xstrdup(mkpath(fmt, bname.buf));
135                 if (!resolve_ref(name, sha1, 1, NULL)) {
136                         error("%sbranch '%s' not found.",
137                                         remote, bname.buf);
138                         ret = 1;
139                         continue;
140                 }
141
142                 rev = lookup_commit_reference(sha1);
143                 if (!rev) {
144                         error("Couldn't look up commit object for '%s'", name);
145                         ret = 1;
146                         continue;
147                 }
148
149                 /* This checks whether the merge bases of branch and
150                  * HEAD contains branch -- which means that the HEAD
151                  * contains everything in both.
152                  */
153
154                 if (!force &&
155                     !in_merge_bases(rev, &head_rev, 1)) {
156                         error("The branch '%s' is not an ancestor of "
157                               "your current HEAD.\n"
158                               "If you are sure you want to delete it, "
159                               "run 'git branch -D %s'.", bname.buf, bname.buf);
160                         ret = 1;
161                         continue;
162                 }
163
164                 if (delete_ref(name, sha1, 0)) {
165                         error("Error deleting %sbranch '%s'", remote,
166                               bname.buf);
167                         ret = 1;
168                 } else {
169                         struct strbuf buf = STRBUF_INIT;
170                         printf("Deleted %sbranch %s (was %s).\n", remote,
171                                bname.buf,
172                                find_unique_abbrev(sha1, DEFAULT_ABBREV));
173                         strbuf_addf(&buf, "branch.%s", bname.buf);
174                         if (git_config_rename_section(buf.buf, NULL) < 0)
175                                 warning("Update of config-file failed");
176                         strbuf_release(&buf);
177                 }
178         }
179
180         free(name);
181
182         return(ret);
183 }
184
185 struct ref_item {
186         char *name;
187         char *dest;
188         unsigned int kind, len;
189         struct commit *commit;
190 };
191
192 struct ref_list {
193         struct rev_info revs;
194         int index, alloc, maxwidth, verbose, abbrev;
195         struct ref_item *list;
196         struct commit_list *with_commit;
197         int kinds;
198 };
199
200 static char *resolve_symref(const char *src, const char *prefix)
201 {
202         unsigned char sha1[20];
203         int flag;
204         const char *dst, *cp;
205
206         dst = resolve_ref(src, sha1, 0, &flag);
207         if (!(dst && (flag & REF_ISSYMREF)))
208                 return NULL;
209         if (prefix && (cp = skip_prefix(dst, prefix)))
210                 dst = cp;
211         return xstrdup(dst);
212 }
213
214 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
215 {
216         struct ref_list *ref_list = (struct ref_list*)(cb_data);
217         struct ref_item *newitem;
218         struct commit *commit;
219         int kind, i;
220         const char *prefix, *orig_refname = refname;
221
222         static struct {
223                 int kind;
224                 const char *prefix;
225                 int pfxlen;
226         } ref_kind[] = {
227                 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
228                 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
229         };
230
231         /* Detect kind */
232         for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
233                 prefix = ref_kind[i].prefix;
234                 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
235                         continue;
236                 kind = ref_kind[i].kind;
237                 refname += ref_kind[i].pfxlen;
238                 break;
239         }
240         if (ARRAY_SIZE(ref_kind) <= i)
241                 return 0;
242
243         /* Don't add types the caller doesn't want */
244         if ((kind & ref_list->kinds) == 0)
245                 return 0;
246
247         commit = NULL;
248         if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
249                 commit = lookup_commit_reference_gently(sha1, 1);
250                 if (!commit)
251                         return error("branch '%s' does not point at a commit", refname);
252
253                 /* Filter with with_commit if specified */
254                 if (!is_descendant_of(commit, ref_list->with_commit))
255                         return 0;
256
257                 if (merge_filter != NO_FILTER)
258                         add_pending_object(&ref_list->revs,
259                                            (struct object *)commit, refname);
260         }
261
262         /* Resize buffer */
263         if (ref_list->index >= ref_list->alloc) {
264                 ref_list->alloc = alloc_nr(ref_list->alloc);
265                 ref_list->list = xrealloc(ref_list->list,
266                                 ref_list->alloc * sizeof(struct ref_item));
267         }
268
269         /* Record the new item */
270         newitem = &(ref_list->list[ref_list->index++]);
271         newitem->name = xstrdup(refname);
272         newitem->kind = kind;
273         newitem->commit = commit;
274         newitem->len = strlen(refname);
275         newitem->dest = resolve_symref(orig_refname, prefix);
276         /* adjust for "remotes/" */
277         if (newitem->kind == REF_REMOTE_BRANCH &&
278             ref_list->kinds != REF_REMOTE_BRANCH)
279                 newitem->len += 8;
280         if (newitem->len > ref_list->maxwidth)
281                 ref_list->maxwidth = newitem->len;
282
283         return 0;
284 }
285
286 static void free_ref_list(struct ref_list *ref_list)
287 {
288         int i;
289
290         for (i = 0; i < ref_list->index; i++) {
291                 free(ref_list->list[i].name);
292                 free(ref_list->list[i].dest);
293         }
294         free(ref_list->list);
295 }
296
297 static int ref_cmp(const void *r1, const void *r2)
298 {
299         struct ref_item *c1 = (struct ref_item *)(r1);
300         struct ref_item *c2 = (struct ref_item *)(r2);
301
302         if (c1->kind != c2->kind)
303                 return c1->kind - c2->kind;
304         return strcmp(c1->name, c2->name);
305 }
306
307 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
308                 int show_upstream_ref)
309 {
310         int ours, theirs;
311         struct branch *branch = branch_get(branch_name);
312
313         if (!stat_tracking_info(branch, &ours, &theirs)) {
314                 if (branch && branch->merge && branch->merge[0]->dst &&
315                     show_upstream_ref)
316                         strbuf_addf(stat, "[%s] ",
317                             shorten_unambiguous_ref(branch->merge[0]->dst, 0));
318                 return;
319         }
320
321         strbuf_addch(stat, '[');
322         if (show_upstream_ref)
323                 strbuf_addf(stat, "%s: ",
324                         shorten_unambiguous_ref(branch->merge[0]->dst, 0));
325         if (!ours)
326                 strbuf_addf(stat, "behind %d] ", theirs);
327         else if (!theirs)
328                 strbuf_addf(stat, "ahead %d] ", ours);
329         else
330                 strbuf_addf(stat, "ahead %d, behind %d] ", ours, theirs);
331 }
332
333 static int matches_merge_filter(struct commit *commit)
334 {
335         int is_merged;
336
337         if (merge_filter == NO_FILTER)
338                 return 1;
339
340         is_merged = !!(commit->object.flags & UNINTERESTING);
341         return (is_merged == (merge_filter == SHOW_MERGED));
342 }
343
344 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
345                            int abbrev, int current, char *prefix)
346 {
347         char c;
348         int color;
349         struct commit *commit = item->commit;
350         struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
351
352         if (!matches_merge_filter(commit))
353                 return;
354
355         switch (item->kind) {
356         case REF_LOCAL_BRANCH:
357                 color = BRANCH_COLOR_LOCAL;
358                 break;
359         case REF_REMOTE_BRANCH:
360                 color = BRANCH_COLOR_REMOTE;
361                 break;
362         default:
363                 color = BRANCH_COLOR_PLAIN;
364                 break;
365         }
366
367         c = ' ';
368         if (current) {
369                 c = '*';
370                 color = BRANCH_COLOR_CURRENT;
371         }
372
373         strbuf_addf(&name, "%s%s", prefix, item->name);
374         if (verbose)
375                 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
376                             maxwidth, name.buf,
377                             branch_get_color(BRANCH_COLOR_RESET));
378         else
379                 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
380                             name.buf, branch_get_color(BRANCH_COLOR_RESET));
381
382         if (item->dest)
383                 strbuf_addf(&out, " -> %s", item->dest);
384         else if (verbose) {
385                 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
386                 const char *sub = " **** invalid ref ****";
387
388                 commit = item->commit;
389                 if (commit && !parse_commit(commit)) {
390                         struct pretty_print_context ctx = {0};
391                         pretty_print_commit(CMIT_FMT_ONELINE, commit,
392                                             &subject, &ctx);
393                         sub = subject.buf;
394                 }
395
396                 if (item->kind == REF_LOCAL_BRANCH)
397                         fill_tracking_info(&stat, item->name, verbose > 1);
398
399                 strbuf_addf(&out, " %s %s%s",
400                         find_unique_abbrev(item->commit->object.sha1, abbrev),
401                         stat.buf, sub);
402                 strbuf_release(&stat);
403                 strbuf_release(&subject);
404         }
405         printf("%s\n", out.buf);
406         strbuf_release(&name);
407         strbuf_release(&out);
408 }
409
410 static int calc_maxwidth(struct ref_list *refs)
411 {
412         int i, w = 0;
413         for (i = 0; i < refs->index; i++) {
414                 if (!matches_merge_filter(refs->list[i].commit))
415                         continue;
416                 if (refs->list[i].len > w)
417                         w = refs->list[i].len;
418         }
419         return w;
420 }
421
422
423 static void show_detached(struct ref_list *ref_list)
424 {
425         struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
426
427         if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
428                 struct ref_item item;
429                 item.name = xstrdup("(no branch)");
430                 item.len = strlen(item.name);
431                 item.kind = REF_LOCAL_BRANCH;
432                 item.dest = NULL;
433                 item.commit = head_commit;
434                 if (item.len > ref_list->maxwidth)
435                         ref_list->maxwidth = item.len;
436                 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
437                 free(item.name);
438         }
439 }
440
441 static void print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit)
442 {
443         int i;
444         struct ref_list ref_list;
445
446         memset(&ref_list, 0, sizeof(ref_list));
447         ref_list.kinds = kinds;
448         ref_list.verbose = verbose;
449         ref_list.abbrev = abbrev;
450         ref_list.with_commit = with_commit;
451         if (merge_filter != NO_FILTER)
452                 init_revisions(&ref_list.revs, NULL);
453         for_each_rawref(append_ref, &ref_list);
454         if (merge_filter != NO_FILTER) {
455                 struct commit *filter;
456                 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
457                 filter->object.flags |= UNINTERESTING;
458                 add_pending_object(&ref_list.revs,
459                                    (struct object *) filter, "");
460                 ref_list.revs.limited = 1;
461                 prepare_revision_walk(&ref_list.revs);
462                 if (verbose)
463                         ref_list.maxwidth = calc_maxwidth(&ref_list);
464         }
465
466         qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
467
468         detached = (detached && (kinds & REF_LOCAL_BRANCH));
469         if (detached)
470                 show_detached(&ref_list);
471
472         for (i = 0; i < ref_list.index; i++) {
473                 int current = !detached &&
474                         (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
475                         !strcmp(ref_list.list[i].name, head);
476                 char *prefix = (kinds != REF_REMOTE_BRANCH &&
477                                 ref_list.list[i].kind == REF_REMOTE_BRANCH)
478                                 ? "remotes/" : "";
479                 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
480                                abbrev, current, prefix);
481         }
482
483         free_ref_list(&ref_list);
484 }
485
486 static void rename_branch(const char *oldname, const char *newname, int force)
487 {
488         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
489         unsigned char sha1[20];
490         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
491         int recovery = 0;
492
493         if (!oldname)
494                 die("cannot rename the current branch while not on any.");
495
496         if (strbuf_check_branch_ref(&oldref, oldname)) {
497                 /*
498                  * Bad name --- this could be an attempt to rename a
499                  * ref that we used to allow to be created by accident.
500                  */
501                 if (resolve_ref(oldref.buf, sha1, 1, NULL))
502                         recovery = 1;
503                 else
504                         die("Invalid branch name: '%s'", oldname);
505         }
506
507         if (strbuf_check_branch_ref(&newref, newname))
508                 die("Invalid branch name: '%s'", newname);
509
510         if (resolve_ref(newref.buf, sha1, 1, NULL) && !force)
511                 die("A branch named '%s' already exists.", newref.buf + 11);
512
513         strbuf_addf(&logmsg, "Branch: renamed %s to %s",
514                  oldref.buf, newref.buf);
515
516         if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
517                 die("Branch rename failed");
518         strbuf_release(&logmsg);
519
520         if (recovery)
521                 warning("Renamed a misnamed branch '%s' away", oldref.buf + 11);
522
523         /* no need to pass logmsg here as HEAD didn't really move */
524         if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
525                 die("Branch renamed to %s, but HEAD is not updated!", newname);
526
527         strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
528         strbuf_release(&oldref);
529         strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
530         strbuf_release(&newref);
531         if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
532                 die("Branch is renamed, but update of config-file failed");
533         strbuf_release(&oldsection);
534         strbuf_release(&newsection);
535 }
536
537 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
538 {
539         merge_filter = ((opt->long_name[0] == 'n')
540                         ? SHOW_NOT_MERGED
541                         : SHOW_MERGED);
542         if (unset)
543                 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
544         if (!arg)
545                 arg = "HEAD";
546         if (get_sha1(arg, merge_filter_ref))
547                 die("malformed object name %s", arg);
548         return 0;
549 }
550
551 int cmd_branch(int argc, const char **argv, const char *prefix)
552 {
553         int delete = 0, rename = 0, force_create = 0;
554         int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
555         int reflog = 0;
556         enum branch_track track;
557         int kinds = REF_LOCAL_BRANCH;
558         struct commit_list *with_commit = NULL;
559
560         struct option options[] = {
561                 OPT_GROUP("Generic options"),
562                 OPT__VERBOSE(&verbose),
563                 OPT_SET_INT('t', "track",  &track, "set up tracking mode (see git-pull(1))",
564                         BRANCH_TRACK_EXPLICIT),
565                 OPT_BOOLEAN( 0 , "color",  &branch_use_color, "use colored output"),
566                 OPT_SET_INT('r', NULL,     &kinds, "act on remote-tracking branches",
567                         REF_REMOTE_BRANCH),
568                 {
569                         OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
570                         "print only branches that contain the commit",
571                         PARSE_OPT_LASTARG_DEFAULT,
572                         parse_opt_with_commit, (intptr_t)"HEAD",
573                 },
574                 {
575                         OPTION_CALLBACK, 0, "with", &with_commit, "commit",
576                         "print only branches that contain the commit",
577                         PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
578                         parse_opt_with_commit, (intptr_t) "HEAD",
579                 },
580                 OPT__ABBREV(&abbrev),
581
582                 OPT_GROUP("Specific git-branch actions:"),
583                 OPT_SET_INT('a', NULL, &kinds, "list both remote-tracking and local branches",
584                         REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
585                 OPT_BIT('d', NULL, &delete, "delete fully merged branch", 1),
586                 OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
587                 OPT_BIT('m', NULL, &rename, "move/rename a branch and its reflog", 1),
588                 OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
589                 OPT_BOOLEAN('l', NULL, &reflog, "create the branch's reflog"),
590                 OPT_BOOLEAN('f', "force", &force_create, "force creation (when already exists)"),
591                 {
592                         OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
593                         "commit", "print only not merged branches",
594                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
595                         opt_parse_merge_filter, (intptr_t) "HEAD",
596                 },
597                 {
598                         OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
599                         "commit", "print only merged branches",
600                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
601                         opt_parse_merge_filter, (intptr_t) "HEAD",
602                 },
603                 OPT_END(),
604         };
605
606         git_config(git_branch_config, NULL);
607
608         if (branch_use_color == -1)
609                 branch_use_color = git_use_color_default;
610
611         track = git_branch_track;
612
613         head = resolve_ref("HEAD", head_sha1, 0, NULL);
614         if (!head)
615                 die("Failed to resolve HEAD as a valid ref.");
616         head = xstrdup(head);
617         if (!strcmp(head, "HEAD")) {
618                 detached = 1;
619         } else {
620                 if (prefixcmp(head, "refs/heads/"))
621                         die("HEAD not found below refs/heads!");
622                 head += 11;
623         }
624         hashcpy(merge_filter_ref, head_sha1);
625
626         argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
627                              0);
628         if (!!delete + !!rename + !!force_create > 1)
629                 usage_with_options(builtin_branch_usage, options);
630
631         if (delete)
632                 return delete_branches(argc, argv, delete > 1, kinds);
633         else if (argc == 0)
634                 print_ref_list(kinds, detached, verbose, abbrev, with_commit);
635         else if (rename && (argc == 1))
636                 rename_branch(head, argv[0], rename > 1);
637         else if (rename && (argc == 2))
638                 rename_branch(argv[0], argv[1], rename > 1);
639         else if (argc <= 2)
640                 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
641                               force_create, reflog, track);
642         else
643                 usage_with_options(builtin_branch_usage, options);
644
645         return 0;
646 }