pretty: add pp_commit_easy function for simple callers
[git/git.git] / builtin / rev-list.c
CommitLineData
64745109
LT
1#include "cache.h"
2#include "commit.h"
c4e05b1a 3#include "diff.h"
ae563542 4#include "revision.h"
c64ed70d 5#include "list-objects.h"
5fb61b8d 6#include "builtin.h"
50e62a8e 7#include "log-tree.h"
7fefda5c 8#include "graph.h"
a2ad79ce 9#include "bisect.h"
8906300f 10
a6f68d47 11static const char rev_list_usage[] =
1b1dd23f 12"git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
69e0c256 13" limiting output:\n"
62b4698e
ŠN
14" --max-count=<n>\n"
15" --max-age=<epoch>\n"
16" --min-age=<epoch>\n"
69e0c256
JH
17" --sparse\n"
18" --no-merges\n"
93b74bca 19" --remove-empty\n"
69e0c256 20" --all\n"
a5aa930d
UKK
21" --branches\n"
22" --tags\n"
23" --remotes\n"
42cabc34 24" --stdin\n"
27350891 25" --quiet\n"
69e0c256 26" ordering output:\n"
69e0c256 27" --topo-order\n"
4c8725f1 28" --date-order\n"
7ccd3667 29" --reverse\n"
69e0c256
JH
30" formatting output:\n"
31" --parents\n"
72276a3e 32" --children\n"
c6496575 33" --objects | --objects-edge\n"
69e0c256
JH
34" --unpacked\n"
35" --header | --pretty\n"
62b4698e 36" --abbrev=<n> | --no-abbrev\n"
5c51c985 37" --abbrev-commit\n"
b24bace5 38" --left-right\n"
69e0c256 39" special purpose:\n"
457f08a0 40" --bisect\n"
50e62a8e
CC
41" --bisect-vars\n"
42" --bisect-all"
69e0c256 43;
a6f68d47 44
11c211fa
CC
45static void finish_commit(struct commit *commit, void *data);
46static void show_commit(struct commit *commit, void *data)
81f2bb1f 47{
d797257e
CC
48 struct rev_list_info *info = data;
49 struct rev_info *revs = info->revs;
11c211fa
CC
50
51 graph_show_commit(revs->graph);
7fefda5c 52
f69c5018
TR
53 if (revs->count) {
54 if (commit->object.flags & SYMMETRIC_LEFT)
55 revs->count_left++;
56 else
57 revs->count_right++;
58 finish_commit(commit, data);
59 return;
60 }
61
d797257e 62 if (info->show_timestamp)
dc68c4ff 63 printf("%lu ", commit->date);
d797257e
CC
64 if (info->header_prefix)
65 fputs(info->header_prefix, stdout);
7528f27d 66
11c211fa 67 if (!revs->graph) {
7528f27d
AS
68 if (commit->object.flags & BOUNDARY)
69 putchar('-');
70 else if (commit->object.flags & UNINTERESTING)
71 putchar('^');
11c211fa 72 else if (revs->left_right) {
7528f27d
AS
73 if (commit->object.flags & SYMMETRIC_LEFT)
74 putchar('<');
75 else
76 putchar('>');
77 }
577ed5c2 78 }
11c211fa
CC
79 if (revs->abbrev_commit && revs->abbrev)
80 fputs(find_unique_abbrev(commit->object.sha1, revs->abbrev),
7594c4b2 81 stdout);
5c51c985
JH
82 else
83 fputs(sha1_to_hex(commit->object.sha1), stdout);
11c211fa 84 if (revs->print_parents) {
81f2bb1f
LT
85 struct commit_list *parents = commit->parents;
86 while (parents) {
1ed84157 87 printf(" %s", sha1_to_hex(parents->item->object.sha1));
81f2bb1f
LT
88 parents = parents->next;
89 }
90 }
11c211fa 91 if (revs->children.name) {
72276a3e
JH
92 struct commit_list *children;
93
11c211fa 94 children = lookup_decoration(&revs->children, &commit->object);
72276a3e
JH
95 while (children) {
96 printf(" %s", sha1_to_hex(children->item->object.sha1));
97 children = children->next;
98 }
99 }
11c211fa
CC
100 show_decorations(revs, commit);
101 if (revs->commit_format == CMIT_FMT_ONELINE)
d87449c5
JH
102 putchar(' ');
103 else
104 putchar('\n');
105
11c211fa 106 if (revs->verbose_header && commit->buffer) {
f285a2d7 107 struct strbuf buf = STRBUF_INIT;
dd2e794a
TR
108 struct pretty_print_context ctx = {0};
109 ctx.abbrev = revs->abbrev;
110 ctx.date_mode = revs->date_mode;
111 pretty_print_commit(revs->commit_format, commit, &buf, &ctx);
11c211fa 112 if (revs->graph) {
7fefda5c 113 if (buf.len) {
11c211fa
CC
114 if (revs->commit_format != CMIT_FMT_ONELINE)
115 graph_show_oneline(revs->graph);
7fefda5c 116
11c211fa 117 graph_show_commit_msg(revs->graph, &buf);
7fefda5c
AS
118
119 /*
120 * Add a newline after the commit message.
121 *
122 * Usually, this newline produces a blank
123 * padding line between entries, in which case
124 * we need to add graph padding on this line.
125 *
126 * However, the commit message may not end in a
127 * newline. In this case the newline simply
128 * ends the last line of the commit message,
129 * and we don't need any graph output. (This
130 * always happens with CMIT_FMT_ONELINE, and it
131 * happens with CMIT_FMT_USERFORMAT when the
132 * format doesn't explicitly end in a newline.)
133 */
134 if (buf.len && buf.buf[buf.len - 1] == '\n')
11c211fa 135 graph_show_padding(revs->graph);
7fefda5c
AS
136 putchar('\n');
137 } else {
138 /*
139 * If the message buffer is empty, just show
140 * the rest of the graph output for this
141 * commit.
142 */
11c211fa 143 if (graph_show_remainder(revs->graph))
7fefda5c 144 putchar('\n');
1fb5fdd2
EFL
145 if (revs->commit_format == CMIT_FMT_ONELINE)
146 putchar('\n');
7fefda5c
AS
147 }
148 } else {
1fb5fdd2 149 if (revs->commit_format != CMIT_FMT_USERFORMAT ||
9130ac9f
JK
150 buf.len) {
151 fwrite(buf.buf, 1, buf.len, stdout);
152 putchar(info->hdr_termination);
153 }
7fefda5c 154 }
674d1727 155 strbuf_release(&buf);
7fefda5c 156 } else {
11c211fa 157 if (graph_show_remainder(revs->graph))
7fefda5c 158 putchar('\n');
7620d39f 159 }
06f59e9f 160 maybe_flush_or_die(stdout, "stdout");
11c211fa 161 finish_commit(commit, data);
27350891
SP
162}
163
11c211fa 164static void finish_commit(struct commit *commit, void *data)
27350891 165{
cb115748
LT
166 if (commit->parents) {
167 free_commit_list(commit->parents);
168 commit->parents = NULL;
169 }
4cac42b1
JH
170 free(commit->buffer);
171 commit->buffer = NULL;
a3437b8c
JS
172}
173
cf2ab916 174static void finish_object(struct object *obj, const struct name_path *path, const char *name)
27350891 175{
8d2dfc49
LT
176 if (obj->type == OBJ_BLOB && !has_sha1_file(obj->sha1))
177 die("missing blob object '%s'", sha1_to_hex(obj->sha1));
27350891
SP
178}
179
cf2ab916 180static void show_object(struct object *obj, const struct name_path *path, const char *component)
9de48752 181{
cf2ab916 182 char *name = path_name(path, component);
c64ed70d 183 /* An object with name "foo\n0000000..." can be used to
f18d244a 184 * confuse downstream "git pack-objects" very badly.
c64ed70d 185 */
8d2dfc49 186 const char *ep = strchr(name, '\n');
b9849a1a 187
cf2ab916 188 finish_object(obj, path, name);
c64ed70d 189 if (ep) {
8d2dfc49
LT
190 printf("%s %.*s\n", sha1_to_hex(obj->sha1),
191 (int) (ep - name),
192 name);
9de48752 193 }
c64ed70d 194 else
8d2dfc49 195 printf("%s %s\n", sha1_to_hex(obj->sha1), name);
cf2ab916 196 free(name);
9de48752
LT
197}
198
8d1d8f83
JH
199static void show_edge(struct commit *commit)
200{
201 printf("-%s\n", sha1_to_hex(commit->object.sha1));
202}
203
9f199b15
CC
204static 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
214static 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 */
1c876546 229int estimate_bisect_steps(int all)
9f199b15
CC
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
280e65cb
CC
243void 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
38ef7507 253static void show_tried_revs(struct commit_list *tried)
95188648
CC
254{
255 printf("bisect_tried='");
280e65cb 256 print_commit_list(tried, "%s|", "%s");
38ef7507 257 printf("'\n");
95188648
CC
258}
259
38ef7507 260static void print_var_str(const char *var, const char *val)
280e65cb 261{
38ef7507 262 printf("%s='%s'\n", var, val);
280e65cb
CC
263}
264
38ef7507 265static void print_var_int(const char *var, int val)
280e65cb 266{
38ef7507 267 printf("%s=%d\n", var, val);
280e65cb
CC
268}
269
f1c92c63 270static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
9996983c 271{
38ef7507 272 int cnt, flags = info->bisect_show_flags;
280e65cb 273 char hex[41] = "";
95188648 274 struct commit_list *tried;
d797257e 275 struct rev_info *revs = info->revs;
9996983c 276
37c4c38d 277 if (!revs->commits && !(flags & BISECT_SHOW_TRIED))
9996983c
CC
278 return 1;
279
9af3589e
CC
280 revs->commits = filter_skipped(revs->commits, &tried,
281 flags & BISECT_SHOW_ALL,
282 NULL, NULL);
95188648 283
9996983c 284 /*
7428d754 285 * revs->commits can reach "reaches" commits among
9996983c
CC
286 * "all" commits. If it is good, then there are
287 * (all-reaches) commits left to be bisected.
288 * On the other hand, if it is bad, then the set
289 * to bisect is "reaches".
290 * A bisect set of size N has (N-1) commits further
291 * to test, as we already know one bad one.
292 */
293 cnt = all - reaches;
294 if (cnt < reaches)
295 cnt = reaches;
6a17fad7 296
95188648
CC
297 if (revs->commits)
298 strcpy(hex, sha1_to_hex(revs->commits->item->object.sha1));
9996983c 299
37c4c38d 300 if (flags & BISECT_SHOW_ALL) {
d797257e 301 traverse_commit_list(revs, show_commit, show_object, info);
9996983c
CC
302 printf("------\n");
303 }
304
37c4c38d 305 if (flags & BISECT_SHOW_TRIED)
38ef7507
CC
306 show_tried_revs(tried);
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));
9996983c
CC
314
315 return 0;
316}
317
a633fca0 318int cmd_rev_list(int argc, const char **argv, const char *prefix)
64745109 319{
11c211fa 320 struct rev_info revs;
d797257e 321 struct rev_list_info info;
d9a83684 322 int i;
ff62d732 323 int bisect_list = 0;
457f08a0 324 int bisect_show_vars = 0;
50e62a8e 325 int bisect_find_all = 0;
27350891 326 int quiet = 0;
64745109 327
ef90d6d4 328 git_config(git_default_config, NULL);
a633fca0 329 init_revisions(&revs, prefix);
7337b138 330 revs.abbrev = DEFAULT_ABBREV;
7594c4b2 331 revs.commit_format = CMIT_FMT_UNSPECIFIED;
a4a88b2b 332 argc = setup_revisions(argc, argv, &revs, NULL);
ae563542 333
d797257e
CC
334 memset(&info, 0, sizeof(info));
335 info.revs = &revs;
ad3f9a71
LT
336 if (revs.bisect)
337 bisect_list = 1;
d797257e 338
90b19941 339 quiet = DIFF_OPT_TST(&revs.diffopt, QUICK);
fcfda02b 340 for (i = 1 ; i < argc; i++) {
cf484544 341 const char *arg = argv[i];
fcfda02b 342
a6f68d47 343 if (!strcmp(arg, "--header")) {
7594c4b2 344 revs.verbose_header = 1;
9d97aa64
LT
345 continue;
346 }
dc68c4ff 347 if (!strcmp(arg, "--timestamp")) {
d797257e 348 info.show_timestamp = 1;
dc68c4ff
JH
349 continue;
350 }
8b3a1e05
LT
351 if (!strcmp(arg, "--bisect")) {
352 bisect_list = 1;
353 continue;
354 }
50e62a8e
CC
355 if (!strcmp(arg, "--bisect-all")) {
356 bisect_list = 1;
357 bisect_find_all = 1;
13858e57 358 info.bisect_show_flags = BISECT_SHOW_ALL;
6e46cc0d 359 revs.show_decorations = 1;
50e62a8e
CC
360 continue;
361 }
457f08a0
JH
362 if (!strcmp(arg, "--bisect-vars")) {
363 bisect_list = 1;
364 bisect_show_vars = 1;
365 continue;
366 }
ae563542 367 usage(rev_list_usage);
a6f68d47 368
fcfda02b 369 }
7594c4b2
JH
370 if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
371 /* The command line has a --pretty */
d797257e 372 info.hdr_termination = '\n';
7594c4b2 373 if (revs.commit_format == CMIT_FMT_ONELINE)
d797257e 374 info.header_prefix = "";
7594c4b2 375 else
d797257e 376 info.header_prefix = "commit ";
7594c4b2 377 }
db89665f
JH
378 else if (revs.verbose_header)
379 /* Only --header was specified */
380 revs.commit_format = CMIT_FMT_RAW;
fcfda02b 381
d797257e 382 if ((!revs.commits &&
8c1f0b44 383 (!(revs.tag_objects||revs.tree_objects||revs.blob_objects) &&
1f1e895f 384 !revs.pending.nr)) ||
8c1f0b44 385 revs.diff)
7b34c2fa
LT
386 usage(rev_list_usage);
387
80235ba7
JH
388 save_commit_buffer = (revs.verbose_header ||
389 revs.grep_filter.pattern_list ||
390 revs.grep_filter.header_list);
4e1dc640
JH
391 if (bisect_list)
392 revs.limited = 1;
9181ca2c 393
3d51e1b5
MK
394 if (prepare_revision_walk(&revs))
395 die("revision walk setup failed");
a4a88b2b 396 if (revs.tree_objects)
8d1d8f83 397 mark_edges_uninteresting(revs.commits, &revs, show_edge);
a4a88b2b 398
457f08a0
JH
399 if (bisect_list) {
400 int reaches = reaches, all = all;
401
50e62a8e
CC
402 revs.commits = find_bisection(revs.commits, &reaches, &all,
403 bisect_find_all);
95188648 404
9996983c 405 if (bisect_show_vars)
13858e57 406 return show_bisect_vars(&info, reaches, all);
457f08a0 407 }
7b34c2fa 408
27350891 409 traverse_commit_list(&revs,
11c211fa
CC
410 quiet ? finish_commit : show_commit,
411 quiet ? finish_object : show_object,
d797257e 412 &info);
8906300f 413
f69c5018
TR
414 if (revs.count) {
415 if (revs.left_right)
416 printf("%d\t%d\n", revs.count_left, revs.count_right);
417 else
418 printf("%d\n", revs.count_left + revs.count_right);
419 }
420
64745109
LT
421 return 0;
422}