Update git-log and git-show documentation
[git/jnareb-git.git] / log-tree.c
blob85acd66df7506b383db545f61eb330e401239b4e
1 #include "cache.h"
2 #include "diff.h"
3 #include "commit.h"
4 #include "log-tree.h"
5 #include "reflog-walk.h"
7 static void show_parents(struct commit *commit, int abbrev)
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));
17 * Search for "^[-A-Za-z]+: [^@]+@" pattern. It usually matches
18 * Signed-off-by: and Acked-by: lines.
20 static int detect_any_signoff(char *letter, int size)
22 char ch, *cp;
23 int seen_colon = 0;
24 int seen_at = 0;
25 int seen_name = 0;
26 int seen_head = 0;
28 cp = letter + size;
29 while (letter <= --cp && (ch = *cp) == '\n')
30 continue;
32 while (letter <= cp) {
33 ch = *cp--;
34 if (ch == '\n')
35 break;
37 if (!seen_at) {
38 if (ch == '@')
39 seen_at = 1;
40 continue;
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;
51 if (('A' <= ch && ch <= 'Z') ||
52 ('a' <= ch && ch <= 'z') ||
53 ch == '-') {
54 seen_head = 1;
55 continue;
57 /* no empty last line doesn't match */
58 return 0;
60 return seen_head && seen_name;
63 static int append_signoff(char *buf, int buf_sz, int at, const char *signoff)
65 static const char signed_off_by[] = "Signed-off-by: ";
66 int signoff_len = strlen(signoff);
67 int has_signoff = 0;
68 char *cp = buf;
70 /* Do we have enough space to add it? */
71 if (buf_sz - at <= strlen(signed_off_by) + signoff_len + 3)
72 return at;
74 /* First see if we already have the sign-off by the signer */
75 while ((cp = strstr(cp, signed_off_by))) {
77 has_signoff = 1;
79 cp += strlen(signed_off_by);
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;
90 if (!has_signoff)
91 has_signoff = detect_any_signoff(buf, at);
93 if (!has_signoff)
94 buf[at++] = '\n';
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;
105 void show_log(struct rev_info *opt, const char *sep)
107 static char this_header[16384];
108 struct log_info *log = opt->loginfo;
109 struct commit *commit = log->commit, *parent = log->parent;
110 int abbrev = opt->diffopt.abbrev;
111 int abbrev_commit = opt->abbrev_commit ? opt->abbrev : 40;
112 const char *extra;
113 int len;
114 const char *subject = NULL, *extra_headers = opt->extra_headers;
116 opt->loginfo = NULL;
117 if (!opt->verbose_header) {
118 if (opt->left_right) {
119 if (commit->object.flags & BOUNDARY)
120 putchar('-');
121 else if (commit->object.flags & SYMMETRIC_LEFT)
122 putchar('<');
123 else
124 putchar('>');
126 fputs(diff_unique_abbrev(commit->object.sha1, abbrev_commit), stdout);
127 if (opt->parents)
128 show_parents(commit, abbrev_commit);
129 putchar(opt->diffopt.line_termination);
130 return;
134 * The "oneline" format has several special cases:
135 * - The pretty-printed commit lacks a newline at the end
136 * of the buffer, but we do want to make sure that we
137 * have a newline there. If the separator isn't already
138 * a newline, add an extra one.
139 * - unlike other log messages, the one-line format does
140 * not have an empty line between entries.
142 extra = "";
143 if (*sep != '\n' && opt->commit_format == CMIT_FMT_ONELINE)
144 extra = "\n";
145 if (opt->shown_one && opt->commit_format != CMIT_FMT_ONELINE)
146 putchar(opt->diffopt.line_termination);
147 opt->shown_one = 1;
150 * Print header line of header..
153 if (opt->commit_format == CMIT_FMT_EMAIL) {
154 char *sha1 = sha1_to_hex(commit->object.sha1);
155 if (opt->total > 0) {
156 static char buffer[64];
157 snprintf(buffer, sizeof(buffer),
158 "Subject: [PATCH %d/%d] ",
159 opt->nr, opt->total);
160 subject = buffer;
161 } else if (opt->total == 0)
162 subject = "Subject: [PATCH] ";
163 else
164 subject = "Subject: ";
166 printf("From %s Mon Sep 17 00:00:00 2001\n", sha1);
167 if (opt->message_id)
168 printf("Message-Id: <%s>\n", opt->message_id);
169 if (opt->ref_message_id)
170 printf("In-Reply-To: <%s>\nReferences: <%s>\n",
171 opt->ref_message_id, opt->ref_message_id);
172 if (opt->mime_boundary) {
173 static char subject_buffer[1024];
174 static char buffer[1024];
175 snprintf(subject_buffer, sizeof(subject_buffer) - 1,
176 "%s"
177 "MIME-Version: 1.0\n"
178 "Content-Type: multipart/mixed;\n"
179 " boundary=\"%s%s\"\n"
180 "\n"
181 "This is a multi-part message in MIME "
182 "format.\n"
183 "--%s%s\n"
184 "Content-Type: text/plain; "
185 "charset=UTF-8; format=fixed\n"
186 "Content-Transfer-Encoding: 8bit\n\n",
187 extra_headers ? extra_headers : "",
188 mime_boundary_leader, opt->mime_boundary,
189 mime_boundary_leader, opt->mime_boundary);
190 extra_headers = subject_buffer;
192 snprintf(buffer, sizeof(buffer) - 1,
193 "--%s%s\n"
194 "Content-Type: text/x-patch;\n"
195 " name=\"%s.diff\"\n"
196 "Content-Transfer-Encoding: 8bit\n"
197 "Content-Disposition: inline;\n"
198 " filename=\"%s.diff\"\n\n",
199 mime_boundary_leader, opt->mime_boundary,
200 sha1, sha1);
201 opt->diffopt.stat_sep = buffer;
203 } else {
204 fputs(diff_get_color(opt->diffopt.color_diff, DIFF_COMMIT),
205 stdout);
206 if (opt->commit_format != CMIT_FMT_ONELINE)
207 fputs("commit ", stdout);
208 if (opt->left_right) {
209 if (commit->object.flags & BOUNDARY)
210 putchar('-');
211 else if (commit->object.flags & SYMMETRIC_LEFT)
212 putchar('<');
213 else
214 putchar('>');
216 fputs(diff_unique_abbrev(commit->object.sha1, abbrev_commit),
217 stdout);
218 if (opt->parents)
219 show_parents(commit, abbrev_commit);
220 if (parent)
221 printf(" (from %s)",
222 diff_unique_abbrev(parent->object.sha1,
223 abbrev_commit));
224 printf("%s",
225 diff_get_color(opt->diffopt.color_diff, DIFF_RESET));
226 putchar(opt->commit_format == CMIT_FMT_ONELINE ? ' ' : '\n');
227 if (opt->reflog_info) {
228 show_reflog_message(opt->reflog_info,
229 opt->commit_format == CMIT_FMT_ONELINE);;
230 if (opt->commit_format == CMIT_FMT_ONELINE) {
231 printf("%s", sep);
232 return;
238 * And then the pretty-printed message itself
240 len = pretty_print_commit(opt->commit_format, commit, ~0u, this_header,
241 sizeof(this_header), abbrev, subject,
242 extra_headers, opt->relative_date);
244 if (opt->add_signoff)
245 len = append_signoff(this_header, sizeof(this_header), len,
246 opt->add_signoff);
247 printf("%s%s%s", this_header, extra, sep);
250 int log_tree_diff_flush(struct rev_info *opt)
252 diffcore_std(&opt->diffopt);
254 if (diff_queue_is_empty()) {
255 int saved_fmt = opt->diffopt.output_format;
256 opt->diffopt.output_format = DIFF_FORMAT_NO_OUTPUT;
257 diff_flush(&opt->diffopt);
258 opt->diffopt.output_format = saved_fmt;
259 return 0;
262 if (opt->loginfo && !opt->no_commit_id) {
263 /* When showing a verbose header (i.e. log message),
264 * and not in --pretty=oneline format, we would want
265 * an extra newline between the end of log and the
266 * output for readability.
268 show_log(opt, opt->diffopt.msg_sep);
269 if (opt->verbose_header &&
270 opt->commit_format != CMIT_FMT_ONELINE) {
271 int pch = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_PATCH;
272 if ((pch & opt->diffopt.output_format) == pch)
273 printf("---");
274 putchar('\n');
277 diff_flush(&opt->diffopt);
278 return 1;
281 static int do_diff_combined(struct rev_info *opt, struct commit *commit)
283 unsigned const char *sha1 = commit->object.sha1;
285 diff_tree_combined_merge(sha1, opt->dense_combined_merges, opt);
286 return !opt->loginfo;
290 * Show the diff of a commit.
292 * Return true if we printed any log info messages
294 static int log_tree_diff(struct rev_info *opt, struct commit *commit, struct log_info *log)
296 int showed_log;
297 struct commit_list *parents;
298 unsigned const char *sha1 = commit->object.sha1;
300 if (!opt->diff)
301 return 0;
303 /* Root commit? */
304 parents = commit->parents;
305 if (!parents) {
306 if (opt->show_root_diff) {
307 diff_root_tree_sha1(sha1, "", &opt->diffopt);
308 log_tree_diff_flush(opt);
310 return !opt->loginfo;
313 /* More than one parent? */
314 if (parents && parents->next) {
315 if (opt->ignore_merges)
316 return 0;
317 else if (opt->combine_merges)
318 return do_diff_combined(opt, commit);
320 /* If we show individual diffs, show the parent info */
321 log->parent = parents->item;
324 showed_log = 0;
325 for (;;) {
326 struct commit *parent = parents->item;
328 diff_tree_sha1(parent->object.sha1, sha1, "", &opt->diffopt);
329 log_tree_diff_flush(opt);
331 showed_log |= !opt->loginfo;
333 /* Set up the log info for the next parent, if any.. */
334 parents = parents->next;
335 if (!parents)
336 break;
337 log->parent = parents->item;
338 opt->loginfo = log;
340 return showed_log;
343 int log_tree_commit(struct rev_info *opt, struct commit *commit)
345 struct log_info log;
346 int shown;
348 log.commit = commit;
349 log.parent = NULL;
350 opt->loginfo = &log;
352 shown = log_tree_diff(opt, commit, &log);
353 if (!shown && opt->loginfo && opt->always_show_header) {
354 log.parent = NULL;
355 show_log(opt, "");
356 shown = 1;
358 opt->loginfo = NULL;
359 return shown;