7 #include "string-list.h"
9 #include "fmt-merge-msg.h"
10 #include "gpg-interface.h"
12 static const char * const fmt_merge_msg_usage[] = {
13 N_("git fmt-merge-msg [-m <message>] [--log[=<n>]|--no-log] [--file <file>]"),
17 static int use_branch_desc;
19 int fmt_merge_msg_config(const char *key, const char *value, void *cb)
21 if (!strcmp(key, "merge.log") || !strcmp(key, "merge.summary")) {
23 merge_log_config = git_config_bool_or_int(key, value, &is_bool);
24 if (!is_bool && merge_log_config < 0)
25 return error("%s: negative length %s", key, value);
26 if (is_bool && merge_log_config)
27 merge_log_config = DEFAULT_MERGE_LOG_LEN;
28 } else if (!strcmp(key, "merge.branchdesc")) {
29 use_branch_desc = git_config_bool(key, value);
31 return git_default_config(key, value, cb);
36 /* merge data per repository where the merged tips came from */
38 struct string_list branch, tag, r_branch, generic;
43 unsigned char sha1[20];
44 unsigned is_local_branch:1;
47 static void init_src_data(struct src_data *data)
49 data->branch.strdup_strings = 1;
50 data->tag.strdup_strings = 1;
51 data->r_branch.strdup_strings = 1;
52 data->generic.strdup_strings = 1;
55 static struct string_list srcs = STRING_LIST_INIT_DUP;
56 static struct string_list origins = STRING_LIST_INIT_DUP;
58 struct merge_parents {
61 unsigned char given[20];
62 unsigned char commit[20];
68 * I know, I know, this is inefficient, but you won't be pulling and merging
69 * hundreds of heads at a time anyway.
71 static struct merge_parent *find_merge_parent(struct merge_parents *table,
73 unsigned char *commit)
76 for (i = 0; i < table->nr; i++) {
77 if (given && hashcmp(table->item[i].given, given))
79 if (commit && hashcmp(table->item[i].commit, commit))
81 return &table->item[i];
86 static void add_merge_parent(struct merge_parents *table,
88 unsigned char *commit)
90 if (table->nr && find_merge_parent(table, given, commit))
92 ALLOC_GROW(table->item, table->nr + 1, table->alloc);
93 hashcpy(table->item[table->nr].given, given);
94 hashcpy(table->item[table->nr].commit, commit);
95 table->item[table->nr].used = 0;
99 static int handle_line(char *line, struct merge_parents *merge_parents)
101 int i, len = strlen(line);
102 struct origin_data *origin_data;
104 struct src_data *src_data;
105 struct string_list_item *item;
106 int pulling_head = 0;
107 unsigned char sha1[20];
109 if (len < 43 || line[40] != '\t')
112 if (starts_with(line + 41, "not-for-merge"))
115 if (line[41] != '\t')
118 i = get_sha1_hex(line, sha1);
122 if (!find_merge_parent(merge_parents, sha1, NULL))
123 return 0; /* subsumed by other parents */
125 origin_data = xcalloc(1, sizeof(struct origin_data));
126 hashcpy(origin_data->sha1, sha1);
128 if (line[len - 1] == '\n')
133 * At this point, line points at the beginning of comment e.g.
134 * "branch 'frotz' of git://that/repository.git".
135 * Find the repository name and point it with src.
137 src = strstr(line, " of ");
147 item = unsorted_string_list_lookup(&srcs, src);
149 item = string_list_append(&srcs, src);
150 item->util = xcalloc(1, sizeof(struct src_data));
151 init_src_data(item->util);
153 src_data = item->util;
157 src_data->head_status |= 1;
158 } else if (starts_with(line, "branch ")) {
159 origin_data->is_local_branch = 1;
161 string_list_append(&src_data->branch, origin);
162 src_data->head_status |= 2;
163 } else if (starts_with(line, "tag ")) {
165 string_list_append(&src_data->tag, origin + 4);
166 src_data->head_status |= 2;
167 } else if (starts_with(line, "remote-tracking branch ")) {
168 origin = line + strlen("remote-tracking branch ");
169 string_list_append(&src_data->r_branch, origin);
170 src_data->head_status |= 2;
173 string_list_append(&src_data->generic, line);
174 src_data->head_status |= 2;
177 if (!strcmp(".", src) || !strcmp(src, origin)) {
178 int len = strlen(origin);
179 if (origin[0] == '\'' && origin[len - 1] == '\'')
180 origin = xmemdupz(origin + 1, len - 2);
182 char *new_origin = xmalloc(strlen(origin) + strlen(src) + 5);
183 sprintf(new_origin, "%s of %s", origin, src);
186 if (strcmp(".", src))
187 origin_data->is_local_branch = 0;
188 string_list_append(&origins, origin)->util = origin_data;
192 static void print_joined(const char *singular, const char *plural,
193 struct string_list *list, struct strbuf *out)
198 strbuf_addf(out, "%s%s", singular, list->items[0].string);
201 strbuf_addstr(out, plural);
202 for (i = 0; i < list->nr - 1; i++)
203 strbuf_addf(out, "%s%s", i > 0 ? ", " : "",
204 list->items[i].string);
205 strbuf_addf(out, " and %s", list->items[list->nr - 1].string);
209 static void add_branch_desc(struct strbuf *out, const char *name)
211 struct strbuf desc = STRBUF_INIT;
213 if (!read_branch_desc(&desc, name)) {
214 const char *bp = desc.buf;
216 const char *ep = strchrnul(bp, '\n');
219 strbuf_addf(out, " : %.*s", (int)(ep - bp), bp);
222 if (out->buf[out->len - 1] != '\n')
223 strbuf_addch(out, '\n');
225 strbuf_release(&desc);
228 #define util_as_integral(elem) ((intptr_t)((elem)->util))
230 static void record_person_from_buf(int which, struct string_list *people,
233 char *name_buf, *name, *name_end;
234 struct string_list_item *elem;
237 field = (which == 'a') ? "\nauthor " : "\ncommitter ";
238 name = strstr(buffer, field);
241 name += strlen(field);
242 name_end = strchrnul(name, '<');
245 while (isspace(*name_end) && name <= name_end)
249 name_buf = xmemdupz(name, name_end - name + 1);
251 elem = string_list_lookup(people, name_buf);
253 elem = string_list_insert(people, name_buf);
254 elem->util = (void *)0;
256 elem->util = (void*)(util_as_integral(elem) + 1);
261 static void record_person(int which, struct string_list *people,
262 struct commit *commit)
264 const char *buffer = get_commit_buffer(commit);
265 record_person_from_buf(which, people, buffer);
266 unuse_commit_buffer(commit, buffer);
269 static int cmp_string_list_util_as_integral(const void *a_, const void *b_)
271 const struct string_list_item *a = a_, *b = b_;
272 return util_as_integral(b) - util_as_integral(a);
275 static void add_people_count(struct strbuf *out, struct string_list *people)
278 strbuf_addf(out, "%s", people->items[0].string);
279 else if (people->nr == 2)
280 strbuf_addf(out, "%s (%d) and %s (%d)",
281 people->items[0].string,
282 (int)util_as_integral(&people->items[0]),
283 people->items[1].string,
284 (int)util_as_integral(&people->items[1]));
286 strbuf_addf(out, "%s (%d) and others",
287 people->items[0].string,
288 (int)util_as_integral(&people->items[0]));
291 static void credit_people(struct strbuf *out,
292 struct string_list *them,
300 me = git_author_info(IDENT_NO_DATE);
303 me = git_committer_info(IDENT_NO_DATE);
309 (me = skip_prefix(me, them->items->string)) != NULL &&
310 skip_prefix(me, " <")))
312 strbuf_addf(out, "\n%c %s ", comment_line_char, label);
313 add_people_count(out, them);
316 static void add_people_info(struct strbuf *out,
317 struct string_list *authors,
318 struct string_list *committers)
321 qsort(authors->items,
322 authors->nr, sizeof(authors->items[0]),
323 cmp_string_list_util_as_integral);
325 qsort(committers->items,
326 committers->nr, sizeof(committers->items[0]),
327 cmp_string_list_util_as_integral);
329 credit_people(out, authors, 'a');
330 credit_people(out, committers, 'c');
333 static void shortlog(const char *name,
334 struct origin_data *origin_data,
336 struct rev_info *rev,
337 struct fmt_merge_msg_opts *opts,
341 struct commit *commit;
342 struct object *branch;
343 struct string_list subjects = STRING_LIST_INIT_DUP;
344 struct string_list authors = STRING_LIST_INIT_DUP;
345 struct string_list committers = STRING_LIST_INIT_DUP;
346 int flags = UNINTERESTING | TREESAME | SEEN | SHOWN | ADDED;
347 struct strbuf sb = STRBUF_INIT;
348 const unsigned char *sha1 = origin_data->sha1;
349 int limit = opts->shortlog_len;
351 branch = deref_tag(parse_object(sha1), sha1_to_hex(sha1), 40);
352 if (!branch || branch->type != OBJ_COMMIT)
355 setup_revisions(0, NULL, rev, NULL);
356 add_pending_object(rev, branch, name);
357 add_pending_object(rev, &head->object, "^HEAD");
358 head->object.flags |= UNINTERESTING;
359 if (prepare_revision_walk(rev))
360 die("revision walk setup failed");
361 while ((commit = get_revision(rev)) != NULL) {
362 struct pretty_print_context ctx = {0};
364 if (commit->parents && commit->parents->next) {
365 /* do not list a merge but count committer */
366 if (opts->credit_people)
367 record_person('c', &committers, commit);
370 if (!count && opts->credit_people)
371 /* the 'tip' committer */
372 record_person('c', &committers, commit);
373 if (opts->credit_people)
374 record_person('a', &authors, commit);
376 if (subjects.nr > limit)
379 format_commit_message(commit, "%s", &sb, &ctx);
383 string_list_append(&subjects,
384 sha1_to_hex(commit->object.sha1));
386 string_list_append(&subjects, strbuf_detach(&sb, NULL));
389 if (opts->credit_people)
390 add_people_info(out, &authors, &committers);
392 strbuf_addf(out, "\n* %s: (%d commits)\n", name, count);
394 strbuf_addf(out, "\n* %s:\n", name);
396 if (origin_data->is_local_branch && use_branch_desc)
397 add_branch_desc(out, name);
399 for (i = 0; i < subjects.nr; i++)
401 strbuf_addf(out, " ...\n");
403 strbuf_addf(out, " %s\n", subjects.items[i].string);
405 clear_commit_marks((struct commit *)branch, flags);
406 clear_commit_marks(head, flags);
407 free_commit_list(rev->commits);
411 string_list_clear(&authors, 0);
412 string_list_clear(&committers, 0);
413 string_list_clear(&subjects, 0);
416 static void fmt_merge_msg_title(struct strbuf *out,
417 const char *current_branch) {
421 strbuf_addstr(out, "Merge ");
422 for (i = 0; i < srcs.nr; i++) {
423 struct src_data *src_data = srcs.items[i].util;
424 const char *subsep = "";
426 strbuf_addstr(out, sep);
429 if (src_data->head_status == 1) {
430 strbuf_addstr(out, srcs.items[i].string);
433 if (src_data->head_status == 3) {
435 strbuf_addstr(out, "HEAD");
437 if (src_data->branch.nr) {
438 strbuf_addstr(out, subsep);
440 print_joined("branch ", "branches ", &src_data->branch,
443 if (src_data->r_branch.nr) {
444 strbuf_addstr(out, subsep);
446 print_joined("remote-tracking branch ", "remote-tracking branches ",
447 &src_data->r_branch, out);
449 if (src_data->tag.nr) {
450 strbuf_addstr(out, subsep);
452 print_joined("tag ", "tags ", &src_data->tag, out);
454 if (src_data->generic.nr) {
455 strbuf_addstr(out, subsep);
456 print_joined("commit ", "commits ", &src_data->generic,
459 if (strcmp(".", srcs.items[i].string))
460 strbuf_addf(out, " of %s", srcs.items[i].string);
463 if (!strcmp("master", current_branch))
464 strbuf_addch(out, '\n');
466 strbuf_addf(out, " into %s\n", current_branch);
469 static void fmt_tag_signature(struct strbuf *tagbuf,
474 const char *tag_body = strstr(buf, "\n\n");
477 strbuf_add(tagbuf, tag_body, buf + len - tag_body);
479 strbuf_complete_line(tagbuf);
481 strbuf_addch(tagbuf, '\n');
482 strbuf_add_commented_lines(tagbuf, sig->buf, sig->len);
486 static void fmt_merge_msg_sigs(struct strbuf *out)
488 int i, tag_number = 0, first_tag = 0;
489 struct strbuf tagbuf = STRBUF_INIT;
491 for (i = 0; i < origins.nr; i++) {
492 unsigned char *sha1 = origins.items[i].util;
493 enum object_type type;
494 unsigned long size, len;
495 char *buf = read_sha1_file(sha1, &type, &size);
496 struct strbuf sig = STRBUF_INIT;
498 if (!buf || type != OBJ_TAG)
500 len = parse_signature(buf, size);
503 ; /* merely annotated */
504 else if (verify_signed_buffer(buf, len, buf + len, size - len, &sig, NULL)) {
506 strbuf_addstr(&sig, "gpg verification failed.\n");
510 fmt_tag_signature(&tagbuf, &sig, buf, len);
513 if (tag_number == 2) {
514 struct strbuf tagline = STRBUF_INIT;
515 strbuf_addch(&tagline, '\n');
516 strbuf_add_commented_lines(&tagline,
517 origins.items[first_tag].string,
518 strlen(origins.items[first_tag].string));
519 strbuf_insert(&tagbuf, 0, tagline.buf,
521 strbuf_release(&tagline);
523 strbuf_addch(&tagbuf, '\n');
524 strbuf_add_commented_lines(&tagbuf,
525 origins.items[i].string,
526 strlen(origins.items[i].string));
527 fmt_tag_signature(&tagbuf, &sig, buf, len);
529 strbuf_release(&sig);
534 strbuf_addch(out, '\n');
535 strbuf_addbuf(out, &tagbuf);
537 strbuf_release(&tagbuf);
540 static void find_merge_parents(struct merge_parents *result,
541 struct strbuf *in, unsigned char *head)
543 struct commit_list *parents, *next;
544 struct commit *head_commit;
548 while (pos < in->len) {
550 char *p = in->buf + pos;
551 char *newline = strchr(p, '\n');
552 unsigned char sha1[20];
553 struct commit *parent;
556 len = newline ? newline - p : strlen(p);
557 pos += len + !!newline;
560 get_sha1_hex(p, sha1) ||
563 continue; /* skip not-for-merge */
565 * Do not use get_merge_parent() here; we do not have
566 * "name" here and we do not want to contaminate its
569 obj = parse_object(sha1);
570 parent = (struct commit *)peel_to_type(NULL, 0, obj, OBJ_COMMIT);
573 commit_list_insert(parent, &parents);
574 add_merge_parent(result, obj->sha1, parent->object.sha1);
576 head_commit = lookup_commit(head);
578 commit_list_insert(head_commit, &parents);
579 parents = reduce_heads(parents);
582 for (i = 0; i < result->nr; i++)
583 if (!hashcmp(result->item[i].commit,
584 parents->item->object.sha1))
585 result->item[i].used = 1;
586 next = parents->next;
591 for (i = j = 0; i < result->nr; i++) {
592 if (result->item[i].used) {
594 result->item[j] = result->item[i];
601 int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
602 struct fmt_merge_msg_opts *opts)
605 unsigned char head_sha1[20];
606 const char *current_branch;
607 void *current_branch_to_free;
608 struct merge_parents merge_parents;
610 memset(&merge_parents, 0, sizeof(merge_parents));
612 /* get current branch */
613 current_branch = current_branch_to_free =
614 resolve_refdup("HEAD", head_sha1, 1, NULL);
616 die("No current branch");
617 if (starts_with(current_branch, "refs/heads/"))
618 current_branch += 11;
620 find_merge_parents(&merge_parents, in, head_sha1);
623 while (pos < in->len) {
625 char *newline, *p = in->buf + pos;
627 newline = strchr(p, '\n');
628 len = newline ? newline - p : strlen(p);
629 pos += len + !!newline;
632 if (handle_line(p, &merge_parents))
633 die ("Error in line %d: %.*s", i, len, p);
636 if (opts->add_title && srcs.nr)
637 fmt_merge_msg_title(out, current_branch);
640 fmt_merge_msg_sigs(out);
642 if (opts->shortlog_len) {
646 head = lookup_commit_or_die(head_sha1, "HEAD");
647 init_revisions(&rev, NULL);
648 rev.commit_format = CMIT_FMT_ONELINE;
649 rev.ignore_merges = 1;
652 strbuf_complete_line(out);
654 for (i = 0; i < origins.nr; i++)
655 shortlog(origins.items[i].string,
656 origins.items[i].util,
657 head, &rev, opts, out);
660 strbuf_complete_line(out);
661 free(current_branch_to_free);
662 free(merge_parents.item);
666 int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix)
668 const char *inpath = NULL;
669 const char *message = NULL;
670 int shortlog_len = -1;
671 struct option options[] = {
672 { OPTION_INTEGER, 0, "log", &shortlog_len, N_("n"),
673 N_("populate log with at most <n> entries from shortlog"),
674 PARSE_OPT_OPTARG, NULL, DEFAULT_MERGE_LOG_LEN },
675 { OPTION_INTEGER, 0, "summary", &shortlog_len, N_("n"),
676 N_("alias for --log (deprecated)"),
677 PARSE_OPT_OPTARG | PARSE_OPT_HIDDEN, NULL,
678 DEFAULT_MERGE_LOG_LEN },
679 OPT_STRING('m', "message", &message, N_("text"),
680 N_("use <text> as start of message")),
681 OPT_FILENAME('F', "file", &inpath, N_("file to read from")),
686 struct strbuf input = STRBUF_INIT, output = STRBUF_INIT;
688 struct fmt_merge_msg_opts opts;
690 git_config(fmt_merge_msg_config, NULL);
691 argc = parse_options(argc, argv, prefix, options, fmt_merge_msg_usage,
694 usage_with_options(fmt_merge_msg_usage, options);
695 if (shortlog_len < 0)
696 shortlog_len = (merge_log_config > 0) ? merge_log_config : 0;
698 if (inpath && strcmp(inpath, "-")) {
699 in = fopen(inpath, "r");
701 die_errno("cannot open '%s'", inpath);
704 if (strbuf_read(&input, fileno(in), 0) < 0)
705 die_errno("could not read input file");
708 strbuf_addstr(&output, message);
710 memset(&opts, 0, sizeof(opts));
711 opts.add_title = !message;
712 opts.credit_people = 1;
713 opts.shortlog_len = shortlog_len;
715 ret = fmt_merge_msg(&input, &output, &opts);
718 write_in_full(STDOUT_FILENO, output.buf, output.len);