Code

Document additional options for git-fetch
[git.git] / log-tree.c
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)
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 }
16 /*
17  * Search for "^[-A-Za-z]+: [^@]+@" pattern. It usually matches
18  * Signed-off-by: and Acked-by: lines.
19  */
20 static 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;
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;
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 }
63 static int append_signoff(char *buf, int buf_sz, int at, const char *signoff)
64 {
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;
88         }
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 static unsigned int digits_in_number(unsigned int number)
107         unsigned int i = 10, result = 1;
108         while (i <= number) {
109                 i *= 10;
110                 result++;
111         }
112         return result;
115 void show_log(struct rev_info *opt, const char *sep)
117         static char this_header[16384];
118         struct log_info *log = opt->loginfo;
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;
122         const char *extra;
123         int len;
124         const char *subject = NULL, *extra_headers = opt->extra_headers;
126         opt->loginfo = NULL;
127         if (!opt->verbose_header) {
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                 }
136                 fputs(diff_unique_abbrev(commit->object.sha1, abbrev_commit), stdout);
137                 if (opt->parents)
138                         show_parents(commit, abbrev_commit);
139                 putchar(opt->diffopt.line_termination);
140                 return;
141         }
143         /*
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.
151          */
152         extra = "";
153         if (*sep != '\n' && opt->commit_format == CMIT_FMT_ONELINE)
154                 extra = "\n";
155         if (opt->shown_one && opt->commit_format != CMIT_FMT_ONELINE)
156                 putchar(opt->diffopt.line_termination);
157         opt->shown_one = 1;
159         /*
160          * Print header line of header..
161          */
163         if (opt->commit_format == CMIT_FMT_EMAIL) {
164                 char *sha1 = sha1_to_hex(commit->object.sha1);
165                 if (opt->total > 0) {
166                         static char buffer[64];
167                         snprintf(buffer, sizeof(buffer),
168                                         "Subject: [PATCH %0*d/%d] ",
169                                         digits_in_number(opt->total),
170                                         opt->nr, opt->total);
171                         subject = buffer;
172                 } else if (opt->total == 0)
173                         subject = "Subject: [PATCH] ";
174                 else
175                         subject = "Subject: ";
177                 printf("From %s Mon Sep 17 00:00:00 2001\n", sha1);
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);
183                 if (opt->mime_boundary) {
184                         static char subject_buffer[1024];
185                         static char buffer[1024];
186                         snprintf(subject_buffer, sizeof(subject_buffer) - 1,
187                                  "%s"
188                                  "MIME-Version: 1.0\n"
189                                  "Content-Type: multipart/mixed;"
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",
198                                  extra_headers ? extra_headers : "",
199                                  mime_boundary_leader, opt->mime_boundary,
200                                  mime_boundary_leader, opt->mime_boundary);
201                         extra_headers = subject_buffer;
203                         snprintf(buffer, sizeof(buffer) - 1,
204                                  "--%s%s\n"
205                                  "Content-Type: text/x-patch;"
206                                  " name=\"%s.diff\"\n"
207                                  "Content-Transfer-Encoding: 8bit\n"
208                                  "Content-Disposition: %s;"
209                                  " filename=\"%s.diff\"\n\n",
210                                  mime_boundary_leader, opt->mime_boundary,
211                                  sha1,
212                                  opt->no_inline ? "attachment" : "inline",
213                                  sha1);
214                         opt->diffopt.stat_sep = buffer;
215                 }
216         } else if (opt->commit_format != CMIT_FMT_USERFORMAT) {
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);
231                 if (opt->parents)
232                         show_parents(commit, abbrev_commit);
233                 if (parent)
234                         printf(" (from %s)",
235                                diff_unique_abbrev(parent->object.sha1,
236                                                   abbrev_commit));
237                 printf("%s",
238                        diff_get_color(opt->diffopt.color_diff, DIFF_RESET));
239                 putchar(opt->commit_format == CMIT_FMT_ONELINE ? ' ' : '\n');
240                 if (opt->reflog_info) {
241                         show_reflog_message(opt->reflog_info,
242                                     opt->commit_format == CMIT_FMT_ONELINE,
243                                     opt->relative_date);
244                         if (opt->commit_format == CMIT_FMT_ONELINE) {
245                                 printf("%s", sep);
246                                 return;
247                         }
248                 }
249         }
251         /*
252          * And then the pretty-printed message itself
253          */
254         len = pretty_print_commit(opt->commit_format, commit, ~0u, this_header,
255                                   sizeof(this_header), abbrev, subject,
256                                   extra_headers, opt->relative_date);
258         if (opt->add_signoff)
259                 len = append_signoff(this_header, sizeof(this_header), len,
260                                      opt->add_signoff);
261         printf("%s%s%s", this_header, extra, sep);
264 int log_tree_diff_flush(struct rev_info *opt)
266         diffcore_std(&opt->diffopt);
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         }
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                  */
282                 show_log(opt, opt->diffopt.msg_sep);
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)
287                                 printf("---");
288                         putchar('\n');
289                 }
290         }
291         diff_flush(&opt->diffopt);
292         return 1;
295 static int do_diff_combined(struct rev_info *opt, struct commit *commit)
297         unsigned const char *sha1 = commit->object.sha1;
299         diff_tree_combined_merge(sha1, opt->dense_combined_merges, opt);
300         return !opt->loginfo;
303 /*
304  * Show the diff of a commit.
305  *
306  * Return true if we printed any log info messages
307  */
308 static int log_tree_diff(struct rev_info *opt, struct commit *commit, struct log_info *log)
310         int showed_log;
311         struct commit_list *parents;
312         unsigned const char *sha1 = commit->object.sha1;
314         if (!opt->diff)
315                 return 0;
317         /* Root commit? */
318         parents = commit->parents;
319         if (!parents) {
320                 if (opt->show_root_diff) {
321                         diff_root_tree_sha1(sha1, "", &opt->diffopt);
322                         log_tree_diff_flush(opt);
323                 }
324                 return !opt->loginfo;
325         }
327         /* More than one parent? */
328         if (parents && parents->next) {
329                 if (opt->ignore_merges)
330                         return 0;
331                 else if (opt->combine_merges)
332                         return do_diff_combined(opt, commit);
334                 /* If we show individual diffs, show the parent info */
335                 log->parent = parents->item;
336         }
338         showed_log = 0;
339         for (;;) {
340                 struct commit *parent = parents->item;
342                 diff_tree_sha1(parent->object.sha1, sha1, "", &opt->diffopt);
343                 log_tree_diff_flush(opt);
345                 showed_log |= !opt->loginfo;
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;
357 int log_tree_commit(struct rev_info *opt, struct commit *commit)
359         struct log_info log;
360         int shown;
362         log.commit = commit;
363         log.parent = NULL;
364         opt->loginfo = &log;
366         shown = log_tree_diff(opt, commit, &log);
367         if (!shown && opt->loginfo && opt->always_show_header) {
368                 log.parent = NULL;
369                 show_log(opt, "");
370                 shown = 1;
371         }
372         opt->loginfo = NULL;
373         return shown;