manual: Fix or remove em dashes.
[git/trast.git] / log-tree.c
blob23191543d5324f20622048103a821ded4d13b77a
1 #include "cache.h"
2 #include "diff.h"
3 #include "commit.h"
4 #include "log-tree.h"
5 #include "reflog-walk.h"
7 struct decoration name_decoration = { "object names" };
9 static void show_parents(struct commit *commit, int abbrev)
11 struct commit_list *p;
12 for (p = commit->parents; p ; p = p->next) {
13 struct commit *parent = p->item;
14 printf(" %s", diff_unique_abbrev(parent->object.sha1, abbrev));
18 static void show_decorations(struct commit *commit)
20 const char *prefix;
21 struct name_decoration *decoration;
23 decoration = lookup_decoration(&name_decoration, &commit->object);
24 if (!decoration)
25 return;
26 prefix = " (";
27 while (decoration) {
28 printf("%s%s", prefix, decoration->name);
29 prefix = ", ";
30 decoration = decoration->next;
32 putchar(')');
36 * Search for "^[-A-Za-z]+: [^@]+@" pattern. It usually matches
37 * Signed-off-by: and Acked-by: lines.
39 static int detect_any_signoff(char *letter, int size)
41 char ch, *cp;
42 int seen_colon = 0;
43 int seen_at = 0;
44 int seen_name = 0;
45 int seen_head = 0;
47 cp = letter + size;
48 while (letter <= --cp && (ch = *cp) == '\n')
49 continue;
51 while (letter <= cp) {
52 ch = *cp--;
53 if (ch == '\n')
54 break;
56 if (!seen_at) {
57 if (ch == '@')
58 seen_at = 1;
59 continue;
61 if (!seen_colon) {
62 if (ch == '@')
63 return 0;
64 else if (ch == ':')
65 seen_colon = 1;
66 else
67 seen_name = 1;
68 continue;
70 if (('A' <= ch && ch <= 'Z') ||
71 ('a' <= ch && ch <= 'z') ||
72 ch == '-') {
73 seen_head = 1;
74 continue;
76 /* no empty last line doesn't match */
77 return 0;
79 return seen_head && seen_name;
82 static void append_signoff(struct strbuf *sb, const char *signoff)
84 static const char signed_off_by[] = "Signed-off-by: ";
85 size_t signoff_len = strlen(signoff);
86 int has_signoff = 0;
87 char *cp;
89 cp = sb->buf;
91 /* First see if we already have the sign-off by the signer */
92 while ((cp = strstr(cp, signed_off_by))) {
94 has_signoff = 1;
96 cp += strlen(signed_off_by);
97 if (cp + signoff_len >= sb->buf + sb->len)
98 break;
99 if (strncmp(cp, signoff, signoff_len))
100 continue;
101 if (!isspace(cp[signoff_len]))
102 continue;
103 /* we already have him */
104 return;
107 if (!has_signoff)
108 has_signoff = detect_any_signoff(sb->buf, sb->len);
110 if (!has_signoff)
111 strbuf_addch(sb, '\n');
113 strbuf_addstr(sb, signed_off_by);
114 strbuf_add(sb, signoff, signoff_len);
115 strbuf_addch(sb, '\n');
118 static unsigned int digits_in_number(unsigned int number)
120 unsigned int i = 10, result = 1;
121 while (i <= number) {
122 i *= 10;
123 result++;
125 return result;
128 void show_log(struct rev_info *opt, const char *sep)
130 struct strbuf msgbuf;
131 struct log_info *log = opt->loginfo;
132 struct commit *commit = log->commit, *parent = log->parent;
133 int abbrev = opt->diffopt.abbrev;
134 int abbrev_commit = opt->abbrev_commit ? opt->abbrev : 40;
135 const char *extra;
136 const char *subject = NULL, *extra_headers = opt->extra_headers;
138 opt->loginfo = NULL;
139 if (!opt->verbose_header) {
140 if (opt->left_right) {
141 if (commit->object.flags & BOUNDARY)
142 putchar('-');
143 else if (commit->object.flags & SYMMETRIC_LEFT)
144 putchar('<');
145 else
146 putchar('>');
148 fputs(diff_unique_abbrev(commit->object.sha1, abbrev_commit), stdout);
149 if (opt->parents)
150 show_parents(commit, abbrev_commit);
151 show_decorations(commit);
152 putchar(opt->diffopt.line_termination);
153 return;
157 * The "oneline" format has several special cases:
158 * - The pretty-printed commit lacks a newline at the end
159 * of the buffer, but we do want to make sure that we
160 * have a newline there. If the separator isn't already
161 * a newline, add an extra one.
162 * - unlike other log messages, the one-line format does
163 * not have an empty line between entries.
165 extra = "";
166 if (*sep != '\n' && opt->commit_format == CMIT_FMT_ONELINE)
167 extra = "\n";
168 if (opt->shown_one && opt->commit_format != CMIT_FMT_ONELINE)
169 putchar(opt->diffopt.line_termination);
170 opt->shown_one = 1;
173 * Print header line of header..
176 if (opt->commit_format == CMIT_FMT_EMAIL) {
177 char *sha1 = sha1_to_hex(commit->object.sha1);
178 if (opt->total > 0) {
179 static char buffer[64];
180 snprintf(buffer, sizeof(buffer),
181 "Subject: [%s %0*d/%d] ",
182 opt->subject_prefix,
183 digits_in_number(opt->total),
184 opt->nr, opt->total);
185 subject = buffer;
186 } else if (opt->total == 0 && opt->subject_prefix && *opt->subject_prefix) {
187 static char buffer[256];
188 snprintf(buffer, sizeof(buffer),
189 "Subject: [%s] ",
190 opt->subject_prefix);
191 subject = buffer;
192 } else {
193 subject = "Subject: ";
196 printf("From %s Mon Sep 17 00:00:00 2001\n", sha1);
197 if (opt->message_id)
198 printf("Message-Id: <%s>\n", opt->message_id);
199 if (opt->ref_message_id)
200 printf("In-Reply-To: <%s>\nReferences: <%s>\n",
201 opt->ref_message_id, opt->ref_message_id);
202 if (opt->mime_boundary) {
203 static char subject_buffer[1024];
204 static char buffer[1024];
205 snprintf(subject_buffer, sizeof(subject_buffer) - 1,
206 "%s"
207 "MIME-Version: 1.0\n"
208 "Content-Type: multipart/mixed;"
209 " boundary=\"%s%s\"\n"
210 "\n"
211 "This is a multi-part message in MIME "
212 "format.\n"
213 "--%s%s\n"
214 "Content-Type: text/plain; "
215 "charset=UTF-8; format=fixed\n"
216 "Content-Transfer-Encoding: 8bit\n\n",
217 extra_headers ? extra_headers : "",
218 mime_boundary_leader, opt->mime_boundary,
219 mime_boundary_leader, opt->mime_boundary);
220 extra_headers = subject_buffer;
222 snprintf(buffer, sizeof(buffer) - 1,
223 "--%s%s\n"
224 "Content-Type: text/x-patch;"
225 " name=\"%s.diff\"\n"
226 "Content-Transfer-Encoding: 8bit\n"
227 "Content-Disposition: %s;"
228 " filename=\"%s.diff\"\n\n",
229 mime_boundary_leader, opt->mime_boundary,
230 sha1,
231 opt->no_inline ? "attachment" : "inline",
232 sha1);
233 opt->diffopt.stat_sep = buffer;
235 } else if (opt->commit_format != CMIT_FMT_USERFORMAT) {
236 fputs(diff_get_color(opt->diffopt.color_diff, DIFF_COMMIT),
237 stdout);
238 if (opt->commit_format != CMIT_FMT_ONELINE)
239 fputs("commit ", stdout);
240 if (commit->object.flags & BOUNDARY)
241 putchar('-');
242 else if (opt->left_right) {
243 if (commit->object.flags & SYMMETRIC_LEFT)
244 putchar('<');
245 else
246 putchar('>');
248 fputs(diff_unique_abbrev(commit->object.sha1, abbrev_commit),
249 stdout);
250 if (opt->parents)
251 show_parents(commit, abbrev_commit);
252 if (parent)
253 printf(" (from %s)",
254 diff_unique_abbrev(parent->object.sha1,
255 abbrev_commit));
256 show_decorations(commit);
257 printf("%s",
258 diff_get_color(opt->diffopt.color_diff, DIFF_RESET));
259 putchar(opt->commit_format == CMIT_FMT_ONELINE ? ' ' : '\n');
260 if (opt->reflog_info) {
261 show_reflog_message(opt->reflog_info,
262 opt->commit_format == CMIT_FMT_ONELINE,
263 opt->date_mode);
264 if (opt->commit_format == CMIT_FMT_ONELINE) {
265 printf("%s", sep);
266 return;
272 * And then the pretty-printed message itself
274 strbuf_init(&msgbuf, 0);
275 pretty_print_commit(opt->commit_format, commit, &msgbuf,
276 abbrev, subject, extra_headers, opt->date_mode);
278 if (opt->add_signoff)
279 append_signoff(&msgbuf, opt->add_signoff);
280 if (opt->show_log_size)
281 printf("log size %i\n", (int)msgbuf.len);
283 if (msgbuf.len)
284 printf("%s%s%s", msgbuf.buf, extra, sep);
285 strbuf_release(&msgbuf);
288 int log_tree_diff_flush(struct rev_info *opt)
290 diffcore_std(&opt->diffopt);
292 if (diff_queue_is_empty()) {
293 int saved_fmt = opt->diffopt.output_format;
294 opt->diffopt.output_format = DIFF_FORMAT_NO_OUTPUT;
295 diff_flush(&opt->diffopt);
296 opt->diffopt.output_format = saved_fmt;
297 return 0;
300 if (opt->loginfo && !opt->no_commit_id) {
301 /* When showing a verbose header (i.e. log message),
302 * and not in --pretty=oneline format, we would want
303 * an extra newline between the end of log and the
304 * output for readability.
306 show_log(opt, opt->diffopt.msg_sep);
307 if (opt->verbose_header &&
308 opt->commit_format != CMIT_FMT_ONELINE) {
309 int pch = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_PATCH;
310 if ((pch & opt->diffopt.output_format) == pch)
311 printf("---");
312 putchar('\n');
315 diff_flush(&opt->diffopt);
316 return 1;
319 static int do_diff_combined(struct rev_info *opt, struct commit *commit)
321 unsigned const char *sha1 = commit->object.sha1;
323 diff_tree_combined_merge(sha1, opt->dense_combined_merges, opt);
324 return !opt->loginfo;
328 * Show the diff of a commit.
330 * Return true if we printed any log info messages
332 static int log_tree_diff(struct rev_info *opt, struct commit *commit, struct log_info *log)
334 int showed_log;
335 struct commit_list *parents;
336 unsigned const char *sha1 = commit->object.sha1;
338 if (!opt->diff)
339 return 0;
341 /* Root commit? */
342 parents = commit->parents;
343 if (!parents) {
344 if (opt->show_root_diff) {
345 diff_root_tree_sha1(sha1, "", &opt->diffopt);
346 log_tree_diff_flush(opt);
348 return !opt->loginfo;
351 /* More than one parent? */
352 if (parents && parents->next) {
353 if (opt->ignore_merges)
354 return 0;
355 else if (opt->combine_merges)
356 return do_diff_combined(opt, commit);
358 /* If we show individual diffs, show the parent info */
359 log->parent = parents->item;
362 showed_log = 0;
363 for (;;) {
364 struct commit *parent = parents->item;
366 diff_tree_sha1(parent->object.sha1, sha1, "", &opt->diffopt);
367 log_tree_diff_flush(opt);
369 showed_log |= !opt->loginfo;
371 /* Set up the log info for the next parent, if any.. */
372 parents = parents->next;
373 if (!parents)
374 break;
375 log->parent = parents->item;
376 opt->loginfo = log;
378 return showed_log;
381 int log_tree_commit(struct rev_info *opt, struct commit *commit)
383 struct log_info log;
384 int shown;
386 log.commit = commit;
387 log.parent = NULL;
388 opt->loginfo = &log;
390 shown = log_tree_diff(opt, commit, &log);
391 if (!shown && opt->loginfo && opt->always_show_header) {
392 log.parent = NULL;
393 show_log(opt, "");
394 shown = 1;
396 opt->loginfo = NULL;
397 maybe_flush_or_die(stdout, "stdout");
398 return shown;