Merge branch 'jc/help' into maint
[git/jnareb-git.git] / builtin / rev-list.c
blob67701be55193db0fd9733ee7c4962db08072045c
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"
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"
49 static void finish_commit(struct commit *commit, void *data);
50 static void show_commit(struct commit *commit, void *data)
52 struct rev_list_info *info = data;
53 struct rev_info *revs = info->revs;
55 if (info->flags & REV_LIST_QUIET) {
56 finish_commit(commit, data);
57 return;
60 graph_show_commit(revs->graph);
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;
73 if (info->show_timestamp)
74 printf("%lu ", commit->date);
75 if (info->header_prefix)
76 fputs(info->header_prefix, stdout);
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;
92 if (revs->children.name) {
93 struct commit_list *children;
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;
101 show_decorations(revs, commit);
102 if (revs->commit_format == CMIT_FMT_ONELINE)
103 putchar(' ');
104 else
105 putchar('\n');
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);
120 graph_show_commit_msg(revs->graph, &buf);
123 * Add a newline after the commit message.
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.
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.)
137 if (buf.len && buf.buf[buf.len - 1] == '\n')
138 graph_show_padding(revs->graph);
139 putchar('\n');
140 } else {
142 * If the message buffer is empty, just show
143 * the rest of the graph output for this
144 * commit.
146 if (graph_show_remainder(revs->graph))
147 putchar('\n');
148 if (revs->commit_format == CMIT_FMT_ONELINE)
149 putchar('\n');
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);
158 strbuf_release(&buf);
159 } else {
160 if (graph_show_remainder(revs->graph))
161 putchar('\n');
163 maybe_flush_or_die(stdout, "stdout");
164 finish_commit(commit, data);
167 static void finish_commit(struct commit *commit, void *data)
169 if (commit->parents) {
170 free_commit_list(commit->parents);
171 commit->parents = NULL;
173 free(commit->buffer);
174 commit->buffer = NULL;
177 static void finish_object(struct object *obj,
178 const struct name_path *path, const char *name,
179 void *cb_data)
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);
188 static void show_object(struct object *obj,
189 const struct name_path *path, const char *component,
190 void *cb_data)
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);
199 static void show_edge(struct commit *commit)
201 printf("-%s\n", sha1_to_hex(commit->object.sha1));
204 static void print_var_str(const char *var, const char *val)
206 printf("%s='%s'\n", var, val);
209 static void print_var_int(const char *var, int val)
211 printf("%s=%d\n", var, val);
214 static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
216 int cnt, flags = info->flags;
217 char hex[41] = "";
218 struct commit_list *tried;
219 struct rev_info *revs = info->revs;
221 if (!revs->commits)
222 return 1;
224 revs->commits = filter_skipped(revs->commits, &tried,
225 flags & BISECT_SHOW_ALL,
226 NULL, NULL);
229 * revs->commits can reach "reaches" commits among
230 * "all" commits. If it is good, then there are
231 * (all-reaches) commits left to be bisected.
232 * On the other hand, if it is bad, then the set
233 * to bisect is "reaches".
234 * A bisect set of size N has (N-1) commits further
235 * to test, as we already know one bad one.
237 cnt = all - reaches;
238 if (cnt < reaches)
239 cnt = reaches;
241 if (revs->commits)
242 strcpy(hex, sha1_to_hex(revs->commits->item->object.sha1));
244 if (flags & BISECT_SHOW_ALL) {
245 traverse_commit_list(revs, show_commit, show_object, info);
246 printf("------\n");
249 print_var_str("bisect_rev", hex);
250 print_var_int("bisect_nr", cnt - 1);
251 print_var_int("bisect_good", all - reaches - 1);
252 print_var_int("bisect_bad", reaches - 1);
253 print_var_int("bisect_all", all);
254 print_var_int("bisect_steps", estimate_bisect_steps(all));
256 return 0;
259 int cmd_rev_list(int argc, const char **argv, const char *prefix)
261 struct rev_info revs;
262 struct rev_list_info info;
263 int i;
264 int bisect_list = 0;
265 int bisect_show_vars = 0;
266 int bisect_find_all = 0;
268 git_config(git_default_config, NULL);
269 init_revisions(&revs, prefix);
270 revs.abbrev = DEFAULT_ABBREV;
271 revs.commit_format = CMIT_FMT_UNSPECIFIED;
272 argc = setup_revisions(argc, argv, &revs, NULL);
274 memset(&info, 0, sizeof(info));
275 info.revs = &revs;
276 if (revs.bisect)
277 bisect_list = 1;
279 if (DIFF_OPT_TST(&revs.diffopt, QUICK))
280 info.flags |= REV_LIST_QUIET;
281 for (i = 1 ; i < argc; i++) {
282 const char *arg = argv[i];
284 if (!strcmp(arg, "--header")) {
285 revs.verbose_header = 1;
286 continue;
288 if (!strcmp(arg, "--timestamp")) {
289 info.show_timestamp = 1;
290 continue;
292 if (!strcmp(arg, "--bisect")) {
293 bisect_list = 1;
294 continue;
296 if (!strcmp(arg, "--bisect-all")) {
297 bisect_list = 1;
298 bisect_find_all = 1;
299 info.flags |= BISECT_SHOW_ALL;
300 revs.show_decorations = 1;
301 continue;
303 if (!strcmp(arg, "--bisect-vars")) {
304 bisect_list = 1;
305 bisect_show_vars = 1;
306 continue;
308 usage(rev_list_usage);
311 if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
312 /* The command line has a --pretty */
313 info.hdr_termination = '\n';
314 if (revs.commit_format == CMIT_FMT_ONELINE)
315 info.header_prefix = "";
316 else
317 info.header_prefix = "commit ";
319 else if (revs.verbose_header)
320 /* Only --header was specified */
321 revs.commit_format = CMIT_FMT_RAW;
323 if ((!revs.commits &&
324 (!(revs.tag_objects||revs.tree_objects||revs.blob_objects) &&
325 !revs.pending.nr)) ||
326 revs.diff)
327 usage(rev_list_usage);
329 save_commit_buffer = (revs.verbose_header ||
330 revs.grep_filter.pattern_list ||
331 revs.grep_filter.header_list);
332 if (bisect_list)
333 revs.limited = 1;
335 if (prepare_revision_walk(&revs))
336 die("revision walk setup failed");
337 if (revs.tree_objects)
338 mark_edges_uninteresting(revs.commits, &revs, show_edge);
340 if (bisect_list) {
341 int reaches = reaches, all = all;
343 revs.commits = find_bisection(revs.commits, &reaches, &all,
344 bisect_find_all);
346 if (bisect_show_vars)
347 return show_bisect_vars(&info, reaches, all);
350 traverse_commit_list(&revs, show_commit, show_object, &info);
352 if (revs.count) {
353 if (revs.left_right && revs.cherry_mark)
354 printf("%d\t%d\t%d\n", revs.count_left, revs.count_right, revs.count_same);
355 else if (revs.left_right)
356 printf("%d\t%d\n", revs.count_left, revs.count_right);
357 else if (revs.cherry_mark)
358 printf("%d\t%d\n", revs.count_left + revs.count_right, revs.count_same);
359 else
360 printf("%d\n", revs.count_left + revs.count_right);
363 return 0;