builtin-rev-list.c

   1 #include "cache.h"
   2 #include "commit.h"
   3 #include "diff.h"
   4 #include "revision.h"
   5 #include "list-objects.h"
   6 #include "builtin.h"
   7 #include "log-tree.h"
   8 #include "graph.h"
   9 #include "bisect.h"
  10
  11 static const char rev_list_usage[] =
  12 "git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
  13 "  limiting output:\n"
  14 "    --max-count=nr\n"
  15 "    --max-age=epoch\n"
  16 "    --min-age=epoch\n"
  17 "    --sparse\n"
  18 "    --no-merges\n"
  19 "    --remove-empty\n"
  20 "    --all\n"
  21 "    --branches\n"
  22 "    --tags\n"
  23 "    --remotes\n"
  24 "    --stdin\n"
  25 "    --quiet\n"
  26 "  ordering output:\n"
  27 "    --topo-order\n"
  28 "    --date-order\n"
  29 "    --reverse\n"
  30 "  formatting output:\n"
  31 "    --parents\n"
  32 "    --children\n"
  33 "    --objects | --objects-edge\n"
  34 "    --unpacked\n"
  35 "    --header | --pretty\n"
  36 "    --abbrev=nr | --no-abbrev\n"
  37 "    --abbrev-commit\n"
  38 "    --left-right\n"
  39 "  special purpose:\n"
  40 "    --bisect\n"
  41 "    --bisect-vars\n"
  42 "    --bisect-all"
  43 ;
  44
  45 static struct rev_info revs;
  46
  47 static int show_timestamp;
  48 static int hdr_termination;
  49 static const char *header_prefix;
  50
  51 static void finish_commit(struct commit *commit);
  52 static void show_commit(struct commit *commit)
  53 {
  54         graph_show_commit(revs.graph);
  55
  56         if (show_timestamp)
  57                 printf("%lu ", commit->date);
  58         if (header_prefix)
  59                 fputs(header_prefix, stdout);
  60
  61         if (!revs.graph) {
  62                 if (commit->object.flags & BOUNDARY)
  63                         putchar('-');
  64                 else if (commit->object.flags & UNINTERESTING)
  65                         putchar('^');
  66                 else if (revs.left_right) {
  67                         if (commit->object.flags & SYMMETRIC_LEFT)
  68                                 putchar('<');
  69                         else
  70                                 putchar('>');
  71                 }
  72         }
  73         if (revs.abbrev_commit && revs.abbrev)
  74                 fputs(find_unique_abbrev(commit->object.sha1, revs.abbrev),
  75                       stdout);
  76         else
  77                 fputs(sha1_to_hex(commit->object.sha1), stdout);
  78         if (revs.print_parents) {
  79                 struct commit_list *parents = commit->parents;
  80                 while (parents) {
  81                         printf(" %s", sha1_to_hex(parents->item->object.sha1));
  82                         parents = parents->next;
  83                 }
  84         }
  85         if (revs.children.name) {
  86                 struct commit_list *children;
  87
  88                 children = lookup_decoration(&revs.children, &commit->object);
  89                 while (children) {
  90                         printf(" %s", sha1_to_hex(children->item->object.sha1));
  91                         children = children->next;
  92                 }
  93         }
  94         show_decorations(&revs, commit);
  95         if (revs.commit_format == CMIT_FMT_ONELINE)
  96                 putchar(' ');
  97         else
  98                 putchar('\n');
  99
 100         if (revs.verbose_header && commit->buffer) {
 101                 struct strbuf buf = STRBUF_INIT;
 102                 pretty_print_commit(revs.commit_format, commit,
 103                                     &buf, revs.abbrev, NULL, NULL,
 104                                     revs.date_mode, 0);
 105                 if (revs.graph) {
 106                         if (buf.len) {
 107                                 if (revs.commit_format != CMIT_FMT_ONELINE)
 108                                         graph_show_oneline(revs.graph);
 109
 110                                 graph_show_commit_msg(revs.graph, &buf);
 111
 112                                 /*
 113                                  * Add a newline after the commit message.
 114                                  *
 115                                  * Usually, this newline produces a blank
 116                                  * padding line between entries, in which case
 117                                  * we need to add graph padding on this line.
 118                                  *
 119                                  * However, the commit message may not end in a
 120                                  * newline.  In this case the newline simply
 121                                  * ends the last line of the commit message,
 122                                  * and we don't need any graph output.  (This
 123                                  * always happens with CMIT_FMT_ONELINE, and it
 124                                  * happens with CMIT_FMT_USERFORMAT when the
 125                                  * format doesn't explicitly end in a newline.)
 126                                  */
 127                                 if (buf.len && buf.buf[buf.len - 1] == '\n')
 128                                         graph_show_padding(revs.graph);
 129                                 putchar('\n');
 130                         } else {
 131                                 /*
 132                                  * If the message buffer is empty, just show
 133                                  * the rest of the graph output for this
 134                                  * commit.
 135                                  */
 136                                 if (graph_show_remainder(revs.graph))
 137                                         putchar('\n');
 138                         }
 139                 } else {
 140                         if (buf.len)
 141                                 printf("%s%c", buf.buf, hdr_termination);
 142                 }
 143                 strbuf_release(&buf);
 144         } else {
 145                 if (graph_show_remainder(revs.graph))
 146                         putchar('\n');
 147         }
 148         maybe_flush_or_die(stdout, "stdout");
 149         finish_commit(commit);
 150 }
 151
 152 static void finish_commit(struct commit *commit)
 153 {
 154         if (commit->parents) {
 155                 free_commit_list(commit->parents);
 156                 commit->parents = NULL;
 157         }
 158         free(commit->buffer);
 159         commit->buffer = NULL;
 160 }
 161
 162 static void finish_object(struct object_array_entry *p)
 163 {
 164         if (p->item->type == OBJ_BLOB && !has_sha1_file(p->item->sha1))
 165                 die("missing blob object '%s'", sha1_to_hex(p->item->sha1));
 166 }
 167
 168 static void show_object(struct object_array_entry *p)
 169 {
 170         /* An object with name "foo\n0000000..." can be used to
 171          * confuse downstream "git pack-objects" very badly.
 172          */
 173         const char *ep = strchr(p->name, '\n');
 174
 175         finish_object(p);
 176         if (ep) {
 177                 printf("%s %.*s\n", sha1_to_hex(p->item->sha1),
 178                        (int) (ep - p->name),
 179                        p->name);
 180         }
 181         else
 182                 printf("%s %s\n", sha1_to_hex(p->item->sha1), p->name);
 183 }
 184
 185 static void show_edge(struct commit *commit)
 186 {
 187         printf("-%s\n", sha1_to_hex(commit->object.sha1));
 188 }
 189
 190 static inline int log2i(int n)
 191 {
 192         int log2 = 0;
 193
 194         for (; n > 1; n >>= 1)
 195                 log2++;
 196
 197         return log2;
 198 }
 199
 200 static inline int exp2i(int n)
 201 {
 202         return 1 << n;
 203 }
 204
 205 /*
 206  * Estimate the number of bisect steps left (after the current step)
 207  *
 208  * For any x between 0 included and 2^n excluded, the probability for
 209  * n - 1 steps left looks like:
 210  *
 211  * P(2^n + x) == (2^n - x) / (2^n + x)
 212  *
 213  * and P(2^n + x) < 0.5 means 2^n < 3x
 214  */
 215 static int estimate_bisect_steps(int all)
 216 {
 217         int n, x, e;
 218
 219         if (all < 3)
 220                 return 0;
 221
 222         n = log2i(all);
 223         e = exp2i(n);
 224         x = all - e;
 225
 226         return (e < 3 * x) ? n : n - 1;
 227 }
 228
 229 int show_bisect_vars(struct rev_info *revs, int reaches, int all, int show_all)
 230 {
 231         int cnt;
 232         char hex[41];
 233
 234         if (!revs->commits)
 235                 return 1;
 236
 237         /*
 238          * revs->commits can reach "reaches" commits among
 239          * "all" commits.  If it is good, then there are
 240          * (all-reaches) commits left to be bisected.
 241          * On the other hand, if it is bad, then the set
 242          * to bisect is "reaches".
 243          * A bisect set of size N has (N-1) commits further
 244          * to test, as we already know one bad one.
 245          */
 246         cnt = all - reaches;
 247         if (cnt < reaches)
 248                 cnt = reaches;
 249
 250         strcpy(hex, sha1_to_hex(revs->commits->item->object.sha1));
 251
 252         if (show_all) {
 253                 traverse_commit_list(revs, show_commit, show_object);
 254                 printf("------\n");
 255         }
 256
 257         printf("bisect_rev=%s\n"
 258                "bisect_nr=%d\n"
 259                "bisect_good=%d\n"
 260                "bisect_bad=%d\n"
 261                "bisect_all=%d\n"
 262                "bisect_steps=%d\n",
 263                hex,
 264                cnt - 1,
 265                all - reaches - 1,
 266                reaches - 1,
 267                all,
 268                estimate_bisect_steps(all));
 269
 270         return 0;
 271 }
 272
 273 int cmd_rev_list(int argc, const char **argv, const char *prefix)
 274 {
 275         struct commit_list *list;
 276         int i;
 277         int read_from_stdin = 0;
 278         int bisect_list = 0;
 279         int bisect_show_vars = 0;
 280         int bisect_find_all = 0;
 281         int quiet = 0;
 282
 283         git_config(git_default_config, NULL);
 284         init_revisions(&revs, prefix);
 285         revs.abbrev = 0;
 286         revs.commit_format = CMIT_FMT_UNSPECIFIED;
 287         argc = setup_revisions(argc, argv, &revs, NULL);
 288
 289         quiet = DIFF_OPT_TST(&revs.diffopt, QUIET);
 290         for (i = 1 ; i < argc; i++) {
 291                 const char *arg = argv[i];
 292
 293                 if (!strcmp(arg, "--header")) {
 294                         revs.verbose_header = 1;
 295                         continue;
 296                 }
 297                 if (!strcmp(arg, "--timestamp")) {
 298                         show_timestamp = 1;
 299                         continue;
 300                 }
 301                 if (!strcmp(arg, "--bisect")) {
 302                         bisect_list = 1;
 303                         continue;
 304                 }
 305                 if (!strcmp(arg, "--bisect-all")) {
 306                         bisect_list = 1;
 307                         bisect_find_all = 1;
 308                         revs.show_decorations = 1;
 309                         continue;
 310                 }
 311                 if (!strcmp(arg, "--bisect-vars")) {
 312                         bisect_list = 1;
 313                         bisect_show_vars = 1;
 314                         continue;
 315                 }
 316                 if (!strcmp(arg, "--stdin")) {
 317                         if (read_from_stdin++)
 318                                 die("--stdin given twice?");
 319                         read_revisions_from_stdin(&revs);
 320                         continue;
 321                 }
 322                 usage(rev_list_usage);
 323
 324         }
 325         if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
 326                 /* The command line has a --pretty  */
 327                 hdr_termination = '\n';
 328                 if (revs.commit_format == CMIT_FMT_ONELINE)
 329                         header_prefix = "";
 330                 else
 331                         header_prefix = "commit ";
 332         }
 333         else if (revs.verbose_header)
 334                 /* Only --header was specified */
 335                 revs.commit_format = CMIT_FMT_RAW;
 336
 337         list = revs.commits;
 338
 339         if ((!list &&
 340              (!(revs.tag_objects||revs.tree_objects||revs.blob_objects) &&
 341               !revs.pending.nr)) ||
 342             revs.diff)
 343                 usage(rev_list_usage);
 344
 345         save_commit_buffer = revs.verbose_header ||
 346                 revs.grep_filter.pattern_list;
 347         if (bisect_list)
 348                 revs.limited = 1;
 349
 350         if (prepare_revision_walk(&revs))
 351                 die("revision walk setup failed");
 352         if (revs.tree_objects)
 353                 mark_edges_uninteresting(revs.commits, &revs, show_edge);
 354
 355         if (bisect_list) {
 356                 int reaches = reaches, all = all;
 357
 358                 revs.commits = find_bisection(revs.commits, &reaches, &all,
 359                                               bisect_find_all);
 360                 if (bisect_show_vars)
 361                         return show_bisect_vars(&revs, reaches, all,
 362                                                 bisect_find_all);
 363         }
 364
 365         traverse_commit_list(&revs,
 366                 quiet ? finish_commit : show_commit,
 367                 quiet ? finish_object : show_object);
 368
 369         return 0;
 370 }