30b39c040c463eb7b64c061be2197df43e60c019
1#include "cache.h"
2#include "builtin.h"
3#include "object.h"
4#include "commit.h"
5#include "tag.h"
6#include "run-command.h"
7#include "exec_cmd.h"
8#include "utf8.h"
9#include "parse-options.h"
10#include "cache-tree.h"
11#include "diff.h"
12#include "revision.h"
13#include "rerere.h"
14#include "merge-recursive.h"
15#include "refs.h"
16
17/*
18 * This implements the builtins revert and cherry-pick.
19 *
20 * Copyright (c) 2007 Johannes E. Schindelin
21 *
22 * Based on git-revert.sh, which is
23 *
24 * Copyright (c) 2005 Linus Torvalds
25 * Copyright (c) 2005 Junio C Hamano
26 */
27
28static const char * const revert_usage[] = {
29 "git revert [options] <commit-ish>",
30 NULL
31};
32
33static const char * const cherry_pick_usage[] = {
34 "git cherry-pick [options] <commit-ish>",
35 NULL
36};
37
38static int edit, no_replay, no_commit, mainline, signoff, allow_ff;
39static enum { REVERT, CHERRY_PICK } action;
40static struct commit *commit;
41static int commit_argc;
42static const char **commit_argv;
43static int allow_rerere_auto;
44
45static const char *me;
46
47/* Merge strategy. */
48static const char *strategy;
49static const char **xopts;
50static size_t xopts_nr, xopts_alloc;
51
52#define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
53
54static char *get_encoding(const char *message);
55
56static const char * const *revert_or_cherry_pick_usage(void)
57{
58 return action == REVERT ? revert_usage : cherry_pick_usage;
59}
60
61static int option_parse_x(const struct option *opt,
62 const char *arg, int unset)
63{
64 if (unset)
65 return 0;
66
67 ALLOC_GROW(xopts, xopts_nr + 1, xopts_alloc);
68 xopts[xopts_nr++] = xstrdup(arg);
69 return 0;
70}
71
72static void parse_args(int argc, const char **argv)
73{
74 const char * const * usage_str = revert_or_cherry_pick_usage();
75 int noop;
76 struct option options[] = {
77 OPT_BOOLEAN('n', "no-commit", &no_commit, "don't automatically commit"),
78 OPT_BOOLEAN('e', "edit", &edit, "edit the commit message"),
79 { OPTION_BOOLEAN, 'r', NULL, &noop, NULL, "no-op (backward compatibility)",
80 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 0 },
81 OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
82 OPT_INTEGER('m', "mainline", &mainline, "parent number"),
83 OPT_RERERE_AUTOUPDATE(&allow_rerere_auto),
84 OPT_STRING(0, "strategy", &strategy, "strategy", "merge strategy"),
85 OPT_CALLBACK('X', "strategy-option", &xopts, "option",
86 "option for merge strategy", option_parse_x),
87 OPT_END(),
88 OPT_END(),
89 OPT_END(),
90 };
91
92 if (action == CHERRY_PICK) {
93 struct option cp_extra[] = {
94 OPT_BOOLEAN('x', NULL, &no_replay, "append commit name"),
95 OPT_BOOLEAN(0, "ff", &allow_ff, "allow fast-forward"),
96 OPT_END(),
97 };
98 if (parse_options_concat(options, ARRAY_SIZE(options), cp_extra))
99 die(_("program error"));
100 }
101
102 commit_argc = parse_options(argc, argv, NULL, options, usage_str,
103 PARSE_OPT_KEEP_ARGV0 |
104 PARSE_OPT_KEEP_UNKNOWN);
105 if (commit_argc < 2)
106 usage_with_options(usage_str, options);
107
108 commit_argv = argv;
109}
110
111struct commit_message {
112 char *parent_label;
113 const char *label;
114 const char *subject;
115 char *reencoded_message;
116 const char *message;
117};
118
119static int get_message(const char *raw_message, struct commit_message *out)
120{
121 const char *encoding;
122 const char *abbrev, *subject;
123 int abbrev_len, subject_len;
124 char *q;
125
126 if (!raw_message)
127 return -1;
128 encoding = get_encoding(raw_message);
129 if (!encoding)
130 encoding = "UTF-8";
131 if (!git_commit_encoding)
132 git_commit_encoding = "UTF-8";
133
134 out->reencoded_message = NULL;
135 out->message = raw_message;
136 if (strcmp(encoding, git_commit_encoding))
137 out->reencoded_message = reencode_string(raw_message,
138 git_commit_encoding, encoding);
139 if (out->reencoded_message)
140 out->message = out->reencoded_message;
141
142 abbrev = find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV);
143 abbrev_len = strlen(abbrev);
144
145 subject_len = find_commit_subject(out->message, &subject);
146
147 out->parent_label = xmalloc(strlen("parent of ") + abbrev_len +
148 strlen("... ") + subject_len + 1);
149 q = out->parent_label;
150 q = mempcpy(q, "parent of ", strlen("parent of "));
151 out->label = q;
152 q = mempcpy(q, abbrev, abbrev_len);
153 q = mempcpy(q, "... ", strlen("... "));
154 out->subject = q;
155 q = mempcpy(q, subject, subject_len);
156 *q = '\0';
157 return 0;
158}
159
160static void free_message(struct commit_message *msg)
161{
162 free(msg->parent_label);
163 free(msg->reencoded_message);
164}
165
166static char *get_encoding(const char *message)
167{
168 const char *p = message, *eol;
169
170 while (*p && *p != '\n') {
171 for (eol = p + 1; *eol && *eol != '\n'; eol++)
172 ; /* do nothing */
173 if (!prefixcmp(p, "encoding ")) {
174 char *result = xmalloc(eol - 8 - p);
175 strlcpy(result, p + 9, eol - 8 - p);
176 return result;
177 }
178 p = eol;
179 if (*p == '\n')
180 p++;
181 }
182 return NULL;
183}
184
185static void write_cherry_pick_head(void)
186{
187 int fd;
188 struct strbuf buf = STRBUF_INIT;
189
190 strbuf_addf(&buf, "%s\n", sha1_to_hex(commit->object.sha1));
191
192 fd = open(git_path("CHERRY_PICK_HEAD"), O_WRONLY | O_CREAT, 0666);
193 if (fd < 0)
194 die_errno(_("Could not open '%s' for writing"),
195 git_path("CHERRY_PICK_HEAD"));
196 if (write_in_full(fd, buf.buf, buf.len) != buf.len || close(fd))
197 die_errno(_("Could not write to '%s'"), git_path("CHERRY_PICK_HEAD"));
198 strbuf_release(&buf);
199}
200
201static void print_advice(void)
202{
203 char *msg = getenv("GIT_CHERRY_PICK_HELP");
204
205 if (msg) {
206 fprintf(stderr, "%s\n", msg);
207 /*
208 * A conflict has occured but the porcelain
209 * (typically rebase --interactive) wants to take care
210 * of the commit itself so remove CHERRY_PICK_HEAD
211 */
212 unlink(git_path("CHERRY_PICK_HEAD"));
213 return;
214 }
215
216 advise("after resolving the conflicts, mark the corrected paths");
217 advise("with 'git add <paths>' or 'git rm <paths>'");
218 advise("and commit the result with 'git commit'");
219}
220
221static void write_message(struct strbuf *msgbuf, const char *filename)
222{
223 static struct lock_file msg_file;
224
225 int msg_fd = hold_lock_file_for_update(&msg_file, filename,
226 LOCK_DIE_ON_ERROR);
227 if (write_in_full(msg_fd, msgbuf->buf, msgbuf->len) < 0)
228 die_errno(_("Could not write to %s."), filename);
229 strbuf_release(msgbuf);
230 if (commit_lock_file(&msg_file) < 0)
231 die(_("Error wrapping up %s"), filename);
232}
233
234static struct tree *empty_tree(void)
235{
236 struct tree *tree = xcalloc(1, sizeof(struct tree));
237
238 tree->object.parsed = 1;
239 tree->object.type = OBJ_TREE;
240 pretend_sha1_file(NULL, 0, OBJ_TREE, tree->object.sha1);
241 return tree;
242}
243
244static NORETURN void die_dirty_index(const char *me)
245{
246 if (read_cache_unmerged()) {
247 die_resolve_conflict(me);
248 } else {
249 if (advice_commit_before_merge) {
250 if (action == REVERT)
251 die(_("Your local changes would be overwritten by revert.\n"
252 "Please, commit your changes or stash them to proceed."));
253 else
254 die(_("Your local changes would be overwritten by cherry-pick.\n"
255 "Please, commit your changes or stash them to proceed."));
256 } else {
257 if (action == REVERT)
258 die(_("Your local changes would be overwritten by revert.\n"));
259 else
260 die(_("Your local changes would be overwritten by cherry-pick.\n"));
261 }
262 }
263}
264
265static int fast_forward_to(const unsigned char *to, const unsigned char *from)
266{
267 struct ref_lock *ref_lock;
268
269 read_cache();
270 if (checkout_fast_forward(from, to))
271 exit(1); /* the callee should have complained already */
272 ref_lock = lock_any_ref_for_update("HEAD", from, 0);
273 return write_ref_sha1(ref_lock, to, "cherry-pick");
274}
275
276static int do_recursive_merge(struct commit *base, struct commit *next,
277 const char *base_label, const char *next_label,
278 unsigned char *head, struct strbuf *msgbuf)
279{
280 struct merge_options o;
281 struct tree *result, *next_tree, *base_tree, *head_tree;
282 int clean, index_fd;
283 const char **xopt;
284 static struct lock_file index_lock;
285
286 index_fd = hold_locked_index(&index_lock, 1);
287
288 read_cache();
289
290 init_merge_options(&o);
291 o.ancestor = base ? base_label : "(empty tree)";
292 o.branch1 = "HEAD";
293 o.branch2 = next ? next_label : "(empty tree)";
294
295 head_tree = parse_tree_indirect(head);
296 next_tree = next ? next->tree : empty_tree();
297 base_tree = base ? base->tree : empty_tree();
298
299 for (xopt = xopts; xopt != xopts + xopts_nr; xopt++)
300 parse_merge_opt(&o, *xopt);
301
302 clean = merge_trees(&o,
303 head_tree,
304 next_tree, base_tree, &result);
305
306 if (active_cache_changed &&
307 (write_cache(index_fd, active_cache, active_nr) ||
308 commit_locked_index(&index_lock)))
309 /* TRANSLATORS: %s will be "revert" or "cherry-pick" */
310 die(_("%s: Unable to write new index file"), me);
311 rollback_lock_file(&index_lock);
312
313 if (!clean) {
314 int i;
315 strbuf_addstr(msgbuf, "\nConflicts:\n\n");
316 for (i = 0; i < active_nr;) {
317 struct cache_entry *ce = active_cache[i++];
318 if (ce_stage(ce)) {
319 strbuf_addch(msgbuf, '\t');
320 strbuf_addstr(msgbuf, ce->name);
321 strbuf_addch(msgbuf, '\n');
322 while (i < active_nr && !strcmp(ce->name,
323 active_cache[i]->name))
324 i++;
325 }
326 }
327 }
328
329 return !clean;
330}
331
332/*
333 * If we are cherry-pick, and if the merge did not result in
334 * hand-editing, we will hit this commit and inherit the original
335 * author date and name.
336 * If we are revert, or if our cherry-pick results in a hand merge,
337 * we had better say that the current user is responsible for that.
338 */
339static int run_git_commit(const char *defmsg)
340{
341 /* 6 is max possible length of our args array including NULL */
342 const char *args[6];
343 int i = 0;
344
345 args[i++] = "commit";
346 args[i++] = "-n";
347 if (signoff)
348 args[i++] = "-s";
349 if (!edit) {
350 args[i++] = "-F";
351 args[i++] = defmsg;
352 }
353 args[i] = NULL;
354
355 return run_command_v_opt(args, RUN_GIT_CMD);
356}
357
358static int do_pick_commit(void)
359{
360 unsigned char head[20];
361 struct commit *base, *next, *parent;
362 const char *base_label, *next_label;
363 struct commit_message msg = { NULL, NULL, NULL, NULL, NULL };
364 char *defmsg = NULL;
365 struct strbuf msgbuf = STRBUF_INIT;
366 int res;
367
368 if (no_commit) {
369 /*
370 * We do not intend to commit immediately. We just want to
371 * merge the differences in, so let's compute the tree
372 * that represents the "current" state for merge-recursive
373 * to work on.
374 */
375 if (write_cache_as_tree(head, 0, NULL))
376 die (_("Your index file is unmerged."));
377 } else {
378 if (get_sha1("HEAD", head))
379 die (_("You do not have a valid HEAD"));
380 if (index_differs_from("HEAD", 0))
381 die_dirty_index(me);
382 }
383 discard_cache();
384
385 if (!commit->parents) {
386 parent = NULL;
387 }
388 else if (commit->parents->next) {
389 /* Reverting or cherry-picking a merge commit */
390 int cnt;
391 struct commit_list *p;
392
393 if (!mainline)
394 die(_("Commit %s is a merge but no -m option was given."),
395 sha1_to_hex(commit->object.sha1));
396
397 for (cnt = 1, p = commit->parents;
398 cnt != mainline && p;
399 cnt++)
400 p = p->next;
401 if (cnt != mainline || !p)
402 die(_("Commit %s does not have parent %d"),
403 sha1_to_hex(commit->object.sha1), mainline);
404 parent = p->item;
405 } else if (0 < mainline)
406 die(_("Mainline was specified but commit %s is not a merge."),
407 sha1_to_hex(commit->object.sha1));
408 else
409 parent = commit->parents->item;
410
411 if (allow_ff && parent && !hashcmp(parent->object.sha1, head))
412 return fast_forward_to(commit->object.sha1, head);
413
414 if (parent && parse_commit(parent) < 0)
415 /* TRANSLATORS: The first %s will be "revert" or
416 "cherry-pick", the second %s a SHA1 */
417 die(_("%s: cannot parse parent commit %s"),
418 me, sha1_to_hex(parent->object.sha1));
419
420 if (get_message(commit->buffer, &msg) != 0)
421 die(_("Cannot get commit message for %s"),
422 sha1_to_hex(commit->object.sha1));
423
424 /*
425 * "commit" is an existing commit. We would want to apply
426 * the difference it introduces since its first parent "prev"
427 * on top of the current HEAD if we are cherry-pick. Or the
428 * reverse of it if we are revert.
429 */
430
431 defmsg = git_pathdup("MERGE_MSG");
432
433 if (action == REVERT) {
434 base = commit;
435 base_label = msg.label;
436 next = parent;
437 next_label = msg.parent_label;
438 strbuf_addstr(&msgbuf, "Revert \"");
439 strbuf_addstr(&msgbuf, msg.subject);
440 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
441 strbuf_addstr(&msgbuf, sha1_to_hex(commit->object.sha1));
442
443 if (commit->parents && commit->parents->next) {
444 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
445 strbuf_addstr(&msgbuf, sha1_to_hex(parent->object.sha1));
446 }
447 strbuf_addstr(&msgbuf, ".\n");
448 } else {
449 const char *p;
450
451 base = parent;
452 base_label = msg.parent_label;
453 next = commit;
454 next_label = msg.label;
455
456 /*
457 * Append the commit log message to msgbuf; it starts
458 * after the tree, parent, author, committer
459 * information followed by "\n\n".
460 */
461 p = strstr(msg.message, "\n\n");
462 if (p) {
463 p += 2;
464 strbuf_addstr(&msgbuf, p);
465 }
466
467 if (no_replay) {
468 strbuf_addstr(&msgbuf, "(cherry picked from commit ");
469 strbuf_addstr(&msgbuf, sha1_to_hex(commit->object.sha1));
470 strbuf_addstr(&msgbuf, ")\n");
471 }
472 if (!no_commit)
473 write_cherry_pick_head();
474 }
475
476 if (!strategy || !strcmp(strategy, "recursive") || action == REVERT) {
477 res = do_recursive_merge(base, next, base_label, next_label,
478 head, &msgbuf);
479 write_message(&msgbuf, defmsg);
480 } else {
481 struct commit_list *common = NULL;
482 struct commit_list *remotes = NULL;
483
484 write_message(&msgbuf, defmsg);
485
486 commit_list_insert(base, &common);
487 commit_list_insert(next, &remotes);
488 res = try_merge_command(strategy, xopts_nr, xopts, common,
489 sha1_to_hex(head), remotes);
490 free_commit_list(common);
491 free_commit_list(remotes);
492 }
493
494 if (res) {
495 error(action == REVERT
496 ? _("could not revert %s... %s")
497 : _("could not apply %s... %s"),
498 find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV),
499 msg.subject);
500 print_advice();
501 rerere(allow_rerere_auto);
502 } else {
503 if (!no_commit)
504 res = run_git_commit(defmsg);
505 }
506
507 free_message(&msg);
508 free(defmsg);
509
510 return res;
511}
512
513static void prepare_revs(struct rev_info *revs)
514{
515 int argc;
516
517 init_revisions(revs, NULL);
518 revs->no_walk = 1;
519 if (action != REVERT)
520 revs->reverse = 1;
521
522 argc = setup_revisions(commit_argc, commit_argv, revs, NULL);
523 if (argc > 1)
524 usage(*revert_or_cherry_pick_usage());
525
526 if (prepare_revision_walk(revs))
527 die(_("revision walk setup failed"));
528
529 if (!revs->commits)
530 die(_("empty commit set passed"));
531}
532
533static void read_and_refresh_cache(const char *me)
534{
535 static struct lock_file index_lock;
536 int index_fd = hold_locked_index(&index_lock, 0);
537 if (read_index_preload(&the_index, NULL) < 0)
538 die(_("git %s: failed to read the index"), me);
539 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
540 if (the_index.cache_changed) {
541 if (write_index(&the_index, index_fd) ||
542 commit_locked_index(&index_lock))
543 die(_("git %s: failed to refresh the index"), me);
544 }
545 rollback_lock_file(&index_lock);
546}
547
548static int revert_or_cherry_pick(int argc, const char **argv)
549{
550 struct rev_info revs;
551
552 git_config(git_default_config, NULL);
553 me = action == REVERT ? "revert" : "cherry-pick";
554 setenv(GIT_REFLOG_ACTION, me, 0);
555 parse_args(argc, argv);
556
557 if (allow_ff) {
558 if (signoff)
559 die(_("cherry-pick --ff cannot be used with --signoff"));
560 if (no_commit)
561 die(_("cherry-pick --ff cannot be used with --no-commit"));
562 if (no_replay)
563 die(_("cherry-pick --ff cannot be used with -x"));
564 if (edit)
565 die(_("cherry-pick --ff cannot be used with --edit"));
566 }
567
568 read_and_refresh_cache(me);
569
570 prepare_revs(&revs);
571
572 while ((commit = get_revision(&revs))) {
573 int res = do_pick_commit();
574 if (res)
575 return res;
576 }
577
578 return 0;
579}
580
581int cmd_revert(int argc, const char **argv, const char *prefix)
582{
583 if (isatty(0))
584 edit = 1;
585 action = REVERT;
586 return revert_or_cherry_pick(argc, argv);
587}
588
589int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
590{
591 action = CHERRY_PICK;
592 return revert_or_cherry_pick(argc, argv);
593}