Merge branch 'js/typofixes'
[git] / builtin / rev-list.c
1 #include "cache.h"
2 #include "config.h"
3 #include "commit.h"
4 #include "diff.h"
5 #include "revision.h"
6 #include "list-objects.h"
7 #include "list-objects-filter.h"
8 #include "list-objects-filter-options.h"
9 #include "object-store.h"
10 #include "pack.h"
11 #include "pack-bitmap.h"
12 #include "builtin.h"
13 #include "log-tree.h"
14 #include "graph.h"
15 #include "bisect.h"
16 #include "progress.h"
17 #include "reflog-walk.h"
18 #include "oidset.h"
19 #include "packfile.h"
20 #include "object-store.h"
21
22 static const char rev_list_usage[] =
23 "git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
24 "  limiting output:\n"
25 "    --max-count=<n>\n"
26 "    --max-age=<epoch>\n"
27 "    --min-age=<epoch>\n"
28 "    --sparse\n"
29 "    --no-merges\n"
30 "    --min-parents=<n>\n"
31 "    --no-min-parents\n"
32 "    --max-parents=<n>\n"
33 "    --no-max-parents\n"
34 "    --remove-empty\n"
35 "    --all\n"
36 "    --branches\n"
37 "    --tags\n"
38 "    --remotes\n"
39 "    --stdin\n"
40 "    --quiet\n"
41 "  ordering output:\n"
42 "    --topo-order\n"
43 "    --date-order\n"
44 "    --reverse\n"
45 "  formatting output:\n"
46 "    --parents\n"
47 "    --children\n"
48 "    --objects | --objects-edge\n"
49 "    --unpacked\n"
50 "    --header | --pretty\n"
51 "    --abbrev=<n> | --no-abbrev\n"
52 "    --abbrev-commit\n"
53 "    --left-right\n"
54 "    --count\n"
55 "  special purpose:\n"
56 "    --bisect\n"
57 "    --bisect-vars\n"
58 "    --bisect-all"
59 ;
60
61 static struct progress *progress;
62 static unsigned progress_counter;
63
64 static struct list_objects_filter_options filter_options;
65 static struct oidset omitted_objects;
66 static int arg_print_omitted; /* print objects omitted by filter */
67
68 static struct oidset missing_objects;
69 enum missing_action {
70         MA_ERROR = 0,    /* fail if any missing objects are encountered */
71         MA_ALLOW_ANY,    /* silently allow ALL missing objects */
72         MA_PRINT,        /* print ALL missing objects in special section */
73         MA_ALLOW_PROMISOR, /* silently allow all missing PROMISOR objects */
74 };
75 static enum missing_action arg_missing_action;
76
77 #define DEFAULT_OIDSET_SIZE     (16*1024)
78
79 static void finish_commit(struct commit *commit, void *data);
80 static void show_commit(struct commit *commit, void *data)
81 {
82         struct rev_list_info *info = data;
83         struct rev_info *revs = info->revs;
84
85         display_progress(progress, ++progress_counter);
86
87         if (info->flags & REV_LIST_QUIET) {
88                 finish_commit(commit, data);
89                 return;
90         }
91
92         graph_show_commit(revs->graph);
93
94         if (revs->count) {
95                 if (commit->object.flags & PATCHSAME)
96                         revs->count_same++;
97                 else if (commit->object.flags & SYMMETRIC_LEFT)
98                         revs->count_left++;
99                 else
100                         revs->count_right++;
101                 finish_commit(commit, data);
102                 return;
103         }
104
105         if (info->show_timestamp)
106                 printf("%"PRItime" ", commit->date);
107         if (info->header_prefix)
108                 fputs(info->header_prefix, stdout);
109
110         if (!revs->graph)
111                 fputs(get_revision_mark(revs, commit), stdout);
112         if (revs->abbrev_commit && revs->abbrev)
113                 fputs(find_unique_abbrev(&commit->object.oid, revs->abbrev),
114                       stdout);
115         else
116                 fputs(oid_to_hex(&commit->object.oid), stdout);
117         if (revs->print_parents) {
118                 struct commit_list *parents = commit->parents;
119                 while (parents) {
120                         printf(" %s", oid_to_hex(&parents->item->object.oid));
121                         parents = parents->next;
122                 }
123         }
124         if (revs->children.name) {
125                 struct commit_list *children;
126
127                 children = lookup_decoration(&revs->children, &commit->object);
128                 while (children) {
129                         printf(" %s", oid_to_hex(&children->item->object.oid));
130                         children = children->next;
131                 }
132         }
133         show_decorations(revs, commit);
134         if (revs->commit_format == CMIT_FMT_ONELINE)
135                 putchar(' ');
136         else
137                 putchar('\n');
138
139         if (revs->verbose_header) {
140                 struct strbuf buf = STRBUF_INIT;
141                 struct pretty_print_context ctx = {0};
142                 ctx.abbrev = revs->abbrev;
143                 ctx.date_mode = revs->date_mode;
144                 ctx.date_mode_explicit = revs->date_mode_explicit;
145                 ctx.fmt = revs->commit_format;
146                 ctx.output_encoding = get_log_output_encoding();
147                 ctx.color = revs->diffopt.use_color;
148                 pretty_print_commit(&ctx, commit, &buf);
149                 if (buf.len) {
150                         if (revs->commit_format != CMIT_FMT_ONELINE)
151                                 graph_show_oneline(revs->graph);
152
153                         graph_show_commit_msg(revs->graph, stdout, &buf);
154
155                         /*
156                          * Add a newline after the commit message.
157                          *
158                          * Usually, this newline produces a blank
159                          * padding line between entries, in which case
160                          * we need to add graph padding on this line.
161                          *
162                          * However, the commit message may not end in a
163                          * newline.  In this case the newline simply
164                          * ends the last line of the commit message,
165                          * and we don't need any graph output.  (This
166                          * always happens with CMIT_FMT_ONELINE, and it
167                          * happens with CMIT_FMT_USERFORMAT when the
168                          * format doesn't explicitly end in a newline.)
169                          */
170                         if (buf.len && buf.buf[buf.len - 1] == '\n')
171                                 graph_show_padding(revs->graph);
172                         putchar(info->hdr_termination);
173                 } else {
174                         /*
175                          * If the message buffer is empty, just show
176                          * the rest of the graph output for this
177                          * commit.
178                          */
179                         if (graph_show_remainder(revs->graph))
180                                 putchar('\n');
181                         if (revs->commit_format == CMIT_FMT_ONELINE)
182                                 putchar('\n');
183                 }
184                 strbuf_release(&buf);
185         } else {
186                 if (graph_show_remainder(revs->graph))
187                         putchar('\n');
188         }
189         maybe_flush_or_die(stdout, "stdout");
190         finish_commit(commit, data);
191 }
192
193 static void finish_commit(struct commit *commit, void *data)
194 {
195         if (commit->parents) {
196                 free_commit_list(commit->parents);
197                 commit->parents = NULL;
198         }
199         free_commit_buffer(commit);
200 }
201
202 static inline void finish_object__ma(struct object *obj)
203 {
204         /*
205          * Whether or not we try to dynamically fetch missing objects
206          * from the server, we currently DO NOT have the object.  We
207          * can either print, allow (ignore), or conditionally allow
208          * (ignore) them.
209          */
210         switch (arg_missing_action) {
211         case MA_ERROR:
212                 die("missing blob object '%s'", oid_to_hex(&obj->oid));
213                 return;
214
215         case MA_ALLOW_ANY:
216                 return;
217
218         case MA_PRINT:
219                 oidset_insert(&missing_objects, &obj->oid);
220                 return;
221
222         case MA_ALLOW_PROMISOR:
223                 if (is_promisor_object(&obj->oid))
224                         return;
225                 die("unexpected missing blob object '%s'",
226                     oid_to_hex(&obj->oid));
227                 return;
228
229         default:
230                 BUG("unhandled missing_action");
231                 return;
232         }
233 }
234
235 static int finish_object(struct object *obj, const char *name, void *cb_data)
236 {
237         struct rev_list_info *info = cb_data;
238         if (obj->type == OBJ_BLOB && !has_object_file(&obj->oid)) {
239                 finish_object__ma(obj);
240                 return 1;
241         }
242         if (info->revs->verify_objects && !obj->parsed && obj->type != OBJ_COMMIT)
243                 parse_object(the_repository, &obj->oid);
244         return 0;
245 }
246
247 static void show_object(struct object *obj, const char *name, void *cb_data)
248 {
249         struct rev_list_info *info = cb_data;
250         if (finish_object(obj, name, cb_data))
251                 return;
252         display_progress(progress, ++progress_counter);
253         if (info->flags & REV_LIST_QUIET)
254                 return;
255         show_object_with_name(stdout, obj, name);
256 }
257
258 static void show_edge(struct commit *commit)
259 {
260         printf("-%s\n", oid_to_hex(&commit->object.oid));
261 }
262
263 static void print_var_str(const char *var, const char *val)
264 {
265         printf("%s='%s'\n", var, val);
266 }
267
268 static void print_var_int(const char *var, int val)
269 {
270         printf("%s=%d\n", var, val);
271 }
272
273 static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
274 {
275         int cnt, flags = info->flags;
276         char hex[GIT_MAX_HEXSZ + 1] = "";
277         struct commit_list *tried;
278         struct rev_info *revs = info->revs;
279
280         if (!revs->commits)
281                 return 1;
282
283         revs->commits = filter_skipped(revs->commits, &tried,
284                                        flags & BISECT_SHOW_ALL,
285                                        NULL, NULL);
286
287         /*
288          * revs->commits can reach "reaches" commits among
289          * "all" commits.  If it is good, then there are
290          * (all-reaches) commits left to be bisected.
291          * On the other hand, if it is bad, then the set
292          * to bisect is "reaches".
293          * A bisect set of size N has (N-1) commits further
294          * to test, as we already know one bad one.
295          */
296         cnt = all - reaches;
297         if (cnt < reaches)
298                 cnt = reaches;
299
300         if (revs->commits)
301                 oid_to_hex_r(hex, &revs->commits->item->object.oid);
302
303         if (flags & BISECT_SHOW_ALL) {
304                 traverse_commit_list(revs, show_commit, show_object, info);
305                 printf("------\n");
306         }
307
308         print_var_str("bisect_rev", hex);
309         print_var_int("bisect_nr", cnt - 1);
310         print_var_int("bisect_good", all - reaches - 1);
311         print_var_int("bisect_bad", reaches - 1);
312         print_var_int("bisect_all", all);
313         print_var_int("bisect_steps", estimate_bisect_steps(all));
314
315         return 0;
316 }
317
318 static int show_object_fast(
319         const struct object_id *oid,
320         enum object_type type,
321         int exclude,
322         uint32_t name_hash,
323         struct packed_git *found_pack,
324         off_t found_offset)
325 {
326         fprintf(stdout, "%s\n", oid_to_hex(oid));
327         return 1;
328 }
329
330 static inline int parse_missing_action_value(const char *value)
331 {
332         if (!strcmp(value, "error")) {
333                 arg_missing_action = MA_ERROR;
334                 return 1;
335         }
336
337         if (!strcmp(value, "allow-any")) {
338                 arg_missing_action = MA_ALLOW_ANY;
339                 fetch_if_missing = 0;
340                 return 1;
341         }
342
343         if (!strcmp(value, "print")) {
344                 arg_missing_action = MA_PRINT;
345                 fetch_if_missing = 0;
346                 return 1;
347         }
348
349         if (!strcmp(value, "allow-promisor")) {
350                 arg_missing_action = MA_ALLOW_PROMISOR;
351                 fetch_if_missing = 0;
352                 return 1;
353         }
354
355         return 0;
356 }
357
358 int cmd_rev_list(int argc, const char **argv, const char *prefix)
359 {
360         struct rev_info revs;
361         struct rev_list_info info;
362         int i;
363         int bisect_list = 0;
364         int bisect_show_vars = 0;
365         int bisect_find_all = 0;
366         int use_bitmap_index = 0;
367         const char *show_progress = NULL;
368
369         if (argc == 2 && !strcmp(argv[1], "-h"))
370                 usage(rev_list_usage);
371
372         git_config(git_default_config, NULL);
373         init_revisions(&revs, prefix);
374         revs.abbrev = DEFAULT_ABBREV;
375         revs.commit_format = CMIT_FMT_UNSPECIFIED;
376
377         /*
378          * Scan the argument list before invoking setup_revisions(), so that we
379          * know if fetch_if_missing needs to be set to 0.
380          *
381          * "--exclude-promisor-objects" acts as a pre-filter on missing objects
382          * by not crossing the boundary from realized objects to promisor
383          * objects.
384          *
385          * Let "--missing" to conditionally set fetch_if_missing.
386          */
387         for (i = 1; i < argc; i++) {
388                 const char *arg = argv[i];
389                 if (!strcmp(arg, "--exclude-promisor-objects")) {
390                         fetch_if_missing = 0;
391                         revs.exclude_promisor_objects = 1;
392                         break;
393                 }
394         }
395         for (i = 1; i < argc; i++) {
396                 const char *arg = argv[i];
397                 if (skip_prefix(arg, "--missing=", &arg)) {
398                         if (revs.exclude_promisor_objects)
399                                 die(_("cannot combine --exclude-promisor-objects and --missing"));
400                         if (parse_missing_action_value(arg))
401                                 break;
402                 }
403         }
404
405         argc = setup_revisions(argc, argv, &revs, NULL);
406
407         memset(&info, 0, sizeof(info));
408         info.revs = &revs;
409         if (revs.bisect)
410                 bisect_list = 1;
411
412         if (revs.diffopt.flags.quick)
413                 info.flags |= REV_LIST_QUIET;
414         for (i = 1 ; i < argc; i++) {
415                 const char *arg = argv[i];
416
417                 if (!strcmp(arg, "--header")) {
418                         revs.verbose_header = 1;
419                         continue;
420                 }
421                 if (!strcmp(arg, "--timestamp")) {
422                         info.show_timestamp = 1;
423                         continue;
424                 }
425                 if (!strcmp(arg, "--bisect")) {
426                         bisect_list = 1;
427                         continue;
428                 }
429                 if (!strcmp(arg, "--bisect-all")) {
430                         bisect_list = 1;
431                         bisect_find_all = 1;
432                         info.flags |= BISECT_SHOW_ALL;
433                         revs.show_decorations = 1;
434                         continue;
435                 }
436                 if (!strcmp(arg, "--bisect-vars")) {
437                         bisect_list = 1;
438                         bisect_show_vars = 1;
439                         continue;
440                 }
441                 if (!strcmp(arg, "--use-bitmap-index")) {
442                         use_bitmap_index = 1;
443                         continue;
444                 }
445                 if (!strcmp(arg, "--test-bitmap")) {
446                         test_bitmap_walk(&revs);
447                         return 0;
448                 }
449                 if (skip_prefix(arg, "--progress=", &arg)) {
450                         show_progress = arg;
451                         continue;
452                 }
453
454                 if (skip_prefix(arg, ("--" CL_ARG__FILTER "="), &arg)) {
455                         parse_list_objects_filter(&filter_options, arg);
456                         if (filter_options.choice && !revs.blob_objects)
457                                 die(_("object filtering requires --objects"));
458                         if (filter_options.choice == LOFC_SPARSE_OID &&
459                             !filter_options.sparse_oid_value)
460                                 die(_("invalid sparse value '%s'"),
461                                     filter_options.filter_spec);
462                         continue;
463                 }
464                 if (!strcmp(arg, ("--no-" CL_ARG__FILTER))) {
465                         list_objects_filter_set_no_filter(&filter_options);
466                         continue;
467                 }
468                 if (!strcmp(arg, "--filter-print-omitted")) {
469                         arg_print_omitted = 1;
470                         continue;
471                 }
472
473                 if (!strcmp(arg, "--exclude-promisor-objects"))
474                         continue; /* already handled above */
475                 if (skip_prefix(arg, "--missing=", &arg))
476                         continue; /* already handled above */
477
478                 usage(rev_list_usage);
479
480         }
481         if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
482                 /* The command line has a --pretty  */
483                 info.hdr_termination = '\n';
484                 if (revs.commit_format == CMIT_FMT_ONELINE)
485                         info.header_prefix = "";
486                 else
487                         info.header_prefix = "commit ";
488         }
489         else if (revs.verbose_header)
490                 /* Only --header was specified */
491                 revs.commit_format = CMIT_FMT_RAW;
492
493         if ((!revs.commits && reflog_walk_empty(revs.reflog_info) &&
494              (!(revs.tag_objects || revs.tree_objects || revs.blob_objects) &&
495               !revs.pending.nr) &&
496              !revs.rev_input_given) ||
497             revs.diff)
498                 usage(rev_list_usage);
499
500         if (revs.show_notes)
501                 die(_("rev-list does not support display of notes"));
502
503         if (filter_options.choice && use_bitmap_index)
504                 die(_("cannot combine --use-bitmap-index with object filtering"));
505
506         save_commit_buffer = (revs.verbose_header ||
507                               revs.grep_filter.pattern_list ||
508                               revs.grep_filter.header_list);
509         if (bisect_list)
510                 revs.limited = 1;
511
512         if (show_progress)
513                 progress = start_delayed_progress(show_progress, 0);
514
515         if (use_bitmap_index && !revs.prune) {
516                 if (revs.count && !revs.left_right && !revs.cherry_mark) {
517                         uint32_t commit_count;
518                         int max_count = revs.max_count;
519                         struct bitmap_index *bitmap_git;
520                         if ((bitmap_git = prepare_bitmap_walk(&revs))) {
521                                 count_bitmap_commit_list(bitmap_git, &commit_count, NULL, NULL, NULL);
522                                 if (max_count >= 0 && max_count < commit_count)
523                                         commit_count = max_count;
524                                 printf("%d\n", commit_count);
525                                 free_bitmap_index(bitmap_git);
526                                 return 0;
527                         }
528                 } else if (revs.max_count < 0 &&
529                            revs.tag_objects && revs.tree_objects && revs.blob_objects) {
530                         struct bitmap_index *bitmap_git;
531                         if ((bitmap_git = prepare_bitmap_walk(&revs))) {
532                                 traverse_bitmap_commit_list(bitmap_git, &show_object_fast);
533                                 free_bitmap_index(bitmap_git);
534                                 return 0;
535                         }
536                 }
537         }
538
539         if (prepare_revision_walk(&revs))
540                 die("revision walk setup failed");
541         if (revs.tree_objects)
542                 mark_edges_uninteresting(&revs, show_edge);
543
544         if (bisect_list) {
545                 int reaches, all;
546
547                 find_bisection(&revs.commits, &reaches, &all, bisect_find_all);
548
549                 if (bisect_show_vars)
550                         return show_bisect_vars(&info, reaches, all);
551         }
552
553         if (arg_print_omitted)
554                 oidset_init(&omitted_objects, DEFAULT_OIDSET_SIZE);
555         if (arg_missing_action == MA_PRINT)
556                 oidset_init(&missing_objects, DEFAULT_OIDSET_SIZE);
557
558         traverse_commit_list_filtered(
559                 &filter_options, &revs, show_commit, show_object, &info,
560                 (arg_print_omitted ? &omitted_objects : NULL));
561
562         if (arg_print_omitted) {
563                 struct oidset_iter iter;
564                 struct object_id *oid;
565                 oidset_iter_init(&omitted_objects, &iter);
566                 while ((oid = oidset_iter_next(&iter)))
567                         printf("~%s\n", oid_to_hex(oid));
568                 oidset_clear(&omitted_objects);
569         }
570         if (arg_missing_action == MA_PRINT) {
571                 struct oidset_iter iter;
572                 struct object_id *oid;
573                 oidset_iter_init(&missing_objects, &iter);
574                 while ((oid = oidset_iter_next(&iter)))
575                         printf("?%s\n", oid_to_hex(oid));
576                 oidset_clear(&missing_objects);
577         }
578
579         stop_progress(&progress);
580
581         if (revs.count) {
582                 if (revs.left_right && revs.cherry_mark)
583                         printf("%d\t%d\t%d\n", revs.count_left, revs.count_right, revs.count_same);
584                 else if (revs.left_right)
585                         printf("%d\t%d\n", revs.count_left, revs.count_right);
586                 else if (revs.cherry_mark)
587                         printf("%d\t%d\n", revs.count_left + revs.count_right, revs.count_same);
588                 else
589                         printf("%d\n", revs.count_left + revs.count_right);
590         }
591
592         return 0;
593 }