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