Merge branch 'jn/doc-fast-import-no-16-octopus-limit' into maint
[git] / 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 "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
13 static const char rev_list_usage[] =
14 "git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
15 "  limiting output:\n"
16 "    --max-count=<n>\n"
17 "    --max-age=<epoch>\n"
18 "    --min-age=<epoch>\n"
19 "    --sparse\n"
20 "    --no-merges\n"
21 "    --min-parents=<n>\n"
22 "    --no-min-parents\n"
23 "    --max-parents=<n>\n"
24 "    --no-max-parents\n"
25 "    --remove-empty\n"
26 "    --all\n"
27 "    --branches\n"
28 "    --tags\n"
29 "    --remotes\n"
30 "    --stdin\n"
31 "    --quiet\n"
32 "  ordering output:\n"
33 "    --topo-order\n"
34 "    --date-order\n"
35 "    --reverse\n"
36 "  formatting output:\n"
37 "    --parents\n"
38 "    --children\n"
39 "    --objects | --objects-edge\n"
40 "    --unpacked\n"
41 "    --header | --pretty\n"
42 "    --abbrev=<n> | --no-abbrev\n"
43 "    --abbrev-commit\n"
44 "    --left-right\n"
45 "  special purpose:\n"
46 "    --bisect\n"
47 "    --bisect-vars\n"
48 "    --bisect-all"
49 ;
50
51 static void finish_commit(struct commit *commit, void *data);
52 static void show_commit(struct commit *commit, void *data)
53 {
54         struct rev_list_info *info = data;
55         struct rev_info *revs = info->revs;
56
57         if (info->flags & REV_LIST_QUIET) {
58                 finish_commit(commit, data);
59                 return;
60         }
61
62         graph_show_commit(revs->graph);
63
64         if (revs->count) {
65                 if (commit->object.flags & PATCHSAME)
66                         revs->count_same++;
67                 else if (commit->object.flags & SYMMETRIC_LEFT)
68                         revs->count_left++;
69                 else
70                         revs->count_right++;
71                 finish_commit(commit, data);
72                 return;
73         }
74
75         if (info->show_timestamp)
76                 printf("%lu ", commit->date);
77         if (info->header_prefix)
78                 fputs(info->header_prefix, stdout);
79
80         if (!revs->graph)
81                 fputs(get_revision_mark(revs, commit), stdout);
82         if (revs->abbrev_commit && revs->abbrev)
83                 fputs(find_unique_abbrev(commit->object.sha1, revs->abbrev),
84                       stdout);
85         else
86                 fputs(sha1_to_hex(commit->object.sha1), stdout);
87         if (revs->print_parents) {
88                 struct commit_list *parents = commit->parents;
89                 while (parents) {
90                         printf(" %s", sha1_to_hex(parents->item->object.sha1));
91                         parents = parents->next;
92                 }
93         }
94         if (revs->children.name) {
95                 struct commit_list *children;
96
97                 children = lookup_decoration(&revs->children, &commit->object);
98                 while (children) {
99                         printf(" %s", sha1_to_hex(children->item->object.sha1));
100                         children = children->next;
101                 }
102         }
103         show_decorations(revs, commit);
104         if (revs->commit_format == CMIT_FMT_ONELINE)
105                 putchar(' ');
106         else
107                 putchar('\n');
108
109         if (revs->verbose_header && get_cached_commit_buffer(commit, NULL)) {
110                 struct strbuf buf = STRBUF_INIT;
111                 struct pretty_print_context ctx = {0};
112                 ctx.abbrev = revs->abbrev;
113                 ctx.date_mode = revs->date_mode;
114                 ctx.date_mode_explicit = revs->date_mode_explicit;
115                 ctx.fmt = revs->commit_format;
116                 ctx.output_encoding = get_log_output_encoding();
117                 pretty_print_commit(&ctx, commit, &buf);
118                 if (revs->graph) {
119                         if (buf.len) {
120                                 if (revs->commit_format != CMIT_FMT_ONELINE)
121                                         graph_show_oneline(revs->graph);
122
123                                 graph_show_commit_msg(revs->graph, &buf);
124
125                                 /*
126                                  * Add a newline after the commit message.
127                                  *
128                                  * Usually, this newline produces a blank
129                                  * padding line between entries, in which case
130                                  * we need to add graph padding on this line.
131                                  *
132                                  * However, the commit message may not end in a
133                                  * newline.  In this case the newline simply
134                                  * ends the last line of the commit message,
135                                  * and we don't need any graph output.  (This
136                                  * always happens with CMIT_FMT_ONELINE, and it
137                                  * happens with CMIT_FMT_USERFORMAT when the
138                                  * format doesn't explicitly end in a newline.)
139                                  */
140                                 if (buf.len && buf.buf[buf.len - 1] == '\n')
141                                         graph_show_padding(revs->graph);
142                                 putchar('\n');
143                         } else {
144                                 /*
145                                  * If the message buffer is empty, just show
146                                  * the rest of the graph output for this
147                                  * commit.
148                                  */
149                                 if (graph_show_remainder(revs->graph))
150                                         putchar('\n');
151                                 if (revs->commit_format == CMIT_FMT_ONELINE)
152                                         putchar('\n');
153                         }
154                 } else {
155                         if (revs->commit_format != CMIT_FMT_USERFORMAT ||
156                             buf.len) {
157                                 fwrite(buf.buf, 1, buf.len, stdout);
158                                 putchar(info->hdr_termination);
159                         }
160                 }
161                 strbuf_release(&buf);
162         } else {
163                 if (graph_show_remainder(revs->graph))
164                         putchar('\n');
165         }
166         maybe_flush_or_die(stdout, "stdout");
167         finish_commit(commit, data);
168 }
169
170 static void finish_commit(struct commit *commit, void *data)
171 {
172         if (commit->parents) {
173                 free_commit_list(commit->parents);
174                 commit->parents = NULL;
175         }
176         free_commit_buffer(commit);
177 }
178
179 static void finish_object(struct object *obj,
180                           const struct name_path *path, const char *name,
181                           void *cb_data)
182 {
183         struct rev_list_info *info = cb_data;
184         if (obj->type == OBJ_BLOB && !has_sha1_file(obj->sha1))
185                 die("missing blob object '%s'", sha1_to_hex(obj->sha1));
186         if (info->revs->verify_objects && !obj->parsed && obj->type != OBJ_COMMIT)
187                 parse_object(obj->sha1);
188 }
189
190 static void show_object(struct object *obj,
191                         const struct name_path *path, const char *component,
192                         void *cb_data)
193 {
194         struct rev_list_info *info = cb_data;
195         finish_object(obj, path, component, cb_data);
196         if (info->flags & REV_LIST_QUIET)
197                 return;
198         show_object_with_name(stdout, obj, path, component);
199 }
200
201 static void show_edge(struct commit *commit)
202 {
203         printf("-%s\n", sha1_to_hex(commit->object.sha1));
204 }
205
206 static void print_var_str(const char *var, const char *val)
207 {
208         printf("%s='%s'\n", var, val);
209 }
210
211 static void print_var_int(const char *var, int val)
212 {
213         printf("%s=%d\n", var, val);
214 }
215
216 static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
217 {
218         int cnt, flags = info->flags;
219         char hex[41] = "";
220         struct commit_list *tried;
221         struct rev_info *revs = info->revs;
222
223         if (!revs->commits)
224                 return 1;
225
226         revs->commits = filter_skipped(revs->commits, &tried,
227                                        flags & BISECT_SHOW_ALL,
228                                        NULL, NULL);
229
230         /*
231          * revs->commits can reach "reaches" commits among
232          * "all" commits.  If it is good, then there are
233          * (all-reaches) commits left to be bisected.
234          * On the other hand, if it is bad, then the set
235          * to bisect is "reaches".
236          * A bisect set of size N has (N-1) commits further
237          * to test, as we already know one bad one.
238          */
239         cnt = all - reaches;
240         if (cnt < reaches)
241                 cnt = reaches;
242
243         if (revs->commits)
244                 strcpy(hex, sha1_to_hex(revs->commits->item->object.sha1));
245
246         if (flags & BISECT_SHOW_ALL) {
247                 traverse_commit_list(revs, show_commit, show_object, info);
248                 printf("------\n");
249         }
250
251         print_var_str("bisect_rev", hex);
252         print_var_int("bisect_nr", cnt - 1);
253         print_var_int("bisect_good", all - reaches - 1);
254         print_var_int("bisect_bad", reaches - 1);
255         print_var_int("bisect_all", all);
256         print_var_int("bisect_steps", estimate_bisect_steps(all));
257
258         return 0;
259 }
260
261 static int show_object_fast(
262         const unsigned char *sha1,
263         enum object_type type,
264         int exclude,
265         uint32_t name_hash,
266         struct packed_git *found_pack,
267         off_t found_offset)
268 {
269         fprintf(stdout, "%s\n", sha1_to_hex(sha1));
270         return 1;
271 }
272
273 int cmd_rev_list(int argc, const char **argv, const char *prefix)
274 {
275         struct rev_info revs;
276         struct rev_list_info info;
277         int i;
278         int bisect_list = 0;
279         int bisect_show_vars = 0;
280         int bisect_find_all = 0;
281         int use_bitmap_index = 0;
282
283         git_config(git_default_config, NULL);
284         init_revisions(&revs, prefix);
285         revs.abbrev = DEFAULT_ABBREV;
286         revs.commit_format = CMIT_FMT_UNSPECIFIED;
287         argc = setup_revisions(argc, argv, &revs, NULL);
288
289         memset(&info, 0, sizeof(info));
290         info.revs = &revs;
291         if (revs.bisect)
292                 bisect_list = 1;
293
294         if (DIFF_OPT_TST(&revs.diffopt, QUICK))
295                 info.flags |= REV_LIST_QUIET;
296         for (i = 1 ; i < argc; i++) {
297                 const char *arg = argv[i];
298
299                 if (!strcmp(arg, "--header")) {
300                         revs.verbose_header = 1;
301                         continue;
302                 }
303                 if (!strcmp(arg, "--timestamp")) {
304                         info.show_timestamp = 1;
305                         continue;
306                 }
307                 if (!strcmp(arg, "--bisect")) {
308                         bisect_list = 1;
309                         continue;
310                 }
311                 if (!strcmp(arg, "--bisect-all")) {
312                         bisect_list = 1;
313                         bisect_find_all = 1;
314                         info.flags |= BISECT_SHOW_ALL;
315                         revs.show_decorations = 1;
316                         continue;
317                 }
318                 if (!strcmp(arg, "--bisect-vars")) {
319                         bisect_list = 1;
320                         bisect_show_vars = 1;
321                         continue;
322                 }
323                 if (!strcmp(arg, "--use-bitmap-index")) {
324                         use_bitmap_index = 1;
325                         continue;
326                 }
327                 if (!strcmp(arg, "--test-bitmap")) {
328                         test_bitmap_walk(&revs);
329                         return 0;
330                 }
331                 usage(rev_list_usage);
332
333         }
334         if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
335                 /* The command line has a --pretty  */
336                 info.hdr_termination = '\n';
337                 if (revs.commit_format == CMIT_FMT_ONELINE)
338                         info.header_prefix = "";
339                 else
340                         info.header_prefix = "commit ";
341         }
342         else if (revs.verbose_header)
343                 /* Only --header was specified */
344                 revs.commit_format = CMIT_FMT_RAW;
345
346         if ((!revs.commits &&
347              (!(revs.tag_objects || revs.tree_objects || revs.blob_objects) &&
348               !revs.pending.nr)) ||
349             revs.diff)
350                 usage(rev_list_usage);
351
352         save_commit_buffer = (revs.verbose_header ||
353                               revs.grep_filter.pattern_list ||
354                               revs.grep_filter.header_list);
355         if (bisect_list)
356                 revs.limited = 1;
357
358         if (use_bitmap_index) {
359                 if (revs.count && !revs.left_right && !revs.cherry_mark) {
360                         uint32_t commit_count;
361                         if (!prepare_bitmap_walk(&revs)) {
362                                 count_bitmap_commit_list(&commit_count, NULL, NULL, NULL);
363                                 printf("%d\n", commit_count);
364                                 return 0;
365                         }
366                 } else if (revs.tag_objects && revs.tree_objects && revs.blob_objects) {
367                         if (!prepare_bitmap_walk(&revs)) {
368                                 traverse_bitmap_commit_list(&show_object_fast);
369                                 return 0;
370                         }
371                 }
372         }
373
374         if (prepare_revision_walk(&revs))
375                 die("revision walk setup failed");
376         if (revs.tree_objects)
377                 mark_edges_uninteresting(&revs, show_edge);
378
379         if (bisect_list) {
380                 int reaches = reaches, all = all;
381
382                 revs.commits = find_bisection(revs.commits, &reaches, &all,
383                                               bisect_find_all);
384
385                 if (bisect_show_vars)
386                         return show_bisect_vars(&info, reaches, all);
387         }
388
389         traverse_commit_list(&revs, show_commit, show_object, &info);
390
391         if (revs.count) {
392                 if (revs.left_right && revs.cherry_mark)
393                         printf("%d\t%d\t%d\n", revs.count_left, revs.count_right, revs.count_same);
394                 else if (revs.left_right)
395                         printf("%d\t%d\n", revs.count_left, revs.count_right);
396                 else if (revs.cherry_mark)
397                         printf("%d\t%d\n", revs.count_left + revs.count_right, revs.count_same);
398                 else
399                         printf("%d\n", revs.count_left + revs.count_right);
400         }
401
402         return 0;
403 }