Merge branch 'ma/diff-doc-clarify-regexp-example'
[git] / log-tree.c
1 #include "cache.h"
2 #include "config.h"
3 #include "diff.h"
4 #include "object-store.h"
5 #include "repository.h"
6 #include "commit.h"
7 #include "tag.h"
8 #include "graph.h"
9 #include "log-tree.h"
10 #include "reflog-walk.h"
11 #include "refs.h"
12 #include "string-list.h"
13 #include "color.h"
14 #include "gpg-interface.h"
15 #include "sequencer.h"
16 #include "line-log.h"
17 #include "help.h"
18 #include "interdiff.h"
19 #include "range-diff.h"
20
21 static struct decoration name_decoration = { "object names" };
22 static int decoration_loaded;
23 static int decoration_flags;
24
25 static char decoration_colors[][COLOR_MAXLEN] = {
26         GIT_COLOR_RESET,
27         GIT_COLOR_BOLD_GREEN,   /* REF_LOCAL */
28         GIT_COLOR_BOLD_RED,     /* REF_REMOTE */
29         GIT_COLOR_BOLD_YELLOW,  /* REF_TAG */
30         GIT_COLOR_BOLD_MAGENTA, /* REF_STASH */
31         GIT_COLOR_BOLD_CYAN,    /* REF_HEAD */
32         GIT_COLOR_BOLD_BLUE,    /* GRAFTED */
33 };
34
35 static const char *color_decorate_slots[] = {
36         [DECORATION_REF_LOCAL]  = "branch",
37         [DECORATION_REF_REMOTE] = "remoteBranch",
38         [DECORATION_REF_TAG]    = "tag",
39         [DECORATION_REF_STASH]  = "stash",
40         [DECORATION_REF_HEAD]   = "HEAD",
41         [DECORATION_GRAFTED]    = "grafted",
42 };
43
44 static const char *decorate_get_color(int decorate_use_color, enum decoration_type ix)
45 {
46         if (want_color(decorate_use_color))
47                 return decoration_colors[ix];
48         return "";
49 }
50
51 define_list_config_array(color_decorate_slots);
52
53 int parse_decorate_color_config(const char *var, const char *slot_name, const char *value)
54 {
55         int slot = LOOKUP_CONFIG(color_decorate_slots, slot_name);
56         if (slot < 0)
57                 return 0;
58         if (!value)
59                 return config_error_nonbool(var);
60         return color_parse(value, decoration_colors[slot]);
61 }
62
63 /*
64  * log-tree.c uses DIFF_OPT_TST for determining whether to use color
65  * for showing the commit sha1, use the same check for --decorate
66  */
67 #define decorate_get_color_opt(o, ix) \
68         decorate_get_color((o)->use_color, ix)
69
70 void add_name_decoration(enum decoration_type type, const char *name, struct object *obj)
71 {
72         struct name_decoration *res;
73         FLEX_ALLOC_STR(res, name, name);
74         res->type = type;
75         res->next = add_decoration(&name_decoration, obj, res);
76 }
77
78 const struct name_decoration *get_name_decoration(const struct object *obj)
79 {
80         load_ref_decorations(NULL, DECORATE_SHORT_REFS);
81         return lookup_decoration(&name_decoration, obj);
82 }
83
84 static int add_ref_decoration(const char *refname, const struct object_id *oid,
85                               int flags, void *cb_data)
86 {
87         struct object *obj;
88         enum decoration_type type = DECORATION_NONE;
89         struct decoration_filter *filter = (struct decoration_filter *)cb_data;
90
91         if (filter && !ref_filter_match(refname,
92                               filter->include_ref_pattern,
93                               filter->exclude_ref_pattern))
94                 return 0;
95
96         if (starts_with(refname, git_replace_ref_base)) {
97                 struct object_id original_oid;
98                 if (!read_replace_refs)
99                         return 0;
100                 if (get_oid_hex(refname + strlen(git_replace_ref_base),
101                                 &original_oid)) {
102                         warning("invalid replace ref %s", refname);
103                         return 0;
104                 }
105                 obj = parse_object(the_repository, &original_oid);
106                 if (obj)
107                         add_name_decoration(DECORATION_GRAFTED, "replaced", obj);
108                 return 0;
109         }
110
111         obj = parse_object(the_repository, oid);
112         if (!obj)
113                 return 0;
114
115         if (starts_with(refname, "refs/heads/"))
116                 type = DECORATION_REF_LOCAL;
117         else if (starts_with(refname, "refs/remotes/"))
118                 type = DECORATION_REF_REMOTE;
119         else if (starts_with(refname, "refs/tags/"))
120                 type = DECORATION_REF_TAG;
121         else if (!strcmp(refname, "refs/stash"))
122                 type = DECORATION_REF_STASH;
123         else if (!strcmp(refname, "HEAD"))
124                 type = DECORATION_REF_HEAD;
125
126         add_name_decoration(type, refname, obj);
127         while (obj->type == OBJ_TAG) {
128                 obj = ((struct tag *)obj)->tagged;
129                 if (!obj)
130                         break;
131                 if (!obj->parsed)
132                         parse_object(the_repository, &obj->oid);
133                 add_name_decoration(DECORATION_REF_TAG, refname, obj);
134         }
135         return 0;
136 }
137
138 static int add_graft_decoration(const struct commit_graft *graft, void *cb_data)
139 {
140         struct commit *commit = lookup_commit(the_repository, &graft->oid);
141         if (!commit)
142                 return 0;
143         add_name_decoration(DECORATION_GRAFTED, "grafted", &commit->object);
144         return 0;
145 }
146
147 void load_ref_decorations(struct decoration_filter *filter, int flags)
148 {
149         if (!decoration_loaded) {
150                 if (filter) {
151                         struct string_list_item *item;
152                         for_each_string_list_item(item, filter->exclude_ref_pattern) {
153                                 normalize_glob_ref(item, NULL, item->string);
154                         }
155                         for_each_string_list_item(item, filter->include_ref_pattern) {
156                                 normalize_glob_ref(item, NULL, item->string);
157                         }
158                 }
159                 decoration_loaded = 1;
160                 decoration_flags = flags;
161                 for_each_ref(add_ref_decoration, filter);
162                 head_ref(add_ref_decoration, filter);
163                 for_each_commit_graft(add_graft_decoration, filter);
164         }
165 }
166
167 static void show_parents(struct commit *commit, int abbrev, FILE *file)
168 {
169         struct commit_list *p;
170         for (p = commit->parents; p ; p = p->next) {
171                 struct commit *parent = p->item;
172                 fprintf(file, " %s", find_unique_abbrev(&parent->object.oid, abbrev));
173         }
174 }
175
176 static void show_children(struct rev_info *opt, struct commit *commit, int abbrev)
177 {
178         struct commit_list *p = lookup_decoration(&opt->children, &commit->object);
179         for ( ; p; p = p->next) {
180                 fprintf(opt->diffopt.file, " %s", find_unique_abbrev(&p->item->object.oid, abbrev));
181         }
182 }
183
184 /*
185  * Do we have HEAD in the output, and also the branch it points at?
186  * If so, find that decoration entry for that current branch.
187  */
188 static const struct name_decoration *current_pointed_by_HEAD(const struct name_decoration *decoration)
189 {
190         const struct name_decoration *list, *head = NULL;
191         const char *branch_name = NULL;
192         int rru_flags;
193
194         /* First find HEAD */
195         for (list = decoration; list; list = list->next)
196                 if (list->type == DECORATION_REF_HEAD) {
197                         head = list;
198                         break;
199                 }
200         if (!head)
201                 return NULL;
202
203         /* Now resolve and find the matching current branch */
204         branch_name = resolve_ref_unsafe("HEAD", 0, NULL, &rru_flags);
205         if (!branch_name || !(rru_flags & REF_ISSYMREF))
206                 return NULL;
207
208         if (!starts_with(branch_name, "refs/"))
209                 return NULL;
210
211         /* OK, do we have that ref in the list? */
212         for (list = decoration; list; list = list->next)
213                 if ((list->type == DECORATION_REF_LOCAL) &&
214                     !strcmp(branch_name, list->name)) {
215                         return list;
216                 }
217
218         return NULL;
219 }
220
221 static void show_name(struct strbuf *sb, const struct name_decoration *decoration)
222 {
223         if (decoration_flags == DECORATE_SHORT_REFS)
224                 strbuf_addstr(sb, prettify_refname(decoration->name));
225         else
226                 strbuf_addstr(sb, decoration->name);
227 }
228
229 /*
230  * The caller makes sure there is no funny color before calling.
231  * format_decorations_extended makes sure the same after return.
232  */
233 void format_decorations_extended(struct strbuf *sb,
234                         const struct commit *commit,
235                         int use_color,
236                         const char *prefix,
237                         const char *separator,
238                         const char *suffix)
239 {
240         const struct name_decoration *decoration;
241         const struct name_decoration *current_and_HEAD;
242         const char *color_commit =
243                 diff_get_color(use_color, DIFF_COMMIT);
244         const char *color_reset =
245                 decorate_get_color(use_color, DECORATION_NONE);
246
247         decoration = get_name_decoration(&commit->object);
248         if (!decoration)
249                 return;
250
251         current_and_HEAD = current_pointed_by_HEAD(decoration);
252         while (decoration) {
253                 /*
254                  * When both current and HEAD are there, only
255                  * show HEAD->current where HEAD would have
256                  * appeared, skipping the entry for current.
257                  */
258                 if (decoration != current_and_HEAD) {
259                         strbuf_addstr(sb, color_commit);
260                         strbuf_addstr(sb, prefix);
261                         strbuf_addstr(sb, color_reset);
262                         strbuf_addstr(sb, decorate_get_color(use_color, decoration->type));
263                         if (decoration->type == DECORATION_REF_TAG)
264                                 strbuf_addstr(sb, "tag: ");
265
266                         show_name(sb, decoration);
267
268                         if (current_and_HEAD &&
269                             decoration->type == DECORATION_REF_HEAD) {
270                                 strbuf_addstr(sb, " -> ");
271                                 strbuf_addstr(sb, color_reset);
272                                 strbuf_addstr(sb, decorate_get_color(use_color, current_and_HEAD->type));
273                                 show_name(sb, current_and_HEAD);
274                         }
275                         strbuf_addstr(sb, color_reset);
276
277                         prefix = separator;
278                 }
279                 decoration = decoration->next;
280         }
281         strbuf_addstr(sb, color_commit);
282         strbuf_addstr(sb, suffix);
283         strbuf_addstr(sb, color_reset);
284 }
285
286 void show_decorations(struct rev_info *opt, struct commit *commit)
287 {
288         struct strbuf sb = STRBUF_INIT;
289
290         if (opt->sources) {
291                 char **slot = revision_sources_peek(opt->sources, commit);
292
293                 if (slot && *slot)
294                         fprintf(opt->diffopt.file, "\t%s", *slot);
295         }
296         if (!opt->show_decorations)
297                 return;
298         format_decorations(&sb, commit, opt->diffopt.use_color);
299         fputs(sb.buf, opt->diffopt.file);
300         strbuf_release(&sb);
301 }
302
303 static unsigned int digits_in_number(unsigned int number)
304 {
305         unsigned int i = 10, result = 1;
306         while (i <= number) {
307                 i *= 10;
308                 result++;
309         }
310         return result;
311 }
312
313 void fmt_output_subject(struct strbuf *filename,
314                         const char *subject,
315                         struct rev_info *info)
316 {
317         const char *suffix = info->patch_suffix;
318         int nr = info->nr;
319         int start_len = filename->len;
320         int max_len = start_len + FORMAT_PATCH_NAME_MAX - (strlen(suffix) + 1);
321
322         if (0 < info->reroll_count)
323                 strbuf_addf(filename, "v%d-", info->reroll_count);
324         strbuf_addf(filename, "%04d-%s", nr, subject);
325
326         if (max_len < filename->len)
327                 strbuf_setlen(filename, max_len);
328         strbuf_addstr(filename, suffix);
329 }
330
331 void fmt_output_commit(struct strbuf *filename,
332                        struct commit *commit,
333                        struct rev_info *info)
334 {
335         struct pretty_print_context ctx = {0};
336         struct strbuf subject = STRBUF_INIT;
337
338         format_commit_message(commit, "%f", &subject, &ctx);
339         fmt_output_subject(filename, subject.buf, info);
340         strbuf_release(&subject);
341 }
342
343 void fmt_output_email_subject(struct strbuf *sb, struct rev_info *opt)
344 {
345         if (opt->total > 0) {
346                 strbuf_addf(sb, "Subject: [%s%s%0*d/%d] ",
347                             opt->subject_prefix,
348                             *opt->subject_prefix ? " " : "",
349                             digits_in_number(opt->total),
350                             opt->nr, opt->total);
351         } else if (opt->total == 0 && opt->subject_prefix && *opt->subject_prefix) {
352                 strbuf_addf(sb, "Subject: [%s] ",
353                             opt->subject_prefix);
354         } else {
355                 strbuf_addstr(sb, "Subject: ");
356         }
357 }
358
359 void log_write_email_headers(struct rev_info *opt, struct commit *commit,
360                              const char **extra_headers_p,
361                              int *need_8bit_cte_p,
362                              int maybe_multipart)
363 {
364         const char *extra_headers = opt->extra_headers;
365         const char *name = oid_to_hex(opt->zero_commit ?
366                                       &null_oid : &commit->object.oid);
367
368         *need_8bit_cte_p = 0; /* unknown */
369
370         fprintf(opt->diffopt.file, "From %s Mon Sep 17 00:00:00 2001\n", name);
371         graph_show_oneline(opt->graph);
372         if (opt->message_id) {
373                 fprintf(opt->diffopt.file, "Message-Id: <%s>\n", opt->message_id);
374                 graph_show_oneline(opt->graph);
375         }
376         if (opt->ref_message_ids && opt->ref_message_ids->nr > 0) {
377                 int i, n;
378                 n = opt->ref_message_ids->nr;
379                 fprintf(opt->diffopt.file, "In-Reply-To: <%s>\n", opt->ref_message_ids->items[n-1].string);
380                 for (i = 0; i < n; i++)
381                         fprintf(opt->diffopt.file, "%s<%s>\n", (i > 0 ? "\t" : "References: "),
382                                opt->ref_message_ids->items[i].string);
383                 graph_show_oneline(opt->graph);
384         }
385         if (opt->mime_boundary && maybe_multipart) {
386                 static struct strbuf subject_buffer = STRBUF_INIT;
387                 static struct strbuf buffer = STRBUF_INIT;
388                 struct strbuf filename =  STRBUF_INIT;
389                 *need_8bit_cte_p = -1; /* NEVER */
390
391                 strbuf_reset(&subject_buffer);
392                 strbuf_reset(&buffer);
393
394                 strbuf_addf(&subject_buffer,
395                          "%s"
396                          "MIME-Version: 1.0\n"
397                          "Content-Type: multipart/mixed;"
398                          " boundary=\"%s%s\"\n"
399                          "\n"
400                          "This is a multi-part message in MIME "
401                          "format.\n"
402                          "--%s%s\n"
403                          "Content-Type: text/plain; "
404                          "charset=UTF-8; format=fixed\n"
405                          "Content-Transfer-Encoding: 8bit\n\n",
406                          extra_headers ? extra_headers : "",
407                          mime_boundary_leader, opt->mime_boundary,
408                          mime_boundary_leader, opt->mime_boundary);
409                 extra_headers = subject_buffer.buf;
410
411                 if (opt->numbered_files)
412                         strbuf_addf(&filename, "%d", opt->nr);
413                 else
414                         fmt_output_commit(&filename, commit, opt);
415                 strbuf_addf(&buffer,
416                          "\n--%s%s\n"
417                          "Content-Type: text/x-patch;"
418                          " name=\"%s\"\n"
419                          "Content-Transfer-Encoding: 8bit\n"
420                          "Content-Disposition: %s;"
421                          " filename=\"%s\"\n\n",
422                          mime_boundary_leader, opt->mime_boundary,
423                          filename.buf,
424                          opt->no_inline ? "attachment" : "inline",
425                          filename.buf);
426                 opt->diffopt.stat_sep = buffer.buf;
427                 strbuf_release(&filename);
428         }
429         *extra_headers_p = extra_headers;
430 }
431
432 static void show_sig_lines(struct rev_info *opt, int status, const char *bol)
433 {
434         const char *color, *reset, *eol;
435
436         color = diff_get_color_opt(&opt->diffopt,
437                                    status ? DIFF_WHITESPACE : DIFF_FRAGINFO);
438         reset = diff_get_color_opt(&opt->diffopt, DIFF_RESET);
439         while (*bol) {
440                 eol = strchrnul(bol, '\n');
441                 fprintf(opt->diffopt.file, "%s%.*s%s%s", color, (int)(eol - bol), bol, reset,
442                        *eol ? "\n" : "");
443                 graph_show_oneline(opt->graph);
444                 bol = (*eol) ? (eol + 1) : eol;
445         }
446 }
447
448 static void show_signature(struct rev_info *opt, struct commit *commit)
449 {
450         struct strbuf payload = STRBUF_INIT;
451         struct strbuf signature = STRBUF_INIT;
452         struct signature_check sigc = { 0 };
453         int status;
454
455         if (parse_signed_commit(commit, &payload, &signature) <= 0)
456                 goto out;
457
458         status = check_signature(payload.buf, payload.len, signature.buf,
459                                  signature.len, &sigc);
460         if (status && sigc.result == 'N')
461                 show_sig_lines(opt, status, "No signature\n");
462         else {
463                 show_sig_lines(opt, status, sigc.gpg_output);
464                 signature_check_clear(&sigc);
465         }
466
467  out:
468         strbuf_release(&payload);
469         strbuf_release(&signature);
470 }
471
472 static int which_parent(const struct object_id *oid, const struct commit *commit)
473 {
474         int nth;
475         const struct commit_list *parent;
476
477         for (nth = 0, parent = commit->parents; parent; parent = parent->next) {
478                 if (oideq(&parent->item->object.oid, oid))
479                         return nth;
480                 nth++;
481         }
482         return -1;
483 }
484
485 static int is_common_merge(const struct commit *commit)
486 {
487         return (commit->parents
488                 && commit->parents->next
489                 && !commit->parents->next->next);
490 }
491
492 static int show_one_mergetag(struct commit *commit,
493                              struct commit_extra_header *extra,
494                              void *data)
495 {
496         struct rev_info *opt = (struct rev_info *)data;
497         struct object_id oid;
498         struct tag *tag;
499         struct strbuf verify_message;
500         struct signature_check sigc = { 0 };
501         int status, nth;
502         size_t payload_size, gpg_message_offset;
503
504         hash_object_file(extra->value, extra->len, type_name(OBJ_TAG), &oid);
505         tag = lookup_tag(the_repository, &oid);
506         if (!tag)
507                 return -1; /* error message already given */
508
509         strbuf_init(&verify_message, 256);
510         if (parse_tag_buffer(the_repository, tag, extra->value, extra->len))
511                 strbuf_addstr(&verify_message, "malformed mergetag\n");
512         else if (is_common_merge(commit) &&
513                  oideq(&tag->tagged->oid,
514                        &commit->parents->next->item->object.oid))
515                 strbuf_addf(&verify_message,
516                             "merged tag '%s'\n", tag->tag);
517         else if ((nth = which_parent(&tag->tagged->oid, commit)) < 0)
518                 strbuf_addf(&verify_message, "tag %s names a non-parent %s\n",
519                                     tag->tag, tag->tagged->oid.hash);
520         else
521                 strbuf_addf(&verify_message,
522                             "parent #%d, tagged '%s'\n", nth + 1, tag->tag);
523         gpg_message_offset = verify_message.len;
524
525         payload_size = parse_signature(extra->value, extra->len);
526         status = -1;
527         if (extra->len > payload_size) {
528                 /* could have a good signature */
529                 if (!check_signature(extra->value, payload_size,
530                                      extra->value + payload_size,
531                                      extra->len - payload_size, &sigc)) {
532                         strbuf_addstr(&verify_message, sigc.gpg_output);
533                         signature_check_clear(&sigc);
534                         status = 0; /* good */
535                 } else if (verify_message.len <= gpg_message_offset)
536                         strbuf_addstr(&verify_message, "No signature\n");
537                 /* otherwise we couldn't verify, which is shown as bad */
538         }
539
540         show_sig_lines(opt, status, verify_message.buf);
541         strbuf_release(&verify_message);
542         return 0;
543 }
544
545 static int show_mergetag(struct rev_info *opt, struct commit *commit)
546 {
547         return for_each_mergetag(show_one_mergetag, commit, opt);
548 }
549
550 static void next_commentary_block(struct rev_info *opt, struct strbuf *sb)
551 {
552         const char *x = opt->shown_dashes ? "\n" : "---\n";
553         if (sb)
554                 strbuf_addstr(sb, x);
555         else
556                 fputs(x, opt->diffopt.file);
557         opt->shown_dashes = 1;
558 }
559
560 void show_log(struct rev_info *opt)
561 {
562         struct strbuf msgbuf = STRBUF_INIT;
563         struct log_info *log = opt->loginfo;
564         struct commit *commit = log->commit, *parent = log->parent;
565         int abbrev_commit = opt->abbrev_commit ? opt->abbrev : the_hash_algo->hexsz;
566         const char *extra_headers = opt->extra_headers;
567         struct pretty_print_context ctx = {0};
568
569         opt->loginfo = NULL;
570         if (!opt->verbose_header) {
571                 graph_show_commit(opt->graph);
572
573                 if (!opt->graph)
574                         put_revision_mark(opt, commit);
575                 fputs(find_unique_abbrev(&commit->object.oid, abbrev_commit), opt->diffopt.file);
576                 if (opt->print_parents)
577                         show_parents(commit, abbrev_commit, opt->diffopt.file);
578                 if (opt->children.name)
579                         show_children(opt, commit, abbrev_commit);
580                 show_decorations(opt, commit);
581                 if (opt->graph && !graph_is_commit_finished(opt->graph)) {
582                         putc('\n', opt->diffopt.file);
583                         graph_show_remainder(opt->graph);
584                 }
585                 putc(opt->diffopt.line_termination, opt->diffopt.file);
586                 return;
587         }
588
589         /*
590          * If use_terminator is set, we already handled any record termination
591          * at the end of the last record.
592          * Otherwise, add a diffopt.line_termination character before all
593          * entries but the first.  (IOW, as a separator between entries)
594          */
595         if (opt->shown_one && !opt->use_terminator) {
596                 /*
597                  * If entries are separated by a newline, the output
598                  * should look human-readable.  If the last entry ended
599                  * with a newline, print the graph output before this
600                  * newline.  Otherwise it will end up as a completely blank
601                  * line and will look like a gap in the graph.
602                  *
603                  * If the entry separator is not a newline, the output is
604                  * primarily intended for programmatic consumption, and we
605                  * never want the extra graph output before the entry
606                  * separator.
607                  */
608                 if (opt->diffopt.line_termination == '\n' &&
609                     !opt->missing_newline)
610                         graph_show_padding(opt->graph);
611                 putc(opt->diffopt.line_termination, opt->diffopt.file);
612         }
613         opt->shown_one = 1;
614
615         /*
616          * If the history graph was requested,
617          * print the graph, up to this commit's line
618          */
619         graph_show_commit(opt->graph);
620
621         /*
622          * Print header line of header..
623          */
624
625         if (cmit_fmt_is_mail(opt->commit_format)) {
626                 log_write_email_headers(opt, commit, &extra_headers,
627                                         &ctx.need_8bit_cte, 1);
628                 ctx.rev = opt;
629                 ctx.print_email_subject = 1;
630         } else if (opt->commit_format != CMIT_FMT_USERFORMAT) {
631                 fputs(diff_get_color_opt(&opt->diffopt, DIFF_COMMIT), opt->diffopt.file);
632                 if (opt->commit_format != CMIT_FMT_ONELINE)
633                         fputs("commit ", opt->diffopt.file);
634
635                 if (!opt->graph)
636                         put_revision_mark(opt, commit);
637                 fputs(find_unique_abbrev(&commit->object.oid,
638                                          abbrev_commit),
639                       opt->diffopt.file);
640                 if (opt->print_parents)
641                         show_parents(commit, abbrev_commit, opt->diffopt.file);
642                 if (opt->children.name)
643                         show_children(opt, commit, abbrev_commit);
644                 if (parent)
645                         fprintf(opt->diffopt.file, " (from %s)",
646                                find_unique_abbrev(&parent->object.oid, abbrev_commit));
647                 fputs(diff_get_color_opt(&opt->diffopt, DIFF_RESET), opt->diffopt.file);
648                 show_decorations(opt, commit);
649                 if (opt->commit_format == CMIT_FMT_ONELINE) {
650                         putc(' ', opt->diffopt.file);
651                 } else {
652                         putc('\n', opt->diffopt.file);
653                         graph_show_oneline(opt->graph);
654                 }
655                 if (opt->reflog_info) {
656                         /*
657                          * setup_revisions() ensures that opt->reflog_info
658                          * and opt->graph cannot both be set,
659                          * so we don't need to worry about printing the
660                          * graph info here.
661                          */
662                         show_reflog_message(opt->reflog_info,
663                                             opt->commit_format == CMIT_FMT_ONELINE,
664                                             &opt->date_mode,
665                                             opt->date_mode_explicit);
666                         if (opt->commit_format == CMIT_FMT_ONELINE)
667                                 return;
668                 }
669         }
670
671         if (opt->show_signature) {
672                 show_signature(opt, commit);
673                 show_mergetag(opt, commit);
674         }
675
676         if (opt->show_notes) {
677                 int raw;
678                 struct strbuf notebuf = STRBUF_INIT;
679
680                 raw = (opt->commit_format == CMIT_FMT_USERFORMAT);
681                 format_display_notes(&commit->object.oid, &notebuf,
682                                      get_log_output_encoding(), raw);
683                 ctx.notes_message = strbuf_detach(&notebuf, NULL);
684         }
685
686         /*
687          * And then the pretty-printed message itself
688          */
689         if (ctx.need_8bit_cte >= 0 && opt->add_signoff)
690                 ctx.need_8bit_cte =
691                         has_non_ascii(fmt_name(WANT_COMMITTER_IDENT));
692         ctx.date_mode = opt->date_mode;
693         ctx.date_mode_explicit = opt->date_mode_explicit;
694         ctx.abbrev = opt->diffopt.abbrev;
695         ctx.after_subject = extra_headers;
696         ctx.preserve_subject = opt->preserve_subject;
697         ctx.reflog_info = opt->reflog_info;
698         ctx.fmt = opt->commit_format;
699         ctx.mailmap = opt->mailmap;
700         ctx.color = opt->diffopt.use_color;
701         ctx.expand_tabs_in_log = opt->expand_tabs_in_log;
702         ctx.output_encoding = get_log_output_encoding();
703         ctx.rev = opt;
704         if (opt->from_ident.mail_begin && opt->from_ident.name_begin)
705                 ctx.from_ident = &opt->from_ident;
706         if (opt->graph)
707                 ctx.graph_width = graph_width(opt->graph);
708         pretty_print_commit(&ctx, commit, &msgbuf);
709
710         if (opt->add_signoff)
711                 append_signoff(&msgbuf, 0, APPEND_SIGNOFF_DEDUP);
712
713         if ((ctx.fmt != CMIT_FMT_USERFORMAT) &&
714             ctx.notes_message && *ctx.notes_message) {
715                 if (cmit_fmt_is_mail(ctx.fmt))
716                         next_commentary_block(opt, &msgbuf);
717                 strbuf_addstr(&msgbuf, ctx.notes_message);
718         }
719
720         if (opt->show_log_size) {
721                 fprintf(opt->diffopt.file, "log size %i\n", (int)msgbuf.len);
722                 graph_show_oneline(opt->graph);
723         }
724
725         /*
726          * Set opt->missing_newline if msgbuf doesn't
727          * end in a newline (including if it is empty)
728          */
729         if (!msgbuf.len || msgbuf.buf[msgbuf.len - 1] != '\n')
730                 opt->missing_newline = 1;
731         else
732                 opt->missing_newline = 0;
733
734         graph_show_commit_msg(opt->graph, opt->diffopt.file, &msgbuf);
735         if (opt->use_terminator && !commit_format_is_empty(opt->commit_format)) {
736                 if (!opt->missing_newline)
737                         graph_show_padding(opt->graph);
738                 putc(opt->diffopt.line_termination, opt->diffopt.file);
739         }
740
741         strbuf_release(&msgbuf);
742         free(ctx.notes_message);
743
744         if (cmit_fmt_is_mail(ctx.fmt) && opt->idiff_oid1) {
745                 struct diff_queue_struct dq;
746
747                 memcpy(&dq, &diff_queued_diff, sizeof(diff_queued_diff));
748                 DIFF_QUEUE_CLEAR(&diff_queued_diff);
749
750                 next_commentary_block(opt, NULL);
751                 fprintf_ln(opt->diffopt.file, "%s", opt->idiff_title);
752                 show_interdiff(opt, 2);
753
754                 memcpy(&diff_queued_diff, &dq, sizeof(diff_queued_diff));
755         }
756
757         if (cmit_fmt_is_mail(ctx.fmt) && opt->rdiff1) {
758                 struct diff_queue_struct dq;
759                 struct diff_options opts;
760
761                 memcpy(&dq, &diff_queued_diff, sizeof(diff_queued_diff));
762                 DIFF_QUEUE_CLEAR(&diff_queued_diff);
763
764                 next_commentary_block(opt, NULL);
765                 fprintf_ln(opt->diffopt.file, "%s", opt->rdiff_title);
766                 /*
767                  * Pass minimum required diff-options to range-diff; others
768                  * can be added later if deemed desirable.
769                  */
770                 diff_setup(&opts);
771                 opts.file = opt->diffopt.file;
772                 opts.use_color = opt->diffopt.use_color;
773                 diff_setup_done(&opts);
774                 show_range_diff(opt->rdiff1, opt->rdiff2,
775                                 opt->creation_factor, 1, &opts, NULL);
776
777                 memcpy(&diff_queued_diff, &dq, sizeof(diff_queued_diff));
778         }
779 }
780
781 int log_tree_diff_flush(struct rev_info *opt)
782 {
783         opt->shown_dashes = 0;
784         diffcore_std(&opt->diffopt);
785
786         if (diff_queue_is_empty()) {
787                 int saved_fmt = opt->diffopt.output_format;
788                 opt->diffopt.output_format = DIFF_FORMAT_NO_OUTPUT;
789                 diff_flush(&opt->diffopt);
790                 opt->diffopt.output_format = saved_fmt;
791                 return 0;
792         }
793
794         if (opt->loginfo && !opt->no_commit_id) {
795                 show_log(opt);
796                 if ((opt->diffopt.output_format & ~DIFF_FORMAT_NO_OUTPUT) &&
797                     opt->verbose_header &&
798                     opt->commit_format != CMIT_FMT_ONELINE &&
799                     !commit_format_is_empty(opt->commit_format)) {
800                         /*
801                          * When showing a verbose header (i.e. log message),
802                          * and not in --pretty=oneline format, we would want
803                          * an extra newline between the end of log and the
804                          * diff/diffstat output for readability.
805                          */
806                         int pch = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_PATCH;
807                         if (opt->diffopt.output_prefix) {
808                                 struct strbuf *msg = NULL;
809                                 msg = opt->diffopt.output_prefix(&opt->diffopt,
810                                         opt->diffopt.output_prefix_data);
811                                 fwrite(msg->buf, msg->len, 1, opt->diffopt.file);
812                         }
813
814                         /*
815                          * We may have shown three-dashes line early
816                          * between generated commentary (notes, etc.)
817                          * and the log message, in which case we only
818                          * want a blank line after the commentary
819                          * without (an extra) three-dashes line.
820                          * Otherwise, we show the three-dashes line if
821                          * we are showing the patch with diffstat, but
822                          * in that case, there is no extra blank line
823                          * after the three-dashes line.
824                          */
825                         if (!opt->shown_dashes &&
826                             (pch & opt->diffopt.output_format) == pch)
827                                 fprintf(opt->diffopt.file, "---");
828                         putc('\n', opt->diffopt.file);
829                 }
830         }
831         diff_flush(&opt->diffopt);
832         return 1;
833 }
834
835 static int do_diff_combined(struct rev_info *opt, struct commit *commit)
836 {
837         diff_tree_combined_merge(commit, opt->dense_combined_merges, opt);
838         return !opt->loginfo;
839 }
840
841 /*
842  * Show the diff of a commit.
843  *
844  * Return true if we printed any log info messages
845  */
846 static int log_tree_diff(struct rev_info *opt, struct commit *commit, struct log_info *log)
847 {
848         int showed_log;
849         struct commit_list *parents;
850         struct object_id *oid;
851
852         if (!opt->diff && !opt->diffopt.flags.exit_with_status)
853                 return 0;
854
855         parse_commit_or_die(commit);
856         oid = get_commit_tree_oid(commit);
857
858         /* Root commit? */
859         parents = get_saved_parents(opt, commit);
860         if (!parents) {
861                 if (opt->show_root_diff) {
862                         diff_root_tree_oid(oid, "", &opt->diffopt);
863                         log_tree_diff_flush(opt);
864                 }
865                 return !opt->loginfo;
866         }
867
868         /* More than one parent? */
869         if (parents && parents->next) {
870                 if (opt->ignore_merges)
871                         return 0;
872                 else if (opt->combine_merges)
873                         return do_diff_combined(opt, commit);
874                 else if (opt->first_parent_only) {
875                         /*
876                          * Generate merge log entry only for the first
877                          * parent, showing summary diff of the others
878                          * we merged _in_.
879                          */
880                         parse_commit_or_die(parents->item);
881                         diff_tree_oid(get_commit_tree_oid(parents->item),
882                                       oid, "", &opt->diffopt);
883                         log_tree_diff_flush(opt);
884                         return !opt->loginfo;
885                 }
886
887                 /* If we show individual diffs, show the parent info */
888                 log->parent = parents->item;
889         }
890
891         showed_log = 0;
892         for (;;) {
893                 struct commit *parent = parents->item;
894
895                 parse_commit_or_die(parent);
896                 diff_tree_oid(get_commit_tree_oid(parent),
897                               oid, "", &opt->diffopt);
898                 log_tree_diff_flush(opt);
899
900                 showed_log |= !opt->loginfo;
901
902                 /* Set up the log info for the next parent, if any.. */
903                 parents = parents->next;
904                 if (!parents)
905                         break;
906                 log->parent = parents->item;
907                 opt->loginfo = log;
908         }
909         return showed_log;
910 }
911
912 int log_tree_commit(struct rev_info *opt, struct commit *commit)
913 {
914         struct log_info log;
915         int shown, close_file = opt->diffopt.close_file;
916
917         log.commit = commit;
918         log.parent = NULL;
919         opt->loginfo = &log;
920         opt->diffopt.close_file = 0;
921
922         if (opt->line_level_traverse)
923                 return line_log_print(opt, commit);
924
925         if (opt->track_linear && !opt->linear && !opt->reverse_output_stage)
926                 fprintf(opt->diffopt.file, "\n%s\n", opt->break_bar);
927         shown = log_tree_diff(opt, commit, &log);
928         if (!shown && opt->loginfo && opt->always_show_header) {
929                 log.parent = NULL;
930                 show_log(opt);
931                 shown = 1;
932         }
933         if (opt->track_linear && !opt->linear && opt->reverse_output_stage)
934                 fprintf(opt->diffopt.file, "\n%s\n", opt->break_bar);
935         opt->loginfo = NULL;
936         maybe_flush_or_die(opt->diffopt.file, "stdout");
937         if (close_file)
938                 fclose(opt->diffopt.file);
939         return shown;
940 }