parseopt: group literal string alternatives in argument help
[alt-git.git] / log-tree.c
blob4aef85331e0b696d0373cf1bdb0743a7e6b58c36
1 #include "cache.h"
2 #include "config.h"
3 #include "diff.h"
4 #include "commit.h"
5 #include "tag.h"
6 #include "graph.h"
7 #include "log-tree.h"
8 #include "reflog-walk.h"
9 #include "refs.h"
10 #include "string-list.h"
11 #include "color.h"
12 #include "gpg-interface.h"
13 #include "sequencer.h"
14 #include "line-log.h"
16 static struct decoration name_decoration = { "object names" };
17 static int decoration_loaded;
18 static int decoration_flags;
20 static char decoration_colors[][COLOR_MAXLEN] = {
21 GIT_COLOR_RESET,
22 GIT_COLOR_BOLD_GREEN, /* REF_LOCAL */
23 GIT_COLOR_BOLD_RED, /* REF_REMOTE */
24 GIT_COLOR_BOLD_YELLOW, /* REF_TAG */
25 GIT_COLOR_BOLD_MAGENTA, /* REF_STASH */
26 GIT_COLOR_BOLD_CYAN, /* REF_HEAD */
27 GIT_COLOR_BOLD_BLUE, /* GRAFTED */
30 static const char *decorate_get_color(int decorate_use_color, enum decoration_type ix)
32 if (want_color(decorate_use_color))
33 return decoration_colors[ix];
34 return "";
37 static int parse_decorate_color_slot(const char *slot)
40 * We're comparing with 'ignore-case' on
41 * (because config.c sets them all tolower),
42 * but let's match the letters in the literal
43 * string values here with how they are
44 * documented in Documentation/config.txt, for
45 * consistency.
47 * We love being consistent, don't we?
49 if (!strcasecmp(slot, "branch"))
50 return DECORATION_REF_LOCAL;
51 if (!strcasecmp(slot, "remoteBranch"))
52 return DECORATION_REF_REMOTE;
53 if (!strcasecmp(slot, "tag"))
54 return DECORATION_REF_TAG;
55 if (!strcasecmp(slot, "stash"))
56 return DECORATION_REF_STASH;
57 if (!strcasecmp(slot, "HEAD"))
58 return DECORATION_REF_HEAD;
59 return -1;
62 int parse_decorate_color_config(const char *var, const char *slot_name, const char *value)
64 int slot = parse_decorate_color_slot(slot_name);
65 if (slot < 0)
66 return 0;
67 if (!value)
68 return config_error_nonbool(var);
69 return color_parse(value, decoration_colors[slot]);
73 * log-tree.c uses DIFF_OPT_TST for determining whether to use color
74 * for showing the commit sha1, use the same check for --decorate
76 #define decorate_get_color_opt(o, ix) \
77 decorate_get_color((o)->use_color, ix)
79 void add_name_decoration(enum decoration_type type, const char *name, struct object *obj)
81 struct name_decoration *res;
82 FLEX_ALLOC_STR(res, name, name);
83 res->type = type;
84 res->next = add_decoration(&name_decoration, obj, res);
87 const struct name_decoration *get_name_decoration(const struct object *obj)
89 return lookup_decoration(&name_decoration, obj);
92 static int add_ref_decoration(const char *refname, const struct object_id *oid,
93 int flags, void *cb_data)
95 struct object *obj;
96 enum decoration_type type = DECORATION_NONE;
97 struct decoration_filter *filter = (struct decoration_filter *)cb_data;
99 if (filter && !ref_filter_match(refname,
100 filter->include_ref_pattern,
101 filter->exclude_ref_pattern))
102 return 0;
104 if (starts_with(refname, git_replace_ref_base)) {
105 struct object_id original_oid;
106 if (!check_replace_refs)
107 return 0;
108 if (get_oid_hex(refname + strlen(git_replace_ref_base),
109 &original_oid)) {
110 warning("invalid replace ref %s", refname);
111 return 0;
113 obj = parse_object(&original_oid);
114 if (obj)
115 add_name_decoration(DECORATION_GRAFTED, "replaced", obj);
116 return 0;
119 obj = parse_object(oid);
120 if (!obj)
121 return 0;
123 if (starts_with(refname, "refs/heads/"))
124 type = DECORATION_REF_LOCAL;
125 else if (starts_with(refname, "refs/remotes/"))
126 type = DECORATION_REF_REMOTE;
127 else if (starts_with(refname, "refs/tags/"))
128 type = DECORATION_REF_TAG;
129 else if (!strcmp(refname, "refs/stash"))
130 type = DECORATION_REF_STASH;
131 else if (!strcmp(refname, "HEAD"))
132 type = DECORATION_REF_HEAD;
134 add_name_decoration(type, refname, obj);
135 while (obj->type == OBJ_TAG) {
136 obj = ((struct tag *)obj)->tagged;
137 if (!obj)
138 break;
139 if (!obj->parsed)
140 parse_object(&obj->oid);
141 add_name_decoration(DECORATION_REF_TAG, refname, obj);
143 return 0;
146 static int add_graft_decoration(const struct commit_graft *graft, void *cb_data)
148 struct commit *commit = lookup_commit(&graft->oid);
149 if (!commit)
150 return 0;
151 add_name_decoration(DECORATION_GRAFTED, "grafted", &commit->object);
152 return 0;
155 void load_ref_decorations(struct decoration_filter *filter, int flags)
157 if (!decoration_loaded) {
158 if (filter) {
159 struct string_list_item *item;
160 for_each_string_list_item(item, filter->exclude_ref_pattern) {
161 normalize_glob_ref(item, NULL, item->string);
163 for_each_string_list_item(item, filter->include_ref_pattern) {
164 normalize_glob_ref(item, NULL, item->string);
167 decoration_loaded = 1;
168 decoration_flags = flags;
169 for_each_ref(add_ref_decoration, filter);
170 head_ref(add_ref_decoration, filter);
171 for_each_commit_graft(add_graft_decoration, filter);
175 static void show_parents(struct commit *commit, int abbrev, FILE *file)
177 struct commit_list *p;
178 for (p = commit->parents; p ; p = p->next) {
179 struct commit *parent = p->item;
180 fprintf(file, " %s", find_unique_abbrev(&parent->object.oid, abbrev));
184 static void show_children(struct rev_info *opt, struct commit *commit, int abbrev)
186 struct commit_list *p = lookup_decoration(&opt->children, &commit->object);
187 for ( ; p; p = p->next) {
188 fprintf(opt->diffopt.file, " %s", find_unique_abbrev(&p->item->object.oid, abbrev));
193 * Do we have HEAD in the output, and also the branch it points at?
194 * If so, find that decoration entry for that current branch.
196 static const struct name_decoration *current_pointed_by_HEAD(const struct name_decoration *decoration)
198 const struct name_decoration *list, *head = NULL;
199 const char *branch_name = NULL;
200 int rru_flags;
202 /* First find HEAD */
203 for (list = decoration; list; list = list->next)
204 if (list->type == DECORATION_REF_HEAD) {
205 head = list;
206 break;
208 if (!head)
209 return NULL;
211 /* Now resolve and find the matching current branch */
212 branch_name = resolve_ref_unsafe("HEAD", 0, NULL, &rru_flags);
213 if (!branch_name || !(rru_flags & REF_ISSYMREF))
214 return NULL;
216 if (!starts_with(branch_name, "refs/"))
217 return NULL;
219 /* OK, do we have that ref in the list? */
220 for (list = decoration; list; list = list->next)
221 if ((list->type == DECORATION_REF_LOCAL) &&
222 !strcmp(branch_name, list->name)) {
223 return list;
226 return NULL;
229 static void show_name(struct strbuf *sb, const struct name_decoration *decoration)
231 if (decoration_flags == DECORATE_SHORT_REFS)
232 strbuf_addstr(sb, prettify_refname(decoration->name));
233 else
234 strbuf_addstr(sb, decoration->name);
238 * The caller makes sure there is no funny color before calling.
239 * format_decorations_extended makes sure the same after return.
241 void format_decorations_extended(struct strbuf *sb,
242 const struct commit *commit,
243 int use_color,
244 const char *prefix,
245 const char *separator,
246 const char *suffix)
248 const struct name_decoration *decoration;
249 const struct name_decoration *current_and_HEAD;
250 const char *color_commit =
251 diff_get_color(use_color, DIFF_COMMIT);
252 const char *color_reset =
253 decorate_get_color(use_color, DECORATION_NONE);
255 decoration = get_name_decoration(&commit->object);
256 if (!decoration)
257 return;
259 current_and_HEAD = current_pointed_by_HEAD(decoration);
260 while (decoration) {
262 * When both current and HEAD are there, only
263 * show HEAD->current where HEAD would have
264 * appeared, skipping the entry for current.
266 if (decoration != current_and_HEAD) {
267 strbuf_addstr(sb, color_commit);
268 strbuf_addstr(sb, prefix);
269 strbuf_addstr(sb, color_reset);
270 strbuf_addstr(sb, decorate_get_color(use_color, decoration->type));
271 if (decoration->type == DECORATION_REF_TAG)
272 strbuf_addstr(sb, "tag: ");
274 show_name(sb, decoration);
276 if (current_and_HEAD &&
277 decoration->type == DECORATION_REF_HEAD) {
278 strbuf_addstr(sb, " -> ");
279 strbuf_addstr(sb, color_reset);
280 strbuf_addstr(sb, decorate_get_color(use_color, current_and_HEAD->type));
281 show_name(sb, current_and_HEAD);
283 strbuf_addstr(sb, color_reset);
285 prefix = separator;
287 decoration = decoration->next;
289 strbuf_addstr(sb, color_commit);
290 strbuf_addstr(sb, suffix);
291 strbuf_addstr(sb, color_reset);
294 void show_decorations(struct rev_info *opt, struct commit *commit)
296 struct strbuf sb = STRBUF_INIT;
298 if (opt->show_source && commit->util)
299 fprintf(opt->diffopt.file, "\t%s", (char *) commit->util);
300 if (!opt->show_decorations)
301 return;
302 format_decorations(&sb, commit, opt->diffopt.use_color);
303 fputs(sb.buf, opt->diffopt.file);
304 strbuf_release(&sb);
307 static unsigned int digits_in_number(unsigned int number)
309 unsigned int i = 10, result = 1;
310 while (i <= number) {
311 i *= 10;
312 result++;
314 return result;
317 void fmt_output_subject(struct strbuf *filename,
318 const char *subject,
319 struct rev_info *info)
321 const char *suffix = info->patch_suffix;
322 int nr = info->nr;
323 int start_len = filename->len;
324 int max_len = start_len + FORMAT_PATCH_NAME_MAX - (strlen(suffix) + 1);
326 if (0 < info->reroll_count)
327 strbuf_addf(filename, "v%d-", info->reroll_count);
328 strbuf_addf(filename, "%04d-%s", nr, subject);
330 if (max_len < filename->len)
331 strbuf_setlen(filename, max_len);
332 strbuf_addstr(filename, suffix);
335 void fmt_output_commit(struct strbuf *filename,
336 struct commit *commit,
337 struct rev_info *info)
339 struct pretty_print_context ctx = {0};
340 struct strbuf subject = STRBUF_INIT;
342 format_commit_message(commit, "%f", &subject, &ctx);
343 fmt_output_subject(filename, subject.buf, info);
344 strbuf_release(&subject);
347 void fmt_output_email_subject(struct strbuf *sb, struct rev_info *opt)
349 if (opt->total > 0) {
350 strbuf_addf(sb, "Subject: [%s%s%0*d/%d] ",
351 opt->subject_prefix,
352 *opt->subject_prefix ? " " : "",
353 digits_in_number(opt->total),
354 opt->nr, opt->total);
355 } else if (opt->total == 0 && opt->subject_prefix && *opt->subject_prefix) {
356 strbuf_addf(sb, "Subject: [%s] ",
357 opt->subject_prefix);
358 } else {
359 strbuf_addstr(sb, "Subject: ");
363 void log_write_email_headers(struct rev_info *opt, struct commit *commit,
364 const char **extra_headers_p,
365 int *need_8bit_cte_p,
366 int maybe_multipart)
368 const char *extra_headers = opt->extra_headers;
369 const char *name = oid_to_hex(opt->zero_commit ?
370 &null_oid : &commit->object.oid);
372 *need_8bit_cte_p = 0; /* unknown */
374 fprintf(opt->diffopt.file, "From %s Mon Sep 17 00:00:00 2001\n", name);
375 graph_show_oneline(opt->graph);
376 if (opt->message_id) {
377 fprintf(opt->diffopt.file, "Message-Id: <%s>\n", opt->message_id);
378 graph_show_oneline(opt->graph);
380 if (opt->ref_message_ids && opt->ref_message_ids->nr > 0) {
381 int i, n;
382 n = opt->ref_message_ids->nr;
383 fprintf(opt->diffopt.file, "In-Reply-To: <%s>\n", opt->ref_message_ids->items[n-1].string);
384 for (i = 0; i < n; i++)
385 fprintf(opt->diffopt.file, "%s<%s>\n", (i > 0 ? "\t" : "References: "),
386 opt->ref_message_ids->items[i].string);
387 graph_show_oneline(opt->graph);
389 if (opt->mime_boundary && maybe_multipart) {
390 static struct strbuf subject_buffer = STRBUF_INIT;
391 static struct strbuf buffer = STRBUF_INIT;
392 struct strbuf filename = STRBUF_INIT;
393 *need_8bit_cte_p = -1; /* NEVER */
395 strbuf_reset(&subject_buffer);
396 strbuf_reset(&buffer);
398 strbuf_addf(&subject_buffer,
399 "%s"
400 "MIME-Version: 1.0\n"
401 "Content-Type: multipart/mixed;"
402 " boundary=\"%s%s\"\n"
403 "\n"
404 "This is a multi-part message in MIME "
405 "format.\n"
406 "--%s%s\n"
407 "Content-Type: text/plain; "
408 "charset=UTF-8; format=fixed\n"
409 "Content-Transfer-Encoding: 8bit\n\n",
410 extra_headers ? extra_headers : "",
411 mime_boundary_leader, opt->mime_boundary,
412 mime_boundary_leader, opt->mime_boundary);
413 extra_headers = subject_buffer.buf;
415 if (opt->numbered_files)
416 strbuf_addf(&filename, "%d", opt->nr);
417 else
418 fmt_output_commit(&filename, commit, opt);
419 strbuf_addf(&buffer,
420 "\n--%s%s\n"
421 "Content-Type: text/x-patch;"
422 " name=\"%s\"\n"
423 "Content-Transfer-Encoding: 8bit\n"
424 "Content-Disposition: %s;"
425 " filename=\"%s\"\n\n",
426 mime_boundary_leader, opt->mime_boundary,
427 filename.buf,
428 opt->no_inline ? "attachment" : "inline",
429 filename.buf);
430 opt->diffopt.stat_sep = buffer.buf;
431 strbuf_release(&filename);
433 *extra_headers_p = extra_headers;
436 static void show_sig_lines(struct rev_info *opt, int status, const char *bol)
438 const char *color, *reset, *eol;
440 color = diff_get_color_opt(&opt->diffopt,
441 status ? DIFF_WHITESPACE : DIFF_FRAGINFO);
442 reset = diff_get_color_opt(&opt->diffopt, DIFF_RESET);
443 while (*bol) {
444 eol = strchrnul(bol, '\n');
445 fprintf(opt->diffopt.file, "%s%.*s%s%s", color, (int)(eol - bol), bol, reset,
446 *eol ? "\n" : "");
447 graph_show_oneline(opt->graph);
448 bol = (*eol) ? (eol + 1) : eol;
452 static void show_signature(struct rev_info *opt, struct commit *commit)
454 struct strbuf payload = STRBUF_INIT;
455 struct strbuf signature = STRBUF_INIT;
456 struct strbuf gpg_output = STRBUF_INIT;
457 int status;
459 if (parse_signed_commit(commit, &payload, &signature) <= 0)
460 goto out;
462 status = verify_signed_buffer(payload.buf, payload.len,
463 signature.buf, signature.len,
464 &gpg_output, NULL);
465 if (status && !gpg_output.len)
466 strbuf_addstr(&gpg_output, "No signature\n");
468 show_sig_lines(opt, status, gpg_output.buf);
470 out:
471 strbuf_release(&gpg_output);
472 strbuf_release(&payload);
473 strbuf_release(&signature);
476 static int which_parent(const struct object_id *oid, const struct commit *commit)
478 int nth;
479 const struct commit_list *parent;
481 for (nth = 0, parent = commit->parents; parent; parent = parent->next) {
482 if (!oidcmp(&parent->item->object.oid, oid))
483 return nth;
484 nth++;
486 return -1;
489 static int is_common_merge(const struct commit *commit)
491 return (commit->parents
492 && commit->parents->next
493 && !commit->parents->next->next);
496 static int show_one_mergetag(struct commit *commit,
497 struct commit_extra_header *extra,
498 void *data)
500 struct rev_info *opt = (struct rev_info *)data;
501 struct object_id oid;
502 struct tag *tag;
503 struct strbuf verify_message;
504 int status, nth;
505 size_t payload_size, gpg_message_offset;
507 hash_object_file(extra->value, extra->len, type_name(OBJ_TAG), &oid);
508 tag = lookup_tag(&oid);
509 if (!tag)
510 return -1; /* error message already given */
512 strbuf_init(&verify_message, 256);
513 if (parse_tag_buffer(tag, extra->value, extra->len))
514 strbuf_addstr(&verify_message, "malformed mergetag\n");
515 else if (is_common_merge(commit) &&
516 !oidcmp(&tag->tagged->oid,
517 &commit->parents->next->item->object.oid))
518 strbuf_addf(&verify_message,
519 "merged tag '%s'\n", tag->tag);
520 else if ((nth = which_parent(&tag->tagged->oid, commit)) < 0)
521 strbuf_addf(&verify_message, "tag %s names a non-parent %s\n",
522 tag->tag, tag->tagged->oid.hash);
523 else
524 strbuf_addf(&verify_message,
525 "parent #%d, tagged '%s'\n", nth + 1, tag->tag);
526 gpg_message_offset = verify_message.len;
528 payload_size = parse_signature(extra->value, extra->len);
529 status = -1;
530 if (extra->len > payload_size) {
531 /* could have a good signature */
532 if (!verify_signed_buffer(extra->value, payload_size,
533 extra->value + payload_size,
534 extra->len - payload_size,
535 &verify_message, NULL))
536 status = 0; /* good */
537 else if (verify_message.len <= gpg_message_offset)
538 strbuf_addstr(&verify_message, "No signature\n");
539 /* otherwise we couldn't verify, which is shown as bad */
542 show_sig_lines(opt, status, verify_message.buf);
543 strbuf_release(&verify_message);
544 return 0;
547 static int show_mergetag(struct rev_info *opt, struct commit *commit)
549 return for_each_mergetag(show_one_mergetag, commit, opt);
552 void show_log(struct rev_info *opt)
554 struct strbuf msgbuf = STRBUF_INIT;
555 struct log_info *log = opt->loginfo;
556 struct commit *commit = log->commit, *parent = log->parent;
557 int abbrev_commit = opt->abbrev_commit ? opt->abbrev : GIT_SHA1_HEXSZ;
558 const char *extra_headers = opt->extra_headers;
559 struct pretty_print_context ctx = {0};
561 opt->loginfo = NULL;
562 if (!opt->verbose_header) {
563 graph_show_commit(opt->graph);
565 if (!opt->graph)
566 put_revision_mark(opt, commit);
567 fputs(find_unique_abbrev(&commit->object.oid, abbrev_commit), opt->diffopt.file);
568 if (opt->print_parents)
569 show_parents(commit, abbrev_commit, opt->diffopt.file);
570 if (opt->children.name)
571 show_children(opt, commit, abbrev_commit);
572 show_decorations(opt, commit);
573 if (opt->graph && !graph_is_commit_finished(opt->graph)) {
574 putc('\n', opt->diffopt.file);
575 graph_show_remainder(opt->graph);
577 putc(opt->diffopt.line_termination, opt->diffopt.file);
578 return;
582 * If use_terminator is set, we already handled any record termination
583 * at the end of the last record.
584 * Otherwise, add a diffopt.line_termination character before all
585 * entries but the first. (IOW, as a separator between entries)
587 if (opt->shown_one && !opt->use_terminator) {
589 * If entries are separated by a newline, the output
590 * should look human-readable. If the last entry ended
591 * with a newline, print the graph output before this
592 * newline. Otherwise it will end up as a completely blank
593 * line and will look like a gap in the graph.
595 * If the entry separator is not a newline, the output is
596 * primarily intended for programmatic consumption, and we
597 * never want the extra graph output before the entry
598 * separator.
600 if (opt->diffopt.line_termination == '\n' &&
601 !opt->missing_newline)
602 graph_show_padding(opt->graph);
603 putc(opt->diffopt.line_termination, opt->diffopt.file);
605 opt->shown_one = 1;
608 * If the history graph was requested,
609 * print the graph, up to this commit's line
611 graph_show_commit(opt->graph);
614 * Print header line of header..
617 if (cmit_fmt_is_mail(opt->commit_format)) {
618 log_write_email_headers(opt, commit, &extra_headers,
619 &ctx.need_8bit_cte, 1);
620 ctx.rev = opt;
621 ctx.print_email_subject = 1;
622 } else if (opt->commit_format != CMIT_FMT_USERFORMAT) {
623 fputs(diff_get_color_opt(&opt->diffopt, DIFF_COMMIT), opt->diffopt.file);
624 if (opt->commit_format != CMIT_FMT_ONELINE)
625 fputs("commit ", opt->diffopt.file);
627 if (!opt->graph)
628 put_revision_mark(opt, commit);
629 fputs(find_unique_abbrev(&commit->object.oid,
630 abbrev_commit),
631 opt->diffopt.file);
632 if (opt->print_parents)
633 show_parents(commit, abbrev_commit, opt->diffopt.file);
634 if (opt->children.name)
635 show_children(opt, commit, abbrev_commit);
636 if (parent)
637 fprintf(opt->diffopt.file, " (from %s)",
638 find_unique_abbrev(&parent->object.oid, abbrev_commit));
639 fputs(diff_get_color_opt(&opt->diffopt, DIFF_RESET), opt->diffopt.file);
640 show_decorations(opt, commit);
641 if (opt->commit_format == CMIT_FMT_ONELINE) {
642 putc(' ', opt->diffopt.file);
643 } else {
644 putc('\n', opt->diffopt.file);
645 graph_show_oneline(opt->graph);
647 if (opt->reflog_info) {
649 * setup_revisions() ensures that opt->reflog_info
650 * and opt->graph cannot both be set,
651 * so we don't need to worry about printing the
652 * graph info here.
654 show_reflog_message(opt->reflog_info,
655 opt->commit_format == CMIT_FMT_ONELINE,
656 &opt->date_mode,
657 opt->date_mode_explicit);
658 if (opt->commit_format == CMIT_FMT_ONELINE)
659 return;
663 if (opt->show_signature) {
664 show_signature(opt, commit);
665 show_mergetag(opt, commit);
668 if (opt->show_notes) {
669 int raw;
670 struct strbuf notebuf = STRBUF_INIT;
672 raw = (opt->commit_format == CMIT_FMT_USERFORMAT);
673 format_display_notes(&commit->object.oid, &notebuf,
674 get_log_output_encoding(), raw);
675 ctx.notes_message = notebuf.len
676 ? strbuf_detach(&notebuf, NULL)
677 : xcalloc(1, 1);
681 * And then the pretty-printed message itself
683 if (ctx.need_8bit_cte >= 0 && opt->add_signoff)
684 ctx.need_8bit_cte =
685 has_non_ascii(fmt_name(getenv("GIT_COMMITTER_NAME"),
686 getenv("GIT_COMMITTER_EMAIL")));
687 ctx.date_mode = opt->date_mode;
688 ctx.date_mode_explicit = opt->date_mode_explicit;
689 ctx.abbrev = opt->diffopt.abbrev;
690 ctx.after_subject = extra_headers;
691 ctx.preserve_subject = opt->preserve_subject;
692 ctx.reflog_info = opt->reflog_info;
693 ctx.fmt = opt->commit_format;
694 ctx.mailmap = opt->mailmap;
695 ctx.color = opt->diffopt.use_color;
696 ctx.expand_tabs_in_log = opt->expand_tabs_in_log;
697 ctx.output_encoding = get_log_output_encoding();
698 if (opt->from_ident.mail_begin && opt->from_ident.name_begin)
699 ctx.from_ident = &opt->from_ident;
700 if (opt->graph)
701 ctx.graph_width = graph_width(opt->graph);
702 pretty_print_commit(&ctx, commit, &msgbuf);
704 if (opt->add_signoff)
705 append_signoff(&msgbuf, 0, APPEND_SIGNOFF_DEDUP);
707 if ((ctx.fmt != CMIT_FMT_USERFORMAT) &&
708 ctx.notes_message && *ctx.notes_message) {
709 if (cmit_fmt_is_mail(ctx.fmt)) {
710 strbuf_addstr(&msgbuf, "---\n");
711 opt->shown_dashes = 1;
713 strbuf_addstr(&msgbuf, ctx.notes_message);
716 if (opt->show_log_size) {
717 fprintf(opt->diffopt.file, "log size %i\n", (int)msgbuf.len);
718 graph_show_oneline(opt->graph);
722 * Set opt->missing_newline if msgbuf doesn't
723 * end in a newline (including if it is empty)
725 if (!msgbuf.len || msgbuf.buf[msgbuf.len - 1] != '\n')
726 opt->missing_newline = 1;
727 else
728 opt->missing_newline = 0;
730 graph_show_commit_msg(opt->graph, opt->diffopt.file, &msgbuf);
731 if (opt->use_terminator && !commit_format_is_empty(opt->commit_format)) {
732 if (!opt->missing_newline)
733 graph_show_padding(opt->graph);
734 putc(opt->diffopt.line_termination, opt->diffopt.file);
737 strbuf_release(&msgbuf);
738 free(ctx.notes_message);
741 int log_tree_diff_flush(struct rev_info *opt)
743 opt->shown_dashes = 0;
744 diffcore_std(&opt->diffopt);
746 if (diff_queue_is_empty()) {
747 int saved_fmt = opt->diffopt.output_format;
748 opt->diffopt.output_format = DIFF_FORMAT_NO_OUTPUT;
749 diff_flush(&opt->diffopt);
750 opt->diffopt.output_format = saved_fmt;
751 return 0;
754 if (opt->loginfo && !opt->no_commit_id) {
755 show_log(opt);
756 if ((opt->diffopt.output_format & ~DIFF_FORMAT_NO_OUTPUT) &&
757 opt->verbose_header &&
758 opt->commit_format != CMIT_FMT_ONELINE &&
759 !commit_format_is_empty(opt->commit_format)) {
761 * When showing a verbose header (i.e. log message),
762 * and not in --pretty=oneline format, we would want
763 * an extra newline between the end of log and the
764 * diff/diffstat output for readability.
766 int pch = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_PATCH;
767 if (opt->diffopt.output_prefix) {
768 struct strbuf *msg = NULL;
769 msg = opt->diffopt.output_prefix(&opt->diffopt,
770 opt->diffopt.output_prefix_data);
771 fwrite(msg->buf, msg->len, 1, opt->diffopt.file);
775 * We may have shown three-dashes line early
776 * between notes and the log message, in which
777 * case we only want a blank line after the
778 * notes without (an extra) three-dashes line.
779 * Otherwise, we show the three-dashes line if
780 * we are showing the patch with diffstat, but
781 * in that case, there is no extra blank line
782 * after the three-dashes line.
784 if (!opt->shown_dashes &&
785 (pch & opt->diffopt.output_format) == pch)
786 fprintf(opt->diffopt.file, "---");
787 putc('\n', opt->diffopt.file);
790 diff_flush(&opt->diffopt);
791 return 1;
794 static int do_diff_combined(struct rev_info *opt, struct commit *commit)
796 diff_tree_combined_merge(commit, opt->dense_combined_merges, opt);
797 return !opt->loginfo;
801 * Show the diff of a commit.
803 * Return true if we printed any log info messages
805 static int log_tree_diff(struct rev_info *opt, struct commit *commit, struct log_info *log)
807 int showed_log;
808 struct commit_list *parents;
809 struct object_id *oid;
811 if (!opt->diff && !opt->diffopt.flags.exit_with_status)
812 return 0;
814 parse_commit_or_die(commit);
815 oid = get_commit_tree_oid(commit);
817 /* Root commit? */
818 parents = get_saved_parents(opt, commit);
819 if (!parents) {
820 if (opt->show_root_diff) {
821 diff_root_tree_oid(oid, "", &opt->diffopt);
822 log_tree_diff_flush(opt);
824 return !opt->loginfo;
827 /* More than one parent? */
828 if (parents && parents->next) {
829 if (opt->ignore_merges)
830 return 0;
831 else if (opt->combine_merges)
832 return do_diff_combined(opt, commit);
833 else if (opt->first_parent_only) {
835 * Generate merge log entry only for the first
836 * parent, showing summary diff of the others
837 * we merged _in_.
839 parse_commit_or_die(parents->item);
840 diff_tree_oid(get_commit_tree_oid(parents->item),
841 oid, "", &opt->diffopt);
842 log_tree_diff_flush(opt);
843 return !opt->loginfo;
846 /* If we show individual diffs, show the parent info */
847 log->parent = parents->item;
850 showed_log = 0;
851 for (;;) {
852 struct commit *parent = parents->item;
854 parse_commit_or_die(parent);
855 diff_tree_oid(get_commit_tree_oid(parent),
856 oid, "", &opt->diffopt);
857 log_tree_diff_flush(opt);
859 showed_log |= !opt->loginfo;
861 /* Set up the log info for the next parent, if any.. */
862 parents = parents->next;
863 if (!parents)
864 break;
865 log->parent = parents->item;
866 opt->loginfo = log;
868 return showed_log;
871 int log_tree_commit(struct rev_info *opt, struct commit *commit)
873 struct log_info log;
874 int shown, close_file = opt->diffopt.close_file;
876 log.commit = commit;
877 log.parent = NULL;
878 opt->loginfo = &log;
879 opt->diffopt.close_file = 0;
881 if (opt->line_level_traverse)
882 return line_log_print(opt, commit);
884 if (opt->track_linear && !opt->linear && !opt->reverse_output_stage)
885 fprintf(opt->diffopt.file, "\n%s\n", opt->break_bar);
886 shown = log_tree_diff(opt, commit, &log);
887 if (!shown && opt->loginfo && opt->always_show_header) {
888 log.parent = NULL;
889 show_log(opt);
890 shown = 1;
892 if (opt->track_linear && !opt->linear && opt->reverse_output_stage)
893 fprintf(opt->diffopt.file, "\n%s\n", opt->break_bar);
894 opt->loginfo = NULL;
895 maybe_flush_or_die(opt->diffopt.file, "stdout");
896 if (close_file)
897 fclose(opt->diffopt.file);
898 return shown;