]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/fmt-merge-msg.c
t/README: A new section about test coverage
[thirdparty/git.git] / builtin / fmt-merge-msg.c
CommitLineData
25f38f06 1#include "builtin.h"
00449f99
JS
2#include "cache.h"
3#include "commit.h"
4#include "diff.h"
5#include "revision.h"
6#include "tag.h"
fcb243f7 7#include "string-list.h"
00449f99 8
c8ef0383
PH
9static const char * const fmt_merge_msg_usage[] = {
10 "git fmt-merge-msg [--log|--no-log] [--file <file>]",
11 NULL
12};
00449f99 13
96f1e58f 14static int merge_summary;
00449f99 15
ef90d6d4 16static int fmt_merge_msg_config(const char *key, const char *value, void *cb)
00449f99 17{
6cd9cfef
SG
18 static int found_merge_log = 0;
19 if (!strcmp("merge.log", key)) {
20 found_merge_log = 1;
21 merge_summary = git_config_bool(key, value);
22 }
23 if (!found_merge_log && !strcmp("merge.summary", key))
00449f99
JS
24 merge_summary = git_config_bool(key, value);
25 return 0;
26}
27
fcb243f7
SB
28struct src_data {
29 struct string_list branch, tag, r_branch, generic;
30 int head_status;
00449f99
JS
31};
32
fcb243f7 33void init_src_data(struct src_data *data)
00449f99 34{
fcb243f7
SB
35 data->branch.strdup_strings = 1;
36 data->tag.strdup_strings = 1;
37 data->r_branch.strdup_strings = 1;
38 data->generic.strdup_strings = 1;
00449f99
JS
39}
40
fcb243f7
SB
41static struct string_list srcs = { NULL, 0, 0, 1 };
42static struct string_list origins = { NULL, 0, 0, 1 };
00449f99
JS
43
44static int handle_line(char *line)
45{
46 int i, len = strlen(line);
47 unsigned char *sha1;
48 char *src, *origin;
49 struct src_data *src_data;
fcb243f7 50 struct string_list_item *item;
e918c6ab 51 int pulling_head = 0;
00449f99
JS
52
53 if (len < 43 || line[40] != '\t')
54 return 1;
55
cc44c765 56 if (!prefixcmp(line + 41, "not-for-merge"))
00449f99
JS
57 return 0;
58
59 if (line[41] != '\t')
60 return 2;
61
62 line[40] = 0;
63 sha1 = xmalloc(20);
64 i = get_sha1(line, sha1);
65 line[40] = '\t';
66 if (i)
67 return 3;
68
69 if (line[len - 1] == '\n')
70 line[len - 1] = 0;
71 line += 42;
72
73 src = strstr(line, " of ");
74 if (src) {
75 *src = 0;
76 src += 4;
e918c6ab
JH
77 pulling_head = 0;
78 } else {
79 src = line;
80 pulling_head = 1;
81 }
00449f99 82
fcb243f7
SB
83 item = unsorted_string_list_lookup(&srcs, src);
84 if (!item) {
1d2f80fa 85 item = string_list_append(&srcs, src);
fcb243f7
SB
86 item->util = xcalloc(1, sizeof(struct src_data));
87 init_src_data(item->util);
00449f99 88 }
fcb243f7 89 src_data = item->util;
00449f99 90
e918c6ab 91 if (pulling_head) {
fcb243f7 92 origin = src;
e918c6ab 93 src_data->head_status |= 1;
cc44c765 94 } else if (!prefixcmp(line, "branch ")) {
fcb243f7 95 origin = line + 7;
1d2f80fa 96 string_list_append(&src_data->branch, origin);
00449f99 97 src_data->head_status |= 2;
cc44c765 98 } else if (!prefixcmp(line, "tag ")) {
00449f99 99 origin = line;
1d2f80fa 100 string_list_append(&src_data->tag, origin + 4);
00449f99 101 src_data->head_status |= 2;
cc44c765 102 } else if (!prefixcmp(line, "remote branch ")) {
fcb243f7 103 origin = line + 14;
1d2f80fa 104 string_list_append(&src_data->r_branch, origin);
00449f99 105 src_data->head_status |= 2;
00449f99 106 } else {
fcb243f7 107 origin = src;
1d2f80fa 108 string_list_append(&src_data->generic, line);
00449f99
JS
109 src_data->head_status |= 2;
110 }
111
112 if (!strcmp(".", src) || !strcmp(src, origin)) {
113 int len = strlen(origin);
fcb243f7 114 if (origin[0] == '\'' && origin[len - 1] == '\'')
182af834 115 origin = xmemdupz(origin + 1, len - 2);
00449f99 116 } else {
2d7320d0 117 char *new_origin = xmalloc(strlen(origin) + strlen(src) + 5);
00449f99
JS
118 sprintf(new_origin, "%s of %s", origin, src);
119 origin = new_origin;
120 }
1d2f80fa 121 string_list_append(&origins, origin)->util = sha1;
00449f99
JS
122 return 0;
123}
124
125static void print_joined(const char *singular, const char *plural,
fcb243f7 126 struct string_list *list, struct strbuf *out)
00449f99
JS
127{
128 if (list->nr == 0)
129 return;
130 if (list->nr == 1) {
fcb243f7 131 strbuf_addf(out, "%s%s", singular, list->items[0].string);
00449f99
JS
132 } else {
133 int i;
0b9a969e 134 strbuf_addstr(out, plural);
00449f99 135 for (i = 0; i < list->nr - 1; i++)
fcb243f7
SB
136 strbuf_addf(out, "%s%s", i > 0 ? ", " : "",
137 list->items[i].string);
138 strbuf_addf(out, " and %s", list->items[list->nr - 1].string);
00449f99
JS
139 }
140}
141
142static void shortlog(const char *name, unsigned char *sha1,
0b9a969e
MV
143 struct commit *head, struct rev_info *rev, int limit,
144 struct strbuf *out)
00449f99
JS
145{
146 int i, count = 0;
147 struct commit *commit;
148 struct object *branch;
fcb243f7 149 struct string_list subjects = { NULL, 0, 0, 1 };
7dc0fe3b 150 int flags = UNINTERESTING | TREESAME | SEEN | SHOWN | ADDED;
15cb5007 151 struct strbuf sb = STRBUF_INIT;
00449f99
JS
152
153 branch = deref_tag(parse_object(sha1), sha1_to_hex(sha1), 40);
1974632c 154 if (!branch || branch->type != OBJ_COMMIT)
00449f99
JS
155 return;
156
157 setup_revisions(0, NULL, rev, NULL);
158 rev->ignore_merges = 1;
159 add_pending_object(rev, branch, name);
160 add_pending_object(rev, &head->object, "^HEAD");
161 head->object.flags |= UNINTERESTING;
3d51e1b5
MK
162 if (prepare_revision_walk(rev))
163 die("revision walk setup failed");
00449f99 164 while ((commit = get_revision(rev)) != NULL) {
15cb5007 165 struct pretty_print_context ctx = {0};
00449f99
JS
166
167 /* ignore merges */
168 if (commit->parents && commit->parents->next)
169 continue;
170
171 count++;
172 if (subjects.nr > limit)
173 continue;
174
15cb5007
SB
175 format_commit_message(commit, "%s", &sb, &ctx);
176 strbuf_ltrim(&sb);
6a28518a 177
15cb5007 178 if (!sb.len)
1d2f80fa
JP
179 string_list_append(&subjects,
180 sha1_to_hex(commit->object.sha1));
15cb5007 181 else
1d2f80fa 182 string_list_append(&subjects, strbuf_detach(&sb, NULL));
00449f99
JS
183 }
184
185 if (count > limit)
0b9a969e 186 strbuf_addf(out, "\n* %s: (%d commits)\n", name, count);
00449f99 187 else
0b9a969e 188 strbuf_addf(out, "\n* %s:\n", name);
00449f99
JS
189
190 for (i = 0; i < subjects.nr; i++)
191 if (i >= limit)
0b9a969e 192 strbuf_addf(out, " ...\n");
00449f99 193 else
fcb243f7 194 strbuf_addf(out, " %s\n", subjects.items[i].string);
00449f99
JS
195
196 clear_commit_marks((struct commit *)branch, flags);
197 clear_commit_marks(head, flags);
198 free_commit_list(rev->commits);
199 rev->commits = NULL;
200 rev->pending.nr = 0;
201
fcb243f7 202 string_list_clear(&subjects, 0);
00449f99
JS
203}
204
403994e8
TRC
205static void do_fmt_merge_msg_title(struct strbuf *out,
206 const char *current_branch) {
207 int i = 0;
fd13b21f 208 char *sep = "";
419fe5bc 209
0b9a969e 210 strbuf_addstr(out, "Merge ");
00449f99 211 for (i = 0; i < srcs.nr; i++) {
fcb243f7 212 struct src_data *src_data = srcs.items[i].util;
00449f99
JS
213 const char *subsep = "";
214
0b9a969e 215 strbuf_addstr(out, sep);
00449f99
JS
216 sep = "; ";
217
218 if (src_data->head_status == 1) {
fcb243f7 219 strbuf_addstr(out, srcs.items[i].string);
00449f99
JS
220 continue;
221 }
222 if (src_data->head_status == 3) {
223 subsep = ", ";
0b9a969e 224 strbuf_addstr(out, "HEAD");
00449f99
JS
225 }
226 if (src_data->branch.nr) {
0b9a969e 227 strbuf_addstr(out, subsep);
00449f99 228 subsep = ", ";
0b9a969e
MV
229 print_joined("branch ", "branches ", &src_data->branch,
230 out);
00449f99
JS
231 }
232 if (src_data->r_branch.nr) {
0b9a969e 233 strbuf_addstr(out, subsep);
00449f99
JS
234 subsep = ", ";
235 print_joined("remote branch ", "remote branches ",
0b9a969e 236 &src_data->r_branch, out);
00449f99
JS
237 }
238 if (src_data->tag.nr) {
0b9a969e 239 strbuf_addstr(out, subsep);
00449f99 240 subsep = ", ";
0b9a969e 241 print_joined("tag ", "tags ", &src_data->tag, out);
00449f99
JS
242 }
243 if (src_data->generic.nr) {
0b9a969e
MV
244 strbuf_addstr(out, subsep);
245 print_joined("commit ", "commits ", &src_data->generic,
246 out);
00449f99 247 }
fcb243f7
SB
248 if (strcmp(".", srcs.items[i].string))
249 strbuf_addf(out, " of %s", srcs.items[i].string);
00449f99
JS
250 }
251
252 if (!strcmp("master", current_branch))
0b9a969e 253 strbuf_addch(out, '\n');
00449f99 254 else
0b9a969e 255 strbuf_addf(out, " into %s\n", current_branch);
403994e8
TRC
256}
257
8c6bdfdf
TRC
258static int do_fmt_merge_msg(int merge_title, int merge_summary,
259 struct strbuf *in, struct strbuf *out) {
403994e8
TRC
260 int limit = 20, i = 0, pos = 0;
261 unsigned char head_sha1[20];
262 const char *current_branch;
263
264 /* get current branch */
265 current_branch = resolve_ref("HEAD", head_sha1, 1, NULL);
266 if (!current_branch)
267 die("No current branch");
268 if (!prefixcmp(current_branch, "refs/heads/"))
269 current_branch += 11;
270
271 /* get a line */
272 while (pos < in->len) {
273 int len;
274 char *newline, *p = in->buf + pos;
275
276 newline = strchr(p, '\n');
277 len = newline ? newline - p : strlen(p);
278 pos += len + !!newline;
279 i++;
280 p[len] = 0;
281 if (handle_line(p))
282 die ("Error in line %d: %.*s", i, len, p);
283 }
284
285 if (!srcs.nr)
286 return 0;
287
8c6bdfdf
TRC
288 if (merge_title)
289 do_fmt_merge_msg_title(out, current_branch);
00449f99
JS
290
291 if (merge_summary) {
292 struct commit *head;
293 struct rev_info rev;
294
295 head = lookup_commit(head_sha1);
0b9a969e 296 init_revisions(&rev, NULL);
00449f99
JS
297 rev.commit_format = CMIT_FMT_ONELINE;
298 rev.ignore_merges = 1;
299 rev.limited = 1;
300
f0ecac2b
TRC
301 if (suffixcmp(out->buf, "\n"))
302 strbuf_addch(out, '\n');
303
00449f99 304 for (i = 0; i < origins.nr; i++)
fcb243f7 305 shortlog(origins.items[i].string, origins.items[i].util,
0b9a969e 306 head, &rev, limit, out);
00449f99 307 }
0b9a969e
MV
308 return 0;
309}
310
2234ec54 311int fmt_merge_msg(int merge_summary, struct strbuf *in, struct strbuf *out) {
8c6bdfdf
TRC
312 return do_fmt_merge_msg(1, merge_summary, in, out);
313}
314
315int fmt_merge_msg_shortlog(struct strbuf *in, struct strbuf *out) {
316 return do_fmt_merge_msg(0, 1, in, out);
2234ec54
TRC
317}
318
0b9a969e
MV
319int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix)
320{
c8ef0383
PH
321 const char *inpath = NULL;
322 struct option options[] = {
323 OPT_BOOLEAN(0, "log", &merge_summary, "populate log with the shortlog"),
63e67150
SB
324 { OPTION_BOOLEAN, 0, "summary", &merge_summary, NULL,
325 "alias for --log (deprecated)",
326 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
df217ed6 327 OPT_FILENAME('F', "file", &inpath, "file to read from"),
c8ef0383
PH
328 OPT_END()
329 };
330
0b9a969e 331 FILE *in = stdin;
f285a2d7 332 struct strbuf input = STRBUF_INIT, output = STRBUF_INIT;
0b9a969e
MV
333 int ret;
334
335 git_config(fmt_merge_msg_config, NULL);
37782920
SB
336 argc = parse_options(argc, argv, prefix, options, fmt_merge_msg_usage,
337 0);
c8ef0383
PH
338 if (argc > 0)
339 usage_with_options(fmt_merge_msg_usage, options);
340
341 if (inpath && strcmp(inpath, "-")) {
342 in = fopen(inpath, "r");
343 if (!in)
0721c314 344 die_errno("cannot open '%s'", inpath);
0b9a969e
MV
345 }
346
0b9a969e 347 if (strbuf_read(&input, fileno(in), 0) < 0)
d824cbba 348 die_errno("could not read input file");
0b9a969e
MV
349 ret = fmt_merge_msg(merge_summary, &input, &output);
350 if (ret)
351 return ret;
c8ef0383 352 write_in_full(STDOUT_FILENO, output.buf, output.len);
00449f99
JS
353 return 0;
354}