5 #include "object-store.h"
10 #include "string-list.h"
12 #include "fmt-merge-msg.h"
13 #include "gpg-interface.h"
14 #include "repository.h"
16 static const char * const fmt_merge_msg_usage
[] = {
17 N_("git fmt-merge-msg [-m <message>] [--log[=<n>] | --no-log] [--file <file>]"),
21 static int use_branch_desc
;
23 int fmt_merge_msg_config(const char *key
, const char *value
, void *cb
)
25 if (!strcmp(key
, "merge.log") || !strcmp(key
, "merge.summary")) {
27 merge_log_config
= git_config_bool_or_int(key
, value
, &is_bool
);
28 if (!is_bool
&& merge_log_config
< 0)
29 return error("%s: negative length %s", key
, value
);
30 if (is_bool
&& merge_log_config
)
31 merge_log_config
= DEFAULT_MERGE_LOG_LEN
;
32 } else if (!strcmp(key
, "merge.branchdesc")) {
33 use_branch_desc
= git_config_bool(key
, value
);
35 return git_default_config(key
, value
, cb
);
40 /* merge data per repository where the merged tips came from */
42 struct string_list branch
, tag
, r_branch
, generic
;
48 unsigned is_local_branch
:1;
51 static void init_src_data(struct src_data
*data
)
53 data
->branch
.strdup_strings
= 1;
54 data
->tag
.strdup_strings
= 1;
55 data
->r_branch
.strdup_strings
= 1;
56 data
->generic
.strdup_strings
= 1;
59 static struct string_list srcs
= STRING_LIST_INIT_DUP
;
60 static struct string_list origins
= STRING_LIST_INIT_DUP
;
62 struct merge_parents
{
65 struct object_id given
;
66 struct object_id commit
;
72 * I know, I know, this is inefficient, but you won't be pulling and merging
73 * hundreds of heads at a time anyway.
75 static struct merge_parent
*find_merge_parent(struct merge_parents
*table
,
76 struct object_id
*given
,
77 struct object_id
*commit
)
80 for (i
= 0; i
< table
->nr
; i
++) {
81 if (given
&& oidcmp(&table
->item
[i
].given
, given
))
83 if (commit
&& oidcmp(&table
->item
[i
].commit
, commit
))
85 return &table
->item
[i
];
90 static void add_merge_parent(struct merge_parents
*table
,
91 struct object_id
*given
,
92 struct object_id
*commit
)
94 if (table
->nr
&& find_merge_parent(table
, given
, commit
))
96 ALLOC_GROW(table
->item
, table
->nr
+ 1, table
->alloc
);
97 oidcpy(&table
->item
[table
->nr
].given
, given
);
98 oidcpy(&table
->item
[table
->nr
].commit
, commit
);
99 table
->item
[table
->nr
].used
= 0;
103 static int handle_line(char *line
, struct merge_parents
*merge_parents
)
105 int i
, len
= strlen(line
);
106 struct origin_data
*origin_data
;
109 struct src_data
*src_data
;
110 struct string_list_item
*item
;
111 int pulling_head
= 0;
112 struct object_id oid
;
114 if (len
< GIT_SHA1_HEXSZ
+ 3 || line
[GIT_SHA1_HEXSZ
] != '\t')
117 if (starts_with(line
+ GIT_SHA1_HEXSZ
+ 1, "not-for-merge"))
120 if (line
[GIT_SHA1_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')
135 line
+= GIT_SHA1_HEXSZ
+ 2;
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(the_repository
, parse_object(the_repository
, oid
),
350 if (!branch
|| branch
->type
!= OBJ_COMMIT
)
353 setup_revisions(0, NULL
, rev
, NULL
);
354 add_pending_object(rev
, branch
, name
);
355 add_pending_object(rev
, &head
->object
, "^HEAD");
356 head
->object
.flags
|= UNINTERESTING
;
357 if (prepare_revision_walk(rev
))
358 die("revision walk setup failed");
359 while ((commit
= get_revision(rev
)) != NULL
) {
360 struct pretty_print_context ctx
= {0};
362 if (commit
->parents
&& commit
->parents
->next
) {
363 /* do not list a merge but count committer */
364 if (opts
->credit_people
)
365 record_person('c', &committers
, commit
);
368 if (!count
&& opts
->credit_people
)
369 /* the 'tip' committer */
370 record_person('c', &committers
, commit
);
371 if (opts
->credit_people
)
372 record_person('a', &authors
, commit
);
374 if (subjects
.nr
> limit
)
377 format_commit_message(commit
, "%s", &sb
, &ctx
);
381 string_list_append(&subjects
,
382 oid_to_hex(&commit
->object
.oid
));
384 string_list_append_nodup(&subjects
,
385 strbuf_detach(&sb
, NULL
));
388 if (opts
->credit_people
)
389 add_people_info(out
, &authors
, &committers
);
391 strbuf_addf(out
, "\n* %s: (%d commits)\n", name
, count
);
393 strbuf_addf(out
, "\n* %s:\n", name
);
395 if (origin_data
->is_local_branch
&& use_branch_desc
)
396 add_branch_desc(out
, name
);
398 for (i
= 0; i
< subjects
.nr
; i
++)
400 strbuf_addstr(out
, " ...\n");
402 strbuf_addf(out
, " %s\n", subjects
.items
[i
].string
);
404 clear_commit_marks((struct commit
*)branch
, flags
);
405 clear_commit_marks(head
, flags
);
406 free_commit_list(rev
->commits
);
410 string_list_clear(&authors
, 0);
411 string_list_clear(&committers
, 0);
412 string_list_clear(&subjects
, 0);
415 static void fmt_merge_msg_title(struct strbuf
*out
,
416 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 struct object_id
*oid
= origins
.items
[i
].util
;
493 enum object_type type
;
494 unsigned long size
, len
;
495 char *buf
= read_object_file(oid
, &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
, struct object_id
*head
)
543 struct commit_list
*parents
;
544 struct commit
*head_commit
;
548 while (pos
< in
->len
) {
550 char *p
= in
->buf
+ pos
;
551 char *newline
= strchr(p
, '\n');
552 struct object_id oid
;
553 struct commit
*parent
;
556 len
= newline
? newline
- p
: strlen(p
);
557 pos
+= len
+ !!newline
;
559 if (len
< GIT_SHA1_HEXSZ
+ 3 ||
560 get_oid_hex(p
, &oid
) ||
561 p
[GIT_SHA1_HEXSZ
] != '\t' ||
562 p
[GIT_SHA1_HEXSZ
+ 1] != '\t')
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(the_repository
, &oid
);
570 parent
= (struct commit
*)peel_to_type(NULL
, 0, obj
, OBJ_COMMIT
);
573 commit_list_insert(parent
, &parents
);
574 add_merge_parent(result
, &obj
->oid
, &parent
->object
.oid
);
576 head_commit
= lookup_commit(the_repository
, head
);
578 commit_list_insert(head_commit
, &parents
);
579 reduce_heads_replace(&parents
);
582 struct commit
*cmit
= pop_commit(&parents
);
583 for (i
= 0; i
< result
->nr
; i
++)
584 if (!oidcmp(&result
->item
[i
].commit
, &cmit
->object
.oid
))
585 result
->item
[i
].used
= 1;
588 for (i
= j
= 0; i
< result
->nr
; i
++) {
589 if (result
->item
[i
].used
) {
591 result
->item
[j
] = result
->item
[i
];
598 int fmt_merge_msg(struct strbuf
*in
, struct strbuf
*out
,
599 struct fmt_merge_msg_opts
*opts
)
602 struct object_id head_oid
;
603 const char *current_branch
;
604 void *current_branch_to_free
;
605 struct merge_parents merge_parents
;
607 memset(&merge_parents
, 0, sizeof(merge_parents
));
609 /* get current branch */
610 current_branch
= current_branch_to_free
=
611 resolve_refdup("HEAD", RESOLVE_REF_READING
, &head_oid
, NULL
);
613 die("No current branch");
614 if (starts_with(current_branch
, "refs/heads/"))
615 current_branch
+= 11;
617 find_merge_parents(&merge_parents
, in
, &head_oid
);
620 while (pos
< in
->len
) {
622 char *newline
, *p
= in
->buf
+ pos
;
624 newline
= strchr(p
, '\n');
625 len
= newline
? newline
- p
: strlen(p
);
626 pos
+= len
+ !!newline
;
629 if (handle_line(p
, &merge_parents
))
630 die ("Error in line %d: %.*s", i
, len
, p
);
633 if (opts
->add_title
&& srcs
.nr
)
634 fmt_merge_msg_title(out
, current_branch
);
637 fmt_merge_msg_sigs(out
);
639 if (opts
->shortlog_len
) {
643 head
= lookup_commit_or_die(&head_oid
, "HEAD");
644 init_revisions(&rev
, NULL
);
645 rev
.commit_format
= CMIT_FMT_ONELINE
;
646 rev
.ignore_merges
= 1;
649 strbuf_complete_line(out
);
651 for (i
= 0; i
< origins
.nr
; i
++)
652 shortlog(origins
.items
[i
].string
,
653 origins
.items
[i
].util
,
654 head
, &rev
, opts
, out
);
657 strbuf_complete_line(out
);
658 free(current_branch_to_free
);
659 free(merge_parents
.item
);
663 int cmd_fmt_merge_msg(int argc
, const char **argv
, const char *prefix
)
665 const char *inpath
= NULL
;
666 const char *message
= NULL
;
667 int shortlog_len
= -1;
668 struct option options
[] = {
669 { OPTION_INTEGER
, 0, "log", &shortlog_len
, N_("n"),
670 N_("populate log with at most <n> entries from shortlog"),
671 PARSE_OPT_OPTARG
, NULL
, DEFAULT_MERGE_LOG_LEN
},
672 { OPTION_INTEGER
, 0, "summary", &shortlog_len
, N_("n"),
673 N_("alias for --log (deprecated)"),
674 PARSE_OPT_OPTARG
| PARSE_OPT_HIDDEN
, NULL
,
675 DEFAULT_MERGE_LOG_LEN
},
676 OPT_STRING('m', "message", &message
, N_("text"),
677 N_("use <text> as start of message")),
678 OPT_FILENAME('F', "file", &inpath
, N_("file to read from")),
683 struct strbuf input
= STRBUF_INIT
, output
= STRBUF_INIT
;
685 struct fmt_merge_msg_opts opts
;
687 git_config(fmt_merge_msg_config
, NULL
);
688 argc
= parse_options(argc
, argv
, prefix
, options
, fmt_merge_msg_usage
,
691 usage_with_options(fmt_merge_msg_usage
, options
);
692 if (shortlog_len
< 0)
693 shortlog_len
= (merge_log_config
> 0) ? merge_log_config
: 0;
695 if (inpath
&& strcmp(inpath
, "-")) {
696 in
= fopen(inpath
, "r");
698 die_errno("cannot open '%s'", inpath
);
701 if (strbuf_read(&input
, fileno(in
), 0) < 0)
702 die_errno("could not read input file");
705 strbuf_addstr(&output
, message
);
707 memset(&opts
, 0, sizeof(opts
));
708 opts
.add_title
= !message
;
709 opts
.credit_people
= 1;
710 opts
.shortlog_len
= shortlog_len
;
712 ret
= fmt_merge_msg(&input
, &output
, &opts
);
715 write_in_full(STDOUT_FILENO
, output
.buf
, output
.len
);