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