5 #include "object-store.h"
10 #include "string-list.h"
12 #include "fmt-merge-msg.h"
13 #include "gpg-interface.h"
15 static const char * const fmt_merge_msg_usage[] = {
16 N_("git fmt-merge-msg [-m <message>] [--log[=<n>] | --no-log] [--file <file>]"),
20 static int use_branch_desc;
22 int fmt_merge_msg_config(const char *key, const char *value, void *cb)
24 if (!strcmp(key, "merge.log") || !strcmp(key, "merge.summary")) {
26 merge_log_config = git_config_bool_or_int(key, value, &is_bool);
27 if (!is_bool && merge_log_config < 0)
28 return error("%s: negative length %s", key, value);
29 if (is_bool && merge_log_config)
30 merge_log_config = DEFAULT_MERGE_LOG_LEN;
31 } else if (!strcmp(key, "merge.branchdesc")) {
32 use_branch_desc = git_config_bool(key, value);
34 return git_default_config(key, value, cb);
39 /* merge data per repository where the merged tips came from */
41 struct string_list branch, tag, r_branch, generic;
47 unsigned is_local_branch:1;
50 static void init_src_data(struct src_data *data)
52 data->branch.strdup_strings = 1;
53 data->tag.strdup_strings = 1;
54 data->r_branch.strdup_strings = 1;
55 data->generic.strdup_strings = 1;
58 static struct string_list srcs = STRING_LIST_INIT_DUP;
59 static struct string_list origins = STRING_LIST_INIT_DUP;
61 struct merge_parents {
64 struct object_id given;
65 struct object_id commit;
71 * I know, I know, this is inefficient, but you won't be pulling and merging
72 * hundreds of heads at a time anyway.
74 static struct merge_parent *find_merge_parent(struct merge_parents *table,
75 struct object_id *given,
76 struct object_id *commit)
79 for (i = 0; i < table->nr; i++) {
80 if (given && oidcmp(&table->item[i].given, given))
82 if (commit && oidcmp(&table->item[i].commit, commit))
84 return &table->item[i];
89 static void add_merge_parent(struct merge_parents *table,
90 struct object_id *given,
91 struct object_id *commit)
93 if (table->nr && find_merge_parent(table, given, commit))
95 ALLOC_GROW(table->item, table->nr + 1, table->alloc);
96 oidcpy(&table->item[table->nr].given, given);
97 oidcpy(&table->item[table->nr].commit, commit);
98 table->item[table->nr].used = 0;
102 static int handle_line(char *line, struct merge_parents *merge_parents)
104 int i, len = strlen(line);
105 struct origin_data *origin_data;
108 struct src_data *src_data;
109 struct string_list_item *item;
110 int pulling_head = 0;
111 struct object_id oid;
112 const unsigned hexsz = the_hash_algo->hexsz;
114 if (len < hexsz + 3 || line[hexsz] != '\t')
117 if (starts_with(line + hexsz + 1, "not-for-merge"))
120 if (line[hexsz + 1] != '\t')
123 i = get_oid_hex(line, &oid);
127 if (!find_merge_parent(merge_parents, &oid, NULL))
128 return 0; /* subsumed by other parents */
130 origin_data = xcalloc(1, sizeof(struct origin_data));
131 oidcpy(&origin_data->oid, &oid);
133 if (line[len - 1] == '\n')
138 * At this point, line points at the beginning of comment e.g.
139 * "branch 'frotz' of git://that/repository.git".
140 * Find the repository name and point it with src.
142 src = strstr(line, " of ");
152 item = unsorted_string_list_lookup(&srcs, src);
154 item = string_list_append(&srcs, src);
155 item->util = xcalloc(1, sizeof(struct src_data));
156 init_src_data(item->util);
158 src_data = item->util;
162 src_data->head_status |= 1;
163 } else if (starts_with(line, "branch ")) {
164 origin_data->is_local_branch = 1;
166 string_list_append(&src_data->branch, origin);
167 src_data->head_status |= 2;
168 } else if (starts_with(line, "tag ")) {
170 string_list_append(&src_data->tag, origin + 4);
171 src_data->head_status |= 2;
172 } else if (skip_prefix(line, "remote-tracking branch ", &origin)) {
173 string_list_append(&src_data->r_branch, origin);
174 src_data->head_status |= 2;
177 string_list_append(&src_data->generic, line);
178 src_data->head_status |= 2;
181 if (!strcmp(".", src) || !strcmp(src, origin)) {
182 int len = strlen(origin);
183 if (origin[0] == '\'' && origin[len - 1] == '\'')
184 origin = xmemdupz(origin + 1, len - 2);
186 origin = xstrfmt("%s of %s", origin, src);
187 if (strcmp(".", src))
188 origin_data->is_local_branch = 0;
189 string_list_append(&origins, origin)->util = origin_data;
193 static void print_joined(const char *singular, const char *plural,
194 struct string_list *list, struct strbuf *out)
199 strbuf_addf(out, "%s%s", singular, list->items[0].string);
202 strbuf_addstr(out, plural);
203 for (i = 0; i < list->nr - 1; i++)
204 strbuf_addf(out, "%s%s", i > 0 ? ", " : "",
205 list->items[i].string);
206 strbuf_addf(out, " and %s", list->items[list->nr - 1].string);
210 static void add_branch_desc(struct strbuf *out, const char *name)
212 struct strbuf desc = STRBUF_INIT;
214 if (!read_branch_desc(&desc, name)) {
215 const char *bp = desc.buf;
217 const char *ep = strchrnul(bp, '\n');
220 strbuf_addf(out, " : %.*s", (int)(ep - bp), bp);
223 strbuf_complete_line(out);
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, NULL);
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_addstr(out, 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 skip_prefix(me, them->items->string, &me) &&
310 starts_with(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)
320 QSORT(authors->items, authors->nr,
321 cmp_string_list_util_as_integral);
322 QSORT(committers->items, committers->nr,
323 cmp_string_list_util_as_integral);
325 credit_people(out, authors, 'a');
326 credit_people(out, committers, 'c');
329 static void shortlog(const char *name,
330 struct origin_data *origin_data,
332 struct rev_info *rev,
333 struct fmt_merge_msg_opts *opts,
337 struct commit *commit;
338 struct object *branch;
339 struct string_list subjects = STRING_LIST_INIT_DUP;
340 struct string_list authors = STRING_LIST_INIT_DUP;
341 struct string_list committers = STRING_LIST_INIT_DUP;
342 int flags = UNINTERESTING | TREESAME | SEEN | SHOWN | ADDED;
343 struct strbuf sb = STRBUF_INIT;
344 const struct object_id *oid = &origin_data->oid;
345 int limit = opts->shortlog_len;
347 branch = deref_tag(parse_object(oid), oid_to_hex(oid), the_hash_algo->hexsz);
348 if (!branch || branch->type != OBJ_COMMIT)
351 setup_revisions(0, NULL, rev, NULL);
352 add_pending_object(rev, branch, name);
353 add_pending_object(rev, &head->object, "^HEAD");
354 head->object.flags |= UNINTERESTING;
355 if (prepare_revision_walk(rev))
356 die("revision walk setup failed");
357 while ((commit = get_revision(rev)) != NULL) {
358 struct pretty_print_context ctx = {0};
360 if (commit->parents && commit->parents->next) {
361 /* do not list a merge but count committer */
362 if (opts->credit_people)
363 record_person('c', &committers, commit);
366 if (!count && opts->credit_people)
367 /* the 'tip' committer */
368 record_person('c', &committers, commit);
369 if (opts->credit_people)
370 record_person('a', &authors, commit);
372 if (subjects.nr > limit)
375 format_commit_message(commit, "%s", &sb, &ctx);
379 string_list_append(&subjects,
380 oid_to_hex(&commit->object.oid));
382 string_list_append_nodup(&subjects,
383 strbuf_detach(&sb, NULL));
386 if (opts->credit_people)
387 add_people_info(out, &authors, &committers);
389 strbuf_addf(out, "\n* %s: (%d commits)\n", name, count);
391 strbuf_addf(out, "\n* %s:\n", name);
393 if (origin_data->is_local_branch && use_branch_desc)
394 add_branch_desc(out, name);
396 for (i = 0; i < subjects.nr; i++)
398 strbuf_addstr(out, " ...\n");
400 strbuf_addf(out, " %s\n", subjects.items[i].string);
402 clear_commit_marks((struct commit *)branch, flags);
403 clear_commit_marks(head, flags);
404 free_commit_list(rev->commits);
408 string_list_clear(&authors, 0);
409 string_list_clear(&committers, 0);
410 string_list_clear(&subjects, 0);
413 static void fmt_merge_msg_title(struct strbuf *out,
414 const char *current_branch)
419 strbuf_addstr(out, "Merge ");
420 for (i = 0; i < srcs.nr; i++) {
421 struct src_data *src_data = srcs.items[i].util;
422 const char *subsep = "";
424 strbuf_addstr(out, sep);
427 if (src_data->head_status == 1) {
428 strbuf_addstr(out, srcs.items[i].string);
431 if (src_data->head_status == 3) {
433 strbuf_addstr(out, "HEAD");
435 if (src_data->branch.nr) {
436 strbuf_addstr(out, subsep);
438 print_joined("branch ", "branches ", &src_data->branch,
441 if (src_data->r_branch.nr) {
442 strbuf_addstr(out, subsep);
444 print_joined("remote-tracking branch ", "remote-tracking branches ",
445 &src_data->r_branch, out);
447 if (src_data->tag.nr) {
448 strbuf_addstr(out, subsep);
450 print_joined("tag ", "tags ", &src_data->tag, out);
452 if (src_data->generic.nr) {
453 strbuf_addstr(out, subsep);
454 print_joined("commit ", "commits ", &src_data->generic,
457 if (strcmp(".", srcs.items[i].string))
458 strbuf_addf(out, " of %s", srcs.items[i].string);
461 if (!strcmp("master", current_branch))
462 strbuf_addch(out, '\n');
464 strbuf_addf(out, " into %s\n", current_branch);
467 static void fmt_tag_signature(struct strbuf *tagbuf,
472 const char *tag_body = strstr(buf, "\n\n");
475 strbuf_add(tagbuf, tag_body, buf + len - tag_body);
477 strbuf_complete_line(tagbuf);
479 strbuf_addch(tagbuf, '\n');
480 strbuf_add_commented_lines(tagbuf, sig->buf, sig->len);
484 static void fmt_merge_msg_sigs(struct strbuf *out)
486 int i, tag_number = 0, first_tag = 0;
487 struct strbuf tagbuf = STRBUF_INIT;
489 for (i = 0; i < origins.nr; i++) {
490 struct object_id *oid = origins.items[i].util;
491 enum object_type type;
492 unsigned long size, len;
493 char *buf = read_object_file(oid, &type, &size);
494 struct strbuf sig = STRBUF_INIT;
496 if (!buf || type != OBJ_TAG)
498 len = parse_signature(buf, size);
501 ; /* merely annotated */
502 else if (verify_signed_buffer(buf, len, buf + len, size - len, &sig, NULL)) {
504 strbuf_addstr(&sig, "gpg verification failed.\n");
508 fmt_tag_signature(&tagbuf, &sig, buf, len);
511 if (tag_number == 2) {
512 struct strbuf tagline = STRBUF_INIT;
513 strbuf_addch(&tagline, '\n');
514 strbuf_add_commented_lines(&tagline,
515 origins.items[first_tag].string,
516 strlen(origins.items[first_tag].string));
517 strbuf_insert(&tagbuf, 0, tagline.buf,
519 strbuf_release(&tagline);
521 strbuf_addch(&tagbuf, '\n');
522 strbuf_add_commented_lines(&tagbuf,
523 origins.items[i].string,
524 strlen(origins.items[i].string));
525 fmt_tag_signature(&tagbuf, &sig, buf, len);
527 strbuf_release(&sig);
532 strbuf_addch(out, '\n');
533 strbuf_addbuf(out, &tagbuf);
535 strbuf_release(&tagbuf);
538 static void find_merge_parents(struct merge_parents *result,
539 struct strbuf *in, struct object_id *head)
541 struct commit_list *parents;
542 struct commit *head_commit;
546 while (pos < in->len) {
548 char *p = in->buf + pos;
549 char *newline = strchr(p, '\n');
551 struct object_id oid;
552 struct commit *parent;
555 len = newline ? newline - p : strlen(p);
556 pos += len + !!newline;
558 if (parse_oid_hex(p, &oid, &q) ||
561 continue; /* skip not-for-merge */
563 * Do not use get_merge_parent() here; we do not have
564 * "name" here and we do not want to contaminate its
567 obj = parse_object(&oid);
568 parent = (struct commit *)peel_to_type(NULL, 0, obj, OBJ_COMMIT);
571 commit_list_insert(parent, &parents);
572 add_merge_parent(result, &obj->oid, &parent->object.oid);
574 head_commit = lookup_commit(head);
576 commit_list_insert(head_commit, &parents);
577 reduce_heads_replace(&parents);
580 struct commit *cmit = pop_commit(&parents);
581 for (i = 0; i < result->nr; i++)
582 if (!oidcmp(&result->item[i].commit, &cmit->object.oid))
583 result->item[i].used = 1;
586 for (i = j = 0; i < result->nr; i++) {
587 if (result->item[i].used) {
589 result->item[j] = result->item[i];
596 int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
597 struct fmt_merge_msg_opts *opts)
600 struct object_id head_oid;
601 const char *current_branch;
602 void *current_branch_to_free;
603 struct merge_parents merge_parents;
605 memset(&merge_parents, 0, sizeof(merge_parents));
607 /* get current branch */
608 current_branch = current_branch_to_free =
609 resolve_refdup("HEAD", RESOLVE_REF_READING, &head_oid, NULL);
611 die("No current branch");
612 if (starts_with(current_branch, "refs/heads/"))
613 current_branch += 11;
615 find_merge_parents(&merge_parents, in, &head_oid);
618 while (pos < in->len) {
620 char *newline, *p = in->buf + pos;
622 newline = strchr(p, '\n');
623 len = newline ? newline - p : strlen(p);
624 pos += len + !!newline;
627 if (handle_line(p, &merge_parents))
628 die ("Error in line %d: %.*s", i, len, p);
631 if (opts->add_title && srcs.nr)
632 fmt_merge_msg_title(out, current_branch);
635 fmt_merge_msg_sigs(out);
637 if (opts->shortlog_len) {
641 head = lookup_commit_or_die(&head_oid, "HEAD");
642 init_revisions(&rev, NULL);
643 rev.commit_format = CMIT_FMT_ONELINE;
644 rev.ignore_merges = 1;
647 strbuf_complete_line(out);
649 for (i = 0; i < origins.nr; i++)
650 shortlog(origins.items[i].string,
651 origins.items[i].util,
652 head, &rev, opts, out);
655 strbuf_complete_line(out);
656 free(current_branch_to_free);
657 free(merge_parents.item);
661 int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix)
663 const char *inpath = NULL;
664 const char *message = NULL;
665 int shortlog_len = -1;
666 struct option options[] = {
667 { OPTION_INTEGER, 0, "log", &shortlog_len, N_("n"),
668 N_("populate log with at most <n> entries from shortlog"),
669 PARSE_OPT_OPTARG, NULL, DEFAULT_MERGE_LOG_LEN },
670 { OPTION_INTEGER, 0, "summary", &shortlog_len, N_("n"),
671 N_("alias for --log (deprecated)"),
672 PARSE_OPT_OPTARG | PARSE_OPT_HIDDEN, NULL,
673 DEFAULT_MERGE_LOG_LEN },
674 OPT_STRING('m', "message", &message, N_("text"),
675 N_("use <text> as start of message")),
676 OPT_FILENAME('F', "file", &inpath, N_("file to read from")),
681 struct strbuf input = STRBUF_INIT, output = STRBUF_INIT;
683 struct fmt_merge_msg_opts opts;
685 git_config(fmt_merge_msg_config, NULL);
686 argc = parse_options(argc, argv, prefix, options, fmt_merge_msg_usage,
689 usage_with_options(fmt_merge_msg_usage, options);
690 if (shortlog_len < 0)
691 shortlog_len = (merge_log_config > 0) ? merge_log_config : 0;
693 if (inpath && strcmp(inpath, "-")) {
694 in = fopen(inpath, "r");
696 die_errno("cannot open '%s'", inpath);
699 if (strbuf_read(&input, fileno(in), 0) < 0)
700 die_errno("could not read input file");
703 strbuf_addstr(&output, message);
705 memset(&opts, 0, sizeof(opts));
706 opts.add_title = !message;
707 opts.credit_people = 1;
708 opts.shortlog_len = shortlog_len;
710 ret = fmt_merge_msg(&input, &output, &opts);
713 write_in_full(STDOUT_FILENO, output.buf, output.len);