rev-list: add optional progress reporting
[git.git] / builtin / rev-list.c
blob0ba82b1635b6380d9a7d9fd9a31471b8c8ac9f20
1 #include "cache.h"
2 #include "commit.h"
3 #include "diff.h"
4 #include "revision.h"
5 #include "list-objects.h"
6 #include "pack.h"
7 #include "pack-bitmap.h"
8 #include "builtin.h"
9 #include "log-tree.h"
10 #include "graph.h"
11 #include "bisect.h"
12 #include "progress.h"
14 static const char rev_list_usage[] =
15 "git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
16 " limiting output:\n"
17 " --max-count=<n>\n"
18 " --max-age=<epoch>\n"
19 " --min-age=<epoch>\n"
20 " --sparse\n"
21 " --no-merges\n"
22 " --min-parents=<n>\n"
23 " --no-min-parents\n"
24 " --max-parents=<n>\n"
25 " --no-max-parents\n"
26 " --remove-empty\n"
27 " --all\n"
28 " --branches\n"
29 " --tags\n"
30 " --remotes\n"
31 " --stdin\n"
32 " --quiet\n"
33 " ordering output:\n"
34 " --topo-order\n"
35 " --date-order\n"
36 " --reverse\n"
37 " formatting output:\n"
38 " --parents\n"
39 " --children\n"
40 " --objects | --objects-edge\n"
41 " --unpacked\n"
42 " --header | --pretty\n"
43 " --abbrev=<n> | --no-abbrev\n"
44 " --abbrev-commit\n"
45 " --left-right\n"
46 " --count\n"
47 " special purpose:\n"
48 " --bisect\n"
49 " --bisect-vars\n"
50 " --bisect-all"
53 static struct progress *progress;
54 static unsigned progress_counter;
56 static void finish_commit(struct commit *commit, void *data);
57 static void show_commit(struct commit *commit, void *data)
59 struct rev_list_info *info = data;
60 struct rev_info *revs = info->revs;
62 display_progress(progress, ++progress_counter);
64 if (info->flags & REV_LIST_QUIET) {
65 finish_commit(commit, data);
66 return;
69 graph_show_commit(revs->graph);
71 if (revs->count) {
72 if (commit->object.flags & PATCHSAME)
73 revs->count_same++;
74 else if (commit->object.flags & SYMMETRIC_LEFT)
75 revs->count_left++;
76 else
77 revs->count_right++;
78 finish_commit(commit, data);
79 return;
82 if (info->show_timestamp)
83 printf("%lu ", commit->date);
84 if (info->header_prefix)
85 fputs(info->header_prefix, stdout);
87 if (!revs->graph)
88 fputs(get_revision_mark(revs, commit), stdout);
89 if (revs->abbrev_commit && revs->abbrev)
90 fputs(find_unique_abbrev(commit->object.oid.hash, revs->abbrev),
91 stdout);
92 else
93 fputs(oid_to_hex(&commit->object.oid), stdout);
94 if (revs->print_parents) {
95 struct commit_list *parents = commit->parents;
96 while (parents) {
97 printf(" %s", oid_to_hex(&parents->item->object.oid));
98 parents = parents->next;
101 if (revs->children.name) {
102 struct commit_list *children;
104 children = lookup_decoration(&revs->children, &commit->object);
105 while (children) {
106 printf(" %s", oid_to_hex(&children->item->object.oid));
107 children = children->next;
110 show_decorations(revs, commit);
111 if (revs->commit_format == CMIT_FMT_ONELINE)
112 putchar(' ');
113 else
114 putchar('\n');
116 if (revs->verbose_header && get_cached_commit_buffer(commit, NULL)) {
117 struct strbuf buf = STRBUF_INIT;
118 struct pretty_print_context ctx = {0};
119 ctx.abbrev = revs->abbrev;
120 ctx.date_mode = revs->date_mode;
121 ctx.date_mode_explicit = revs->date_mode_explicit;
122 ctx.fmt = revs->commit_format;
123 ctx.output_encoding = get_log_output_encoding();
124 pretty_print_commit(&ctx, commit, &buf);
125 if (revs->graph) {
126 if (buf.len) {
127 if (revs->commit_format != CMIT_FMT_ONELINE)
128 graph_show_oneline(revs->graph);
130 graph_show_commit_msg(revs->graph, &buf);
133 * Add a newline after the commit message.
135 * Usually, this newline produces a blank
136 * padding line between entries, in which case
137 * we need to add graph padding on this line.
139 * However, the commit message may not end in a
140 * newline. In this case the newline simply
141 * ends the last line of the commit message,
142 * and we don't need any graph output. (This
143 * always happens with CMIT_FMT_ONELINE, and it
144 * happens with CMIT_FMT_USERFORMAT when the
145 * format doesn't explicitly end in a newline.)
147 if (buf.len && buf.buf[buf.len - 1] == '\n')
148 graph_show_padding(revs->graph);
149 putchar('\n');
150 } else {
152 * If the message buffer is empty, just show
153 * the rest of the graph output for this
154 * commit.
156 if (graph_show_remainder(revs->graph))
157 putchar('\n');
158 if (revs->commit_format == CMIT_FMT_ONELINE)
159 putchar('\n');
161 } else {
162 if (revs->commit_format != CMIT_FMT_USERFORMAT ||
163 buf.len) {
164 fwrite(buf.buf, 1, buf.len, stdout);
165 putchar(info->hdr_termination);
168 strbuf_release(&buf);
169 } else {
170 if (graph_show_remainder(revs->graph))
171 putchar('\n');
173 maybe_flush_or_die(stdout, "stdout");
174 finish_commit(commit, data);
177 static void finish_commit(struct commit *commit, void *data)
179 if (commit->parents) {
180 free_commit_list(commit->parents);
181 commit->parents = NULL;
183 free_commit_buffer(commit);
186 static void finish_object(struct object *obj, const char *name, void *cb_data)
188 struct rev_list_info *info = cb_data;
189 if (obj->type == OBJ_BLOB && !has_object_file(&obj->oid))
190 die("missing blob object '%s'", oid_to_hex(&obj->oid));
191 if (info->revs->verify_objects && !obj->parsed && obj->type != OBJ_COMMIT)
192 parse_object(obj->oid.hash);
195 static void show_object(struct object *obj, const char *name, void *cb_data)
197 struct rev_list_info *info = cb_data;
198 finish_object(obj, name, cb_data);
199 display_progress(progress, ++progress_counter);
200 if (info->flags & REV_LIST_QUIET)
201 return;
202 show_object_with_name(stdout, obj, name);
205 static void show_edge(struct commit *commit)
207 printf("-%s\n", oid_to_hex(&commit->object.oid));
210 static void print_var_str(const char *var, const char *val)
212 printf("%s='%s'\n", var, val);
215 static void print_var_int(const char *var, int val)
217 printf("%s=%d\n", var, val);
220 static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
222 int cnt, flags = info->flags;
223 char hex[GIT_SHA1_HEXSZ + 1] = "";
224 struct commit_list *tried;
225 struct rev_info *revs = info->revs;
227 if (!revs->commits)
228 return 1;
230 revs->commits = filter_skipped(revs->commits, &tried,
231 flags & BISECT_SHOW_ALL,
232 NULL, NULL);
235 * revs->commits can reach "reaches" commits among
236 * "all" commits. If it is good, then there are
237 * (all-reaches) commits left to be bisected.
238 * On the other hand, if it is bad, then the set
239 * to bisect is "reaches".
240 * A bisect set of size N has (N-1) commits further
241 * to test, as we already know one bad one.
243 cnt = all - reaches;
244 if (cnt < reaches)
245 cnt = reaches;
247 if (revs->commits)
248 sha1_to_hex_r(hex, revs->commits->item->object.oid.hash);
250 if (flags & BISECT_SHOW_ALL) {
251 traverse_commit_list(revs, show_commit, show_object, info);
252 printf("------\n");
255 print_var_str("bisect_rev", hex);
256 print_var_int("bisect_nr", cnt - 1);
257 print_var_int("bisect_good", all - reaches - 1);
258 print_var_int("bisect_bad", reaches - 1);
259 print_var_int("bisect_all", all);
260 print_var_int("bisect_steps", estimate_bisect_steps(all));
262 return 0;
265 static int show_object_fast(
266 const unsigned char *sha1,
267 enum object_type type,
268 int exclude,
269 uint32_t name_hash,
270 struct packed_git *found_pack,
271 off_t found_offset)
273 fprintf(stdout, "%s\n", sha1_to_hex(sha1));
274 return 1;
277 int cmd_rev_list(int argc, const char **argv, const char *prefix)
279 struct rev_info revs;
280 struct rev_list_info info;
281 int i;
282 int bisect_list = 0;
283 int bisect_show_vars = 0;
284 int bisect_find_all = 0;
285 int use_bitmap_index = 0;
286 const char *show_progress = NULL;
288 git_config(git_default_config, NULL);
289 init_revisions(&revs, prefix);
290 revs.abbrev = DEFAULT_ABBREV;
291 revs.commit_format = CMIT_FMT_UNSPECIFIED;
292 argc = setup_revisions(argc, argv, &revs, NULL);
294 memset(&info, 0, sizeof(info));
295 info.revs = &revs;
296 if (revs.bisect)
297 bisect_list = 1;
299 if (DIFF_OPT_TST(&revs.diffopt, QUICK))
300 info.flags |= REV_LIST_QUIET;
301 for (i = 1 ; i < argc; i++) {
302 const char *arg = argv[i];
304 if (!strcmp(arg, "--header")) {
305 revs.verbose_header = 1;
306 continue;
308 if (!strcmp(arg, "--timestamp")) {
309 info.show_timestamp = 1;
310 continue;
312 if (!strcmp(arg, "--bisect")) {
313 bisect_list = 1;
314 continue;
316 if (!strcmp(arg, "--bisect-all")) {
317 bisect_list = 1;
318 bisect_find_all = 1;
319 info.flags |= BISECT_SHOW_ALL;
320 revs.show_decorations = 1;
321 continue;
323 if (!strcmp(arg, "--bisect-vars")) {
324 bisect_list = 1;
325 bisect_show_vars = 1;
326 continue;
328 if (!strcmp(arg, "--use-bitmap-index")) {
329 use_bitmap_index = 1;
330 continue;
332 if (!strcmp(arg, "--test-bitmap")) {
333 test_bitmap_walk(&revs);
334 return 0;
336 if (skip_prefix(arg, "--progress=", &arg)) {
337 show_progress = arg;
338 continue;
340 usage(rev_list_usage);
343 if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
344 /* The command line has a --pretty */
345 info.hdr_termination = '\n';
346 if (revs.commit_format == CMIT_FMT_ONELINE)
347 info.header_prefix = "";
348 else
349 info.header_prefix = "commit ";
351 else if (revs.verbose_header)
352 /* Only --header was specified */
353 revs.commit_format = CMIT_FMT_RAW;
355 if ((!revs.commits &&
356 (!(revs.tag_objects || revs.tree_objects || revs.blob_objects) &&
357 !revs.pending.nr)) ||
358 revs.diff)
359 usage(rev_list_usage);
361 if (revs.show_notes)
362 die(_("rev-list does not support display of notes"));
364 save_commit_buffer = (revs.verbose_header ||
365 revs.grep_filter.pattern_list ||
366 revs.grep_filter.header_list);
367 if (bisect_list)
368 revs.limited = 1;
370 if (show_progress)
371 progress = start_progress_delay(show_progress, 0, 0, 2);
373 if (use_bitmap_index && !revs.prune) {
374 if (revs.count && !revs.left_right && !revs.cherry_mark) {
375 uint32_t commit_count;
376 int max_count = revs.max_count;
377 if (!prepare_bitmap_walk(&revs)) {
378 count_bitmap_commit_list(&commit_count, NULL, NULL, NULL);
379 if (max_count >= 0 && max_count < commit_count)
380 commit_count = max_count;
381 printf("%d\n", commit_count);
382 return 0;
384 } else if (revs.max_count < 0 &&
385 revs.tag_objects && revs.tree_objects && revs.blob_objects) {
386 if (!prepare_bitmap_walk(&revs)) {
387 traverse_bitmap_commit_list(&show_object_fast);
388 return 0;
393 if (prepare_revision_walk(&revs))
394 die("revision walk setup failed");
395 if (revs.tree_objects)
396 mark_edges_uninteresting(&revs, show_edge);
398 if (bisect_list) {
399 int reaches = reaches, all = all;
401 revs.commits = find_bisection(revs.commits, &reaches, &all,
402 bisect_find_all);
404 if (bisect_show_vars)
405 return show_bisect_vars(&info, reaches, all);
408 traverse_commit_list(&revs, show_commit, show_object, &info);
410 stop_progress(&progress);
412 if (revs.count) {
413 if (revs.left_right && revs.cherry_mark)
414 printf("%d\t%d\t%d\n", revs.count_left, revs.count_right, revs.count_same);
415 else if (revs.left_right)
416 printf("%d\t%d\n", revs.count_left, revs.count_right);
417 else if (revs.cherry_mark)
418 printf("%d\t%d\n", revs.count_left + revs.count_right, revs.count_same);
419 else
420 printf("%d\n", revs.count_left + revs.count_right);
423 return 0;