Introduce 'git-format-patch --suffix=.patch'
[git.git] / builtin-log.c
blob7397a5af07c1bd1889d5c0bc2959060401f48829
1 /*
2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
5 * 2006 Junio Hamano
6 */
7 #include "cache.h"
8 #include "commit.h"
9 #include "diff.h"
10 #include "revision.h"
11 #include "log-tree.h"
12 #include "builtin.h"
13 #include "tag.h"
15 static int default_show_root = 1;
17 /* this is in builtin-diff.c */
18 void add_head(struct rev_info *revs);
20 static void cmd_log_init(int argc, const char **argv, const char *prefix,
21 struct rev_info *rev)
23 int i;
25 rev->abbrev = DEFAULT_ABBREV;
26 rev->commit_format = CMIT_FMT_DEFAULT;
27 rev->verbose_header = 1;
28 rev->show_root_diff = default_show_root;
29 argc = setup_revisions(argc, argv, rev, "HEAD");
30 if (rev->diffopt.pickaxe || rev->diffopt.filter)
31 rev->always_show_header = 0;
32 for (i = 1; i < argc; i++) {
33 const char *arg = argv[i];
34 if (!strncmp(arg, "--encoding=", 11)) {
35 arg += 11;
36 if (strcmp(arg, "none"))
37 git_log_output_encoding = strdup(arg);
38 else
39 git_log_output_encoding = "";
41 else
42 die("unrecognized argument: %s", arg);
46 static int cmd_log_walk(struct rev_info *rev)
48 struct commit *commit;
50 prepare_revision_walk(rev);
51 while ((commit = get_revision(rev)) != NULL) {
52 log_tree_commit(rev, commit);
53 free(commit->buffer);
54 commit->buffer = NULL;
55 free_commit_list(commit->parents);
56 commit->parents = NULL;
58 return 0;
61 static int git_log_config(const char *var, const char *value)
63 if (!strcmp(var, "log.showroot")) {
64 default_show_root = git_config_bool(var, value);
65 return 0;
67 return git_diff_ui_config(var, value);
70 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
72 struct rev_info rev;
74 git_config(git_log_config);
75 init_revisions(&rev, prefix);
76 rev.diff = 1;
77 rev.diffopt.recursive = 1;
78 rev.simplify_history = 0;
79 cmd_log_init(argc, argv, prefix, &rev);
80 if (!rev.diffopt.output_format)
81 rev.diffopt.output_format = DIFF_FORMAT_RAW;
82 return cmd_log_walk(&rev);
85 static int show_object(const unsigned char *sha1, int suppress_header)
87 unsigned long size;
88 char type[20];
89 char *buf = read_sha1_file(sha1, type, &size);
90 int offset = 0;
92 if (!buf)
93 return error("Could not read object %s", sha1_to_hex(sha1));
95 if (suppress_header)
96 while (offset < size && buf[offset++] != '\n') {
97 int new_offset = offset;
98 while (new_offset < size && buf[new_offset++] != '\n')
99 ; /* do nothing */
100 offset = new_offset;
103 if (offset < size)
104 fwrite(buf + offset, size - offset, 1, stdout);
105 free(buf);
106 return 0;
109 static int show_tree_object(const unsigned char *sha1,
110 const char *base, int baselen,
111 const char *pathname, unsigned mode, int stage)
113 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
114 return 0;
117 int cmd_show(int argc, const char **argv, const char *prefix)
119 struct rev_info rev;
120 struct object_array_entry *objects;
121 int i, count, ret = 0;
123 git_config(git_log_config);
124 init_revisions(&rev, prefix);
125 rev.diff = 1;
126 rev.diffopt.recursive = 1;
127 rev.combine_merges = 1;
128 rev.dense_combined_merges = 1;
129 rev.always_show_header = 1;
130 rev.ignore_merges = 0;
131 rev.no_walk = 1;
132 cmd_log_init(argc, argv, prefix, &rev);
134 count = rev.pending.nr;
135 objects = rev.pending.objects;
136 for (i = 0; i < count && !ret; i++) {
137 struct object *o = objects[i].item;
138 const char *name = objects[i].name;
139 switch (o->type) {
140 case OBJ_BLOB:
141 ret = show_object(o->sha1, 0);
142 break;
143 case OBJ_TAG: {
144 struct tag *t = (struct tag *)o;
146 printf("%stag %s%s\n\n",
147 diff_get_color(rev.diffopt.color_diff,
148 DIFF_COMMIT),
149 t->tag,
150 diff_get_color(rev.diffopt.color_diff,
151 DIFF_RESET));
152 ret = show_object(o->sha1, 1);
153 objects[i].item = (struct object *)t->tagged;
154 i--;
155 break;
157 case OBJ_TREE:
158 printf("%stree %s%s\n\n",
159 diff_get_color(rev.diffopt.color_diff,
160 DIFF_COMMIT),
161 name,
162 diff_get_color(rev.diffopt.color_diff,
163 DIFF_RESET));
164 read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
165 show_tree_object);
166 break;
167 case OBJ_COMMIT:
168 rev.pending.nr = rev.pending.alloc = 0;
169 rev.pending.objects = NULL;
170 add_object_array(o, name, &rev.pending);
171 ret = cmd_log_walk(&rev);
172 break;
173 default:
174 ret = error("Unknown type: %d", o->type);
177 free(objects);
178 return ret;
181 int cmd_log(int argc, const char **argv, const char *prefix)
183 struct rev_info rev;
185 git_config(git_log_config);
186 init_revisions(&rev, prefix);
187 rev.always_show_header = 1;
188 cmd_log_init(argc, argv, prefix, &rev);
189 return cmd_log_walk(&rev);
192 static int istitlechar(char c)
194 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
195 (c >= '0' && c <= '9') || c == '.' || c == '_';
198 static char *extra_headers = NULL;
199 static int extra_headers_size = 0;
200 static const char *fmt_patch_suffix = ".txt";
202 static int git_format_config(const char *var, const char *value)
204 if (!strcmp(var, "format.headers")) {
205 int len = strlen(value);
206 extra_headers_size += len + 1;
207 extra_headers = xrealloc(extra_headers, extra_headers_size);
208 extra_headers[extra_headers_size - len - 1] = 0;
209 strcat(extra_headers, value);
210 return 0;
212 if (!strcmp(var, "format.suffix")) {
213 if (!value)
214 die("format.suffix without value");
215 fmt_patch_suffix = xstrdup(value);
216 return 0;
218 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff")) {
219 return 0;
221 return git_log_config(var, value);
225 static FILE *realstdout = NULL;
226 static const char *output_directory = NULL;
228 static void reopen_stdout(struct commit *commit, int nr, int keep_subject)
230 char filename[1024];
231 char *sol;
232 int len = 0;
233 int suffix_len = strlen(fmt_patch_suffix) + 10; /* ., NUL and slop */
235 if (output_directory) {
236 strlcpy(filename, output_directory, 1000);
237 len = strlen(filename);
238 if (filename[len - 1] != '/')
239 filename[len++] = '/';
242 sprintf(filename + len, "%04d", nr);
243 len = strlen(filename);
245 sol = strstr(commit->buffer, "\n\n");
246 if (sol) {
247 int j, space = 1;
249 sol += 2;
250 /* strip [PATCH] or [PATCH blabla] */
251 if (!keep_subject && !strncmp(sol, "[PATCH", 6)) {
252 char *eos = strchr(sol + 6, ']');
253 if (eos) {
254 while (isspace(*eos))
255 eos++;
256 sol = eos;
260 for (j = 0;
261 len < sizeof(filename) - suffix_len &&
262 sol[j] && sol[j] != '\n';
263 j++) {
264 if (istitlechar(sol[j])) {
265 if (space) {
266 filename[len++] = '-';
267 space = 0;
269 filename[len++] = sol[j];
270 if (sol[j] == '.')
271 while (sol[j + 1] == '.')
272 j++;
273 } else
274 space = 1;
276 while (filename[len - 1] == '.' || filename[len - 1] == '-')
277 len--;
279 strcpy(filename + len, fmt_patch_suffix);
280 fprintf(realstdout, "%s\n", filename);
281 freopen(filename, "w", stdout);
284 static int get_patch_id(struct commit *commit, struct diff_options *options,
285 unsigned char *sha1)
287 if (commit->parents)
288 diff_tree_sha1(commit->parents->item->object.sha1,
289 commit->object.sha1, "", options);
290 else
291 diff_root_tree_sha1(commit->object.sha1, "", options);
292 diffcore_std(options);
293 return diff_flush_patch_id(options, sha1);
296 static void get_patch_ids(struct rev_info *rev, struct diff_options *options, const char *prefix)
298 struct rev_info check_rev;
299 struct commit *commit;
300 struct object *o1, *o2;
301 unsigned flags1, flags2;
302 unsigned char sha1[20];
304 if (rev->pending.nr != 2)
305 die("Need exactly one range.");
307 o1 = rev->pending.objects[0].item;
308 flags1 = o1->flags;
309 o2 = rev->pending.objects[1].item;
310 flags2 = o2->flags;
312 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
313 die("Not a range.");
315 diff_setup(options);
316 options->recursive = 1;
317 if (diff_setup_done(options) < 0)
318 die("diff_setup_done failed");
320 /* given a range a..b get all patch ids for b..a */
321 init_revisions(&check_rev, prefix);
322 o1->flags ^= UNINTERESTING;
323 o2->flags ^= UNINTERESTING;
324 add_pending_object(&check_rev, o1, "o1");
325 add_pending_object(&check_rev, o2, "o2");
326 prepare_revision_walk(&check_rev);
328 while ((commit = get_revision(&check_rev)) != NULL) {
329 /* ignore merges */
330 if (commit->parents && commit->parents->next)
331 continue;
333 if (!get_patch_id(commit, options, sha1))
334 created_object(sha1, xcalloc(1, sizeof(struct object)));
337 /* reset for next revision walk */
338 clear_commit_marks((struct commit *)o1,
339 SEEN | UNINTERESTING | SHOWN | ADDED);
340 clear_commit_marks((struct commit *)o2,
341 SEEN | UNINTERESTING | SHOWN | ADDED);
342 o1->flags = flags1;
343 o2->flags = flags2;
346 static void gen_message_id(char *dest, unsigned int length, char *base)
348 const char *committer = git_committer_info(1);
349 const char *email_start = strrchr(committer, '<');
350 const char *email_end = strrchr(committer, '>');
351 if(!email_start || !email_end || email_start > email_end - 1)
352 die("Could not extract email from committer identity.");
353 snprintf(dest, length, "%s.%lu.git.%.*s", base,
354 (unsigned long) time(NULL),
355 (int)(email_end - email_start - 1), email_start + 1);
358 int cmd_format_patch(int argc, const char **argv, const char *prefix)
360 struct commit *commit;
361 struct commit **list = NULL;
362 struct rev_info rev;
363 int nr = 0, total, i, j;
364 int use_stdout = 0;
365 int numbered = 0;
366 int start_number = -1;
367 int keep_subject = 0;
368 int ignore_if_in_upstream = 0;
369 int thread = 0;
370 const char *in_reply_to = NULL;
371 struct diff_options patch_id_opts;
372 char *add_signoff = NULL;
373 char message_id[1024];
374 char ref_message_id[1024];
376 setup_ident();
377 git_config(git_format_config);
378 init_revisions(&rev, prefix);
379 rev.commit_format = CMIT_FMT_EMAIL;
380 rev.verbose_header = 1;
381 rev.diff = 1;
382 rev.combine_merges = 0;
383 rev.ignore_merges = 1;
384 rev.diffopt.msg_sep = "";
385 rev.diffopt.recursive = 1;
387 rev.extra_headers = extra_headers;
390 * Parse the arguments before setup_revisions(), or something
391 * like "git fmt-patch -o a123 HEAD^.." may fail; a123 is
392 * possibly a valid SHA1.
394 for (i = 1, j = 1; i < argc; i++) {
395 if (!strcmp(argv[i], "--stdout"))
396 use_stdout = 1;
397 else if (!strcmp(argv[i], "-n") ||
398 !strcmp(argv[i], "--numbered"))
399 numbered = 1;
400 else if (!strncmp(argv[i], "--start-number=", 15))
401 start_number = strtol(argv[i] + 15, NULL, 10);
402 else if (!strcmp(argv[i], "--start-number")) {
403 i++;
404 if (i == argc)
405 die("Need a number for --start-number");
406 start_number = strtol(argv[i], NULL, 10);
408 else if (!strcmp(argv[i], "-k") ||
409 !strcmp(argv[i], "--keep-subject")) {
410 keep_subject = 1;
411 rev.total = -1;
413 else if (!strcmp(argv[i], "--output-directory") ||
414 !strcmp(argv[i], "-o")) {
415 i++;
416 if (argc <= i)
417 die("Which directory?");
418 if (output_directory)
419 die("Two output directories?");
420 output_directory = argv[i];
422 else if (!strcmp(argv[i], "--signoff") ||
423 !strcmp(argv[i], "-s")) {
424 const char *committer;
425 const char *endpos;
426 committer = git_committer_info(1);
427 endpos = strchr(committer, '>');
428 if (!endpos)
429 die("bogos committer info %s\n", committer);
430 add_signoff = xmalloc(endpos - committer + 2);
431 memcpy(add_signoff, committer, endpos - committer + 1);
432 add_signoff[endpos - committer + 1] = 0;
434 else if (!strcmp(argv[i], "--attach"))
435 rev.mime_boundary = git_version_string;
436 else if (!strncmp(argv[i], "--attach=", 9))
437 rev.mime_boundary = argv[i] + 9;
438 else if (!strcmp(argv[i], "--ignore-if-in-upstream"))
439 ignore_if_in_upstream = 1;
440 else if (!strcmp(argv[i], "--thread"))
441 thread = 1;
442 else if (!strncmp(argv[i], "--in-reply-to=", 14))
443 in_reply_to = argv[i] + 14;
444 else if (!strcmp(argv[i], "--in-reply-to")) {
445 i++;
446 if (i == argc)
447 die("Need a Message-Id for --in-reply-to");
448 in_reply_to = argv[i];
450 else if (!strncmp(argv[i], "--suffix=", 9))
451 fmt_patch_suffix = argv[i] + 9;
452 else
453 argv[j++] = argv[i];
455 argc = j;
457 if (start_number < 0)
458 start_number = 1;
459 if (numbered && keep_subject)
460 die ("-n and -k are mutually exclusive.");
462 argc = setup_revisions(argc, argv, &rev, "HEAD");
463 if (argc > 1)
464 die ("unrecognized argument: %s", argv[1]);
466 if (!rev.diffopt.output_format)
467 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_PATCH;
469 if (!output_directory)
470 output_directory = prefix;
472 if (output_directory) {
473 if (use_stdout)
474 die("standard output, or directory, which one?");
475 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
476 die("Could not create directory %s",
477 output_directory);
480 if (rev.pending.nr == 1) {
481 rev.pending.objects[0].item->flags |= UNINTERESTING;
482 add_head(&rev);
485 if (ignore_if_in_upstream)
486 get_patch_ids(&rev, &patch_id_opts, prefix);
488 if (!use_stdout)
489 realstdout = fdopen(dup(1), "w");
491 prepare_revision_walk(&rev);
492 while ((commit = get_revision(&rev)) != NULL) {
493 unsigned char sha1[20];
495 /* ignore merges */
496 if (commit->parents && commit->parents->next)
497 continue;
499 if (ignore_if_in_upstream &&
500 !get_patch_id(commit, &patch_id_opts, sha1) &&
501 lookup_object(sha1))
502 continue;
504 nr++;
505 list = xrealloc(list, nr * sizeof(list[0]));
506 list[nr - 1] = commit;
508 total = nr;
509 if (numbered)
510 rev.total = total + start_number - 1;
511 rev.add_signoff = add_signoff;
512 rev.ref_message_id = in_reply_to;
513 while (0 <= --nr) {
514 int shown;
515 commit = list[nr];
516 rev.nr = total - nr + (start_number - 1);
517 /* Make the second and subsequent mails replies to the first */
518 if (thread) {
519 if (nr == (total - 2)) {
520 strncpy(ref_message_id, message_id,
521 sizeof(ref_message_id));
522 ref_message_id[sizeof(ref_message_id)-1]='\0';
523 rev.ref_message_id = ref_message_id;
525 gen_message_id(message_id, sizeof(message_id),
526 sha1_to_hex(commit->object.sha1));
527 rev.message_id = message_id;
529 if (!use_stdout)
530 reopen_stdout(commit, rev.nr, keep_subject);
531 shown = log_tree_commit(&rev, commit);
532 free(commit->buffer);
533 commit->buffer = NULL;
535 /* We put one extra blank line between formatted
536 * patches and this flag is used by log-tree code
537 * to see if it needs to emit a LF before showing
538 * the log; when using one file per patch, we do
539 * not want the extra blank line.
541 if (!use_stdout)
542 rev.shown_one = 0;
543 if (shown) {
544 if (rev.mime_boundary)
545 printf("\n--%s%s--\n\n\n",
546 mime_boundary_leader,
547 rev.mime_boundary);
548 else
549 printf("-- \n%s\n\n", git_version_string);
551 if (!use_stdout)
552 fclose(stdout);
554 free(list);
555 return 0;
558 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
560 unsigned char sha1[20];
561 if (get_sha1(arg, sha1) == 0) {
562 struct commit *commit = lookup_commit_reference(sha1);
563 if (commit) {
564 commit->object.flags |= flags;
565 add_pending_object(revs, &commit->object, arg);
566 return 0;
569 return -1;
572 static const char cherry_usage[] =
573 "git-cherry [-v] <upstream> [<head>] [<limit>]";
574 int cmd_cherry(int argc, const char **argv, const char *prefix)
576 struct rev_info revs;
577 struct diff_options patch_id_opts;
578 struct commit *commit;
579 struct commit_list *list = NULL;
580 const char *upstream;
581 const char *head = "HEAD";
582 const char *limit = NULL;
583 int verbose = 0;
585 if (argc > 1 && !strcmp(argv[1], "-v")) {
586 verbose = 1;
587 argc--;
588 argv++;
591 switch (argc) {
592 case 4:
593 limit = argv[3];
594 /* FALLTHROUGH */
595 case 3:
596 head = argv[2];
597 /* FALLTHROUGH */
598 case 2:
599 upstream = argv[1];
600 break;
601 default:
602 usage(cherry_usage);
605 init_revisions(&revs, prefix);
606 revs.diff = 1;
607 revs.combine_merges = 0;
608 revs.ignore_merges = 1;
609 revs.diffopt.recursive = 1;
611 if (add_pending_commit(head, &revs, 0))
612 die("Unknown commit %s", head);
613 if (add_pending_commit(upstream, &revs, UNINTERESTING))
614 die("Unknown commit %s", upstream);
616 /* Don't say anything if head and upstream are the same. */
617 if (revs.pending.nr == 2) {
618 struct object_array_entry *o = revs.pending.objects;
619 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
620 return 0;
623 get_patch_ids(&revs, &patch_id_opts, prefix);
625 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
626 die("Unknown commit %s", limit);
628 /* reverse the list of commits */
629 prepare_revision_walk(&revs);
630 while ((commit = get_revision(&revs)) != NULL) {
631 /* ignore merges */
632 if (commit->parents && commit->parents->next)
633 continue;
635 commit_list_insert(commit, &list);
638 while (list) {
639 unsigned char sha1[20];
640 char sign = '+';
642 commit = list->item;
643 if (!get_patch_id(commit, &patch_id_opts, sha1) &&
644 lookup_object(sha1))
645 sign = '-';
647 if (verbose) {
648 static char buf[16384];
649 pretty_print_commit(CMIT_FMT_ONELINE, commit, ~0,
650 buf, sizeof(buf), 0, NULL, NULL, 0);
651 printf("%c %s %s\n", sign,
652 sha1_to_hex(commit->object.sha1), buf);
654 else {
655 printf("%c %s\n", sign,
656 sha1_to_hex(commit->object.sha1));
659 list = list->next;
662 return 0;