diff format documentation: describe raw combined diff format
[git/git.git] / log-tree.c
CommitLineData
5f1c3f07
JH
1#include "cache.h"
2#include "diff.h"
3#include "commit.h"
4#include "log-tree.h"
8860fd42 5#include "reflog-walk.h"
5f1c3f07 6
c8c893c6
LT
7static void show_parents(struct commit *commit, int abbrev)
8{
9 struct commit_list *p;
10 for (p = commit->parents; p ; p = p->next) {
11 struct commit *parent = p->item;
12 printf(" %s", diff_unique_abbrev(parent->object.sha1, abbrev));
13 }
14}
15
fc1c75ec
FBH
16/*
17 * Search for "^[-A-Za-z]+: [^@]+@" pattern. It usually matches
18 * Signed-off-by: and Acked-by: lines.
19 */
20static int detect_any_signoff(char *letter, int size)
21{
22 char ch, *cp;
23 int seen_colon = 0;
24 int seen_at = 0;
25 int seen_name = 0;
26 int seen_head = 0;
27
28 cp = letter + size;
29 while (letter <= --cp && (ch = *cp) == '\n')
30 continue;
31
32 while (letter <= cp) {
33 ch = *cp--;
34 if (ch == '\n')
35 break;
36
37 if (!seen_at) {
38 if (ch == '@')
39 seen_at = 1;
40 continue;
41 }
42 if (!seen_colon) {
43 if (ch == '@')
44 return 0;
45 else if (ch == ':')
46 seen_colon = 1;
47 else
48 seen_name = 1;
49 continue;
50 }
51 if (('A' <= ch && ch <= 'Z') ||
52 ('a' <= ch && ch <= 'z') ||
53 ch == '-') {
54 seen_head = 1;
55 continue;
56 }
57 /* no empty last line doesn't match */
58 return 0;
59 }
60 return seen_head && seen_name;
61}
62
cf2251b6
JH
63static int append_signoff(char *buf, int buf_sz, int at, const char *signoff)
64{
cf2251b6 65 static const char signed_off_by[] = "Signed-off-by: ";
fc1c75ec
FBH
66 int signoff_len = strlen(signoff);
67 int has_signoff = 0;
cf2251b6
JH
68 char *cp = buf;
69
70 /* Do we have enough space to add it? */
c35f4c37 71 if (buf_sz - at <= strlen(signed_off_by) + signoff_len + 3)
cf2251b6
JH
72 return at;
73
74 /* First see if we already have the sign-off by the signer */
fc1c75ec
FBH
75 while ((cp = strstr(cp, signed_off_by))) {
76
77 has_signoff = 1;
78
cf2251b6 79 cp += strlen(signed_off_by);
fc1c75ec
FBH
80 if (cp + signoff_len >= buf + at)
81 break;
82 if (strncmp(cp, signoff, signoff_len))
83 continue;
84 if (!isspace(cp[signoff_len]))
85 continue;
86 /* we already have him */
87 return at;
cf2251b6
JH
88 }
89
fc1c75ec
FBH
90 if (!has_signoff)
91 has_signoff = detect_any_signoff(buf, at);
92
93 if (!has_signoff)
94 buf[at++] = '\n';
c35f4c37 95
cf2251b6
JH
96 strcpy(buf + at, signed_off_by);
97 at += strlen(signed_off_by);
98 strcpy(buf + at, signoff);
99 at += signoff_len;
100 buf[at++] = '\n';
101 buf[at] = 0;
102 return at;
103}
104
e00de24b
JS
105static unsigned int digits_in_number(unsigned int number)
106{
107 unsigned int i = 10, result = 1;
108 while (i <= number) {
109 i *= 10;
110 result++;
111 }
112 return result;
113}
114
39bc9a6c 115void show_log(struct rev_info *opt, const char *sep)
91539833
LT
116{
117 static char this_header[16384];
39bc9a6c 118 struct log_info *log = opt->loginfo;
91539833
LT
119 struct commit *commit = log->commit, *parent = log->parent;
120 int abbrev = opt->diffopt.abbrev;
121 int abbrev_commit = opt->abbrev_commit ? opt->abbrev : 40;
a4d34e2d 122 const char *extra;
91539833 123 int len;
20ff0680 124 const char *subject = NULL, *extra_headers = opt->extra_headers;
91539833
LT
125
126 opt->loginfo = NULL;
127 if (!opt->verbose_header) {
74bd9029
JH
128 if (opt->left_right) {
129 if (commit->object.flags & BOUNDARY)
130 putchar('-');
131 else if (commit->object.flags & SYMMETRIC_LEFT)
132 putchar('<');
133 else
134 putchar('>');
135 }
c8c893c6
LT
136 fputs(diff_unique_abbrev(commit->object.sha1, abbrev_commit), stdout);
137 if (opt->parents)
138 show_parents(commit, abbrev_commit);
1dcb6922 139 putchar(opt->diffopt.line_termination);
91539833
LT
140 return;
141 }
142
143 /*
a4d34e2d
LT
144 * The "oneline" format has several special cases:
145 * - The pretty-printed commit lacks a newline at the end
146 * of the buffer, but we do want to make sure that we
147 * have a newline there. If the separator isn't already
148 * a newline, add an extra one.
149 * - unlike other log messages, the one-line format does
150 * not have an empty line between entries.
91539833 151 */
a4d34e2d
LT
152 extra = "";
153 if (*sep != '\n' && opt->commit_format == CMIT_FMT_ONELINE)
154 extra = "\n";
91539833 155 if (opt->shown_one && opt->commit_format != CMIT_FMT_ONELINE)
abd4e222 156 putchar(opt->diffopt.line_termination);
91539833
LT
157 opt->shown_one = 1;
158
159 /*
160 * Print header line of header..
161 */
3eefc189 162
596524b3 163 if (opt->commit_format == CMIT_FMT_EMAIL) {
698ce6f8 164 char *sha1 = sha1_to_hex(commit->object.sha1);
596524b3
JS
165 if (opt->total > 0) {
166 static char buffer[64];
167 snprintf(buffer, sizeof(buffer),
e00de24b
JS
168 "Subject: [PATCH %0*d/%d] ",
169 digits_in_number(opt->total),
596524b3
JS
170 opt->nr, opt->total);
171 subject = buffer;
8ac80a57 172 } else if (opt->total == 0)
596524b3 173 subject = "Subject: [PATCH] ";
8ac80a57
JS
174 else
175 subject = "Subject: ";
176
698ce6f8 177 printf("From %s Mon Sep 17 00:00:00 2001\n", sha1);
d1566f78
JT
178 if (opt->message_id)
179 printf("Message-Id: <%s>\n", opt->message_id);
180 if (opt->ref_message_id)
181 printf("In-Reply-To: <%s>\nReferences: <%s>\n",
182 opt->ref_message_id, opt->ref_message_id);
698ce6f8
JS
183 if (opt->mime_boundary) {
184 static char subject_buffer[1024];
185 static char buffer[1024];
186 snprintf(subject_buffer, sizeof(subject_buffer) - 1,
20ff0680 187 "%s"
698ce6f8 188 "MIME-Version: 1.0\n"
33ee4cfb 189 "Content-Type: multipart/mixed;"
698ce6f8
JS
190 " boundary=\"%s%s\"\n"
191 "\n"
192 "This is a multi-part message in MIME "
193 "format.\n"
194 "--%s%s\n"
195 "Content-Type: text/plain; "
196 "charset=UTF-8; format=fixed\n"
197 "Content-Transfer-Encoding: 8bit\n\n",
20ff0680 198 extra_headers ? extra_headers : "",
698ce6f8
JS
199 mime_boundary_leader, opt->mime_boundary,
200 mime_boundary_leader, opt->mime_boundary);
20ff0680 201 extra_headers = subject_buffer;
698ce6f8
JS
202
203 snprintf(buffer, sizeof(buffer) - 1,
204 "--%s%s\n"
33ee4cfb 205 "Content-Type: text/x-patch;"
698ce6f8
JS
206 " name=\"%s.diff\"\n"
207 "Content-Transfer-Encoding: 8bit\n"
33ee4cfb 208 "Content-Disposition: %s;"
698ce6f8
JS
209 " filename=\"%s.diff\"\n\n",
210 mime_boundary_leader, opt->mime_boundary,
c112f689
JS
211 sha1,
212 opt->no_inline ? "attachment" : "inline",
213 sha1);
698ce6f8
JS
214 opt->diffopt.stat_sep = buffer;
215 }
e52a5de4 216 } else if (opt->commit_format != CMIT_FMT_USERFORMAT) {
74bd9029
JH
217 fputs(diff_get_color(opt->diffopt.color_diff, DIFF_COMMIT),
218 stdout);
219 if (opt->commit_format != CMIT_FMT_ONELINE)
220 fputs("commit ", stdout);
221 if (opt->left_right) {
222 if (commit->object.flags & BOUNDARY)
223 putchar('-');
224 else if (commit->object.flags & SYMMETRIC_LEFT)
225 putchar('<');
226 else
227 putchar('>');
228 }
229 fputs(diff_unique_abbrev(commit->object.sha1, abbrev_commit),
230 stdout);
c66b6c06
JH
231 if (opt->parents)
232 show_parents(commit, abbrev_commit);
73f0a157 233 if (parent)
3eefc189
JH
234 printf(" (from %s)",
235 diff_unique_abbrev(parent->object.sha1,
236 abbrev_commit));
ce436973
JK
237 printf("%s",
238 diff_get_color(opt->diffopt.color_diff, DIFF_RESET));
e557667e 239 putchar(opt->commit_format == CMIT_FMT_ONELINE ? ' ' : '\n');
903b45fe 240 if (opt->reflog_info) {
4d12a471 241 show_reflog_message(opt->reflog_info,
4e244cbc
JS
242 opt->commit_format == CMIT_FMT_ONELINE,
243 opt->relative_date);
903b45fe
NP
244 if (opt->commit_format == CMIT_FMT_ONELINE) {
245 printf("%s", sep);
246 return;
247 }
248 }
3eefc189 249 }
91539833
LT
250
251 /*
252 * And then the pretty-printed message itself
253 */
3dfb9278
JF
254 len = pretty_print_commit(opt->commit_format, commit, ~0u, this_header,
255 sizeof(this_header), abbrev, subject,
256 extra_headers, opt->relative_date);
cf2251b6
JH
257
258 if (opt->add_signoff)
259 len = append_signoff(this_header, sizeof(this_header), len,
260 opt->add_signoff);
a4d34e2d 261 printf("%s%s%s", this_header, extra, sep);
91539833
LT
262}
263
cd2bdc53 264int log_tree_diff_flush(struct rev_info *opt)
5f1c3f07
JH
265{
266 diffcore_std(&opt->diffopt);
91539833 267
5f1c3f07
JH
268 if (diff_queue_is_empty()) {
269 int saved_fmt = opt->diffopt.output_format;
270 opt->diffopt.output_format = DIFF_FORMAT_NO_OUTPUT;
271 diff_flush(&opt->diffopt);
272 opt->diffopt.output_format = saved_fmt;
273 return 0;
274 }
91539833 275
3969cf7d
JH
276 if (opt->loginfo && !opt->no_commit_id) {
277 /* When showing a verbose header (i.e. log message),
278 * and not in --pretty=oneline format, we would want
279 * an extra newline between the end of log and the
280 * output for readability.
281 */
39bc9a6c 282 show_log(opt, opt->diffopt.msg_sep);
3969cf7d
JH
283 if (opt->verbose_header &&
284 opt->commit_format != CMIT_FMT_ONELINE) {
285 int pch = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_PATCH;
286 if ((pch & opt->diffopt.output_format) == pch)
abd4e222
LT
287 printf("---");
288 putchar('\n');
3969cf7d
JH
289 }
290 }
5f1c3f07
JH
291 diff_flush(&opt->diffopt);
292 return 1;
293}
294
cd2bdc53 295static int do_diff_combined(struct rev_info *opt, struct commit *commit)
5f1c3f07
JH
296{
297 unsigned const char *sha1 = commit->object.sha1;
298
91539833
LT
299 diff_tree_combined_merge(sha1, opt->dense_combined_merges, opt);
300 return !opt->loginfo;
5f1c3f07
JH
301}
302
91539833
LT
303/*
304 * Show the diff of a commit.
305 *
306 * Return true if we printed any log info messages
307 */
308static int log_tree_diff(struct rev_info *opt, struct commit *commit, struct log_info *log)
5f1c3f07 309{
91539833 310 int showed_log;
5f1c3f07
JH
311 struct commit_list *parents;
312 unsigned const char *sha1 = commit->object.sha1;
313
91539833
LT
314 if (!opt->diff)
315 return 0;
316
5f1c3f07 317 /* Root commit? */
91539833
LT
318 parents = commit->parents;
319 if (!parents) {
2b60356d
RS
320 if (opt->show_root_diff) {
321 diff_root_tree_sha1(sha1, "", &opt->diffopt);
322 log_tree_diff_flush(opt);
323 }
91539833 324 return !opt->loginfo;
5f1c3f07
JH
325 }
326
327 /* More than one parent? */
91539833 328 if (parents && parents->next) {
5f1c3f07
JH
329 if (opt->ignore_merges)
330 return 0;
331 else if (opt->combine_merges)
332 return do_diff_combined(opt, commit);
91539833
LT
333
334 /* If we show individual diffs, show the parent info */
335 log->parent = parents->item;
5f1c3f07
JH
336 }
337
91539833
LT
338 showed_log = 0;
339 for (;;) {
5f1c3f07 340 struct commit *parent = parents->item;
5f1c3f07 341
91539833
LT
342 diff_tree_sha1(parent->object.sha1, sha1, "", &opt->diffopt);
343 log_tree_diff_flush(opt);
344
345 showed_log |= !opt->loginfo;
346
347 /* Set up the log info for the next parent, if any.. */
348 parents = parents->next;
349 if (!parents)
350 break;
351 log->parent = parents->item;
352 opt->loginfo = log;
353 }
354 return showed_log;
355}
356
357int log_tree_commit(struct rev_info *opt, struct commit *commit)
358{
359 struct log_info log;
3eefc189 360 int shown;
91539833
LT
361
362 log.commit = commit;
363 log.parent = NULL;
364 opt->loginfo = &log;
365
3eefc189
JH
366 shown = log_tree_diff(opt, commit, &log);
367 if (!shown && opt->loginfo && opt->always_show_header) {
91539833 368 log.parent = NULL;
39bc9a6c 369 show_log(opt, "");
3eefc189 370 shown = 1;
5f1c3f07 371 }
91539833 372 opt->loginfo = NULL;
3eefc189 373 return shown;
5f1c3f07 374}