6 #include "run-command.h"
9 #include "parse-options.h"
10 #include "cache-tree.h"
14 #include "merge-recursive.h"
18 * This implements the builtins revert and cherry-pick.
20 * Copyright (c) 2007 Johannes E. Schindelin
22 * Based on git-revert.sh, which is
24 * Copyright (c) 2005 Linus Torvalds
25 * Copyright (c) 2005 Junio C Hamano
28 static const char * const revert_usage
[] = {
29 "git revert [options] <commit-ish>",
33 static const char * const cherry_pick_usage
[] = {
34 "git cherry-pick [options] <commit-ish>",
38 static int edit
, no_replay
, no_commit
, mainline
, signoff
, allow_ff
;
39 static enum { REVERT
, CHERRY_PICK
} action
;
40 static struct commit
*commit
;
41 static int commit_argc
;
42 static const char **commit_argv
;
43 static int allow_rerere_auto
;
45 static const char *me
;
48 static const char *strategy
;
49 static const char **xopts
;
50 static size_t xopts_nr
, xopts_alloc
;
52 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
54 static char *get_encoding(const char *message
);
56 static const char * const *revert_or_cherry_pick_usage(void)
58 return action
== REVERT
? revert_usage
: cherry_pick_usage
;
61 static int option_parse_x(const struct option
*opt
,
62 const char *arg
, int unset
)
67 ALLOC_GROW(xopts
, xopts_nr
+ 1, xopts_alloc
);
68 xopts
[xopts_nr
++] = xstrdup(arg
);
72 static void parse_args(int argc
, const char **argv
)
74 const char * const * usage_str
= revert_or_cherry_pick_usage();
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
),
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"),
98 if (parse_options_concat(options
, ARRAY_SIZE(options
), cp_extra
))
99 die(_("program error"));
102 commit_argc
= parse_options(argc
, argv
, NULL
, options
, usage_str
,
103 PARSE_OPT_KEEP_ARGV0
|
104 PARSE_OPT_KEEP_UNKNOWN
);
106 usage_with_options(usage_str
, options
);
111 struct commit_message
{
115 char *reencoded_message
;
119 static int get_message(const char *raw_message
, struct commit_message
*out
)
121 const char *encoding
;
122 const char *abbrev
, *subject
;
123 int abbrev_len
, subject_len
;
128 encoding
= get_encoding(raw_message
);
131 if (!git_commit_encoding
)
132 git_commit_encoding
= "UTF-8";
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
;
142 abbrev
= find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
);
143 abbrev_len
= strlen(abbrev
);
145 subject_len
= find_commit_subject(out
->message
, &subject
);
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 "));
152 q
= mempcpy(q
, abbrev
, abbrev_len
);
153 q
= mempcpy(q
, "... ", strlen("... "));
155 q
= mempcpy(q
, subject
, subject_len
);
160 static void free_message(struct commit_message
*msg
)
162 free(msg
->parent_label
);
163 free(msg
->reencoded_message
);
166 static char *get_encoding(const char *message
)
168 const char *p
= message
, *eol
;
170 while (*p
&& *p
!= '\n') {
171 for (eol
= p
+ 1; *eol
&& *eol
!= '\n'; eol
++)
173 if (!prefixcmp(p
, "encoding ")) {
174 char *result
= xmalloc(eol
- 8 - p
);
175 strlcpy(result
, p
+ 9, eol
- 8 - p
);
185 static void write_cherry_pick_head(void)
188 struct strbuf buf
= STRBUF_INIT
;
190 strbuf_addf(&buf
, "%s\n", sha1_to_hex(commit
->object
.sha1
));
192 fd
= open(git_path("CHERRY_PICK_HEAD"), O_WRONLY
| O_CREAT
, 0666);
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
);
201 static void print_advice(void)
203 char *msg
= getenv("GIT_CHERRY_PICK_HELP");
206 fprintf(stderr
, "%s\n", msg
);
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
212 unlink(git_path("CHERRY_PICK_HEAD"));
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'");
221 static void write_message(struct strbuf
*msgbuf
, const char *filename
)
223 static struct lock_file msg_file
;
225 int msg_fd
= hold_lock_file_for_update(&msg_file
, filename
,
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
);
234 static struct tree
*empty_tree(void)
236 struct tree
*tree
= xcalloc(1, sizeof(struct tree
));
238 tree
->object
.parsed
= 1;
239 tree
->object
.type
= OBJ_TREE
;
240 pretend_sha1_file(NULL
, 0, OBJ_TREE
, tree
->object
.sha1
);
244 static NORETURN
void die_dirty_index(const char *me
)
246 if (read_cache_unmerged()) {
247 die_resolve_conflict(me
);
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."));
254 die(_("Your local changes would be overwritten by cherry-pick.\n"
255 "Please, commit your changes or stash them to proceed."));
257 if (action
== REVERT
)
258 die(_("Your local changes would be overwritten by revert.\n"));
260 die(_("Your local changes would be overwritten by cherry-pick.\n"));
265 static int fast_forward_to(const unsigned char *to
, const unsigned char *from
)
267 struct ref_lock
*ref_lock
;
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");
276 static 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
)
280 struct merge_options o
;
281 struct tree
*result
, *next_tree
, *base_tree
, *head_tree
;
284 static struct lock_file index_lock
;
286 index_fd
= hold_locked_index(&index_lock
, 1);
290 init_merge_options(&o
);
291 o
.ancestor
= base
? base_label
: "(empty tree)";
293 o
.branch2
= next
? next_label
: "(empty tree)";
295 head_tree
= parse_tree_indirect(head
);
296 next_tree
= next
? next
->tree
: empty_tree();
297 base_tree
= base
? base
->tree
: empty_tree();
299 for (xopt
= xopts
; xopt
!= xopts
+ xopts_nr
; xopt
++)
300 parse_merge_opt(&o
, *xopt
);
302 clean
= merge_trees(&o
,
304 next_tree
, base_tree
, &result
);
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
);
315 strbuf_addstr(msgbuf
, "\nConflicts:\n\n");
316 for (i
= 0; i
< active_nr
;) {
317 struct cache_entry
*ce
= active_cache
[i
++];
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
))
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.
339 static int run_git_commit(const char *defmsg
)
341 /* 6 is max possible length of our args array including NULL */
345 args
[i
++] = "commit";
355 return run_command_v_opt(args
, RUN_GIT_CMD
);
358 static int do_pick_commit(void)
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
};
365 struct strbuf msgbuf
= STRBUF_INIT
;
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
375 if (write_cache_as_tree(head
, 0, NULL
))
376 die (_("Your index file is unmerged."));
378 if (get_sha1("HEAD", head
))
379 die (_("You do not have a valid HEAD"));
380 if (index_differs_from("HEAD", 0))
385 if (!commit
->parents
) {
388 else if (commit
->parents
->next
) {
389 /* Reverting or cherry-picking a merge commit */
391 struct commit_list
*p
;
394 die(_("Commit %s is a merge but no -m option was given."),
395 sha1_to_hex(commit
->object
.sha1
));
397 for (cnt
= 1, p
= commit
->parents
;
398 cnt
!= mainline
&& p
;
401 if (cnt
!= mainline
|| !p
)
402 die(_("Commit %s does not have parent %d"),
403 sha1_to_hex(commit
->object
.sha1
), mainline
);
405 } else if (0 < mainline
)
406 die(_("Mainline was specified but commit %s is not a merge."),
407 sha1_to_hex(commit
->object
.sha1
));
409 parent
= commit
->parents
->item
;
411 if (allow_ff
&& parent
&& !hashcmp(parent
->object
.sha1
, head
))
412 return fast_forward_to(commit
->object
.sha1
, head
);
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
));
420 if (get_message(commit
->buffer
, &msg
) != 0)
421 die(_("Cannot get commit message for %s"),
422 sha1_to_hex(commit
->object
.sha1
));
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.
431 defmsg
= git_pathdup("MERGE_MSG");
433 if (action
== REVERT
) {
435 base_label
= msg
.label
;
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
));
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
));
447 strbuf_addstr(&msgbuf
, ".\n");
452 base_label
= msg
.parent_label
;
454 next_label
= msg
.label
;
457 * Append the commit log message to msgbuf; it starts
458 * after the tree, parent, author, committer
459 * information followed by "\n\n".
461 p
= strstr(msg
.message
, "\n\n");
464 strbuf_addstr(&msgbuf
, p
);
468 strbuf_addstr(&msgbuf
, "(cherry picked from commit ");
469 strbuf_addstr(&msgbuf
, sha1_to_hex(commit
->object
.sha1
));
470 strbuf_addstr(&msgbuf
, ")\n");
473 write_cherry_pick_head();
476 if (!strategy
|| !strcmp(strategy
, "recursive") || action
== REVERT
) {
477 res
= do_recursive_merge(base
, next
, base_label
, next_label
,
479 write_message(&msgbuf
, defmsg
);
481 struct commit_list
*common
= NULL
;
482 struct commit_list
*remotes
= NULL
;
484 write_message(&msgbuf
, defmsg
);
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
);
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
),
501 rerere(allow_rerere_auto
);
504 res
= run_git_commit(defmsg
);
513 static void prepare_revs(struct rev_info
*revs
)
517 init_revisions(revs
, NULL
);
519 if (action
!= REVERT
)
522 argc
= setup_revisions(commit_argc
, commit_argv
, revs
, NULL
);
524 usage(*revert_or_cherry_pick_usage());
526 if (prepare_revision_walk(revs
))
527 die(_("revision walk setup failed"));
530 die(_("empty commit set passed"));
533 static void read_and_refresh_cache(const char *me
)
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
);
545 rollback_lock_file(&index_lock
);
548 static int revert_or_cherry_pick(int argc
, const char **argv
)
550 struct rev_info revs
;
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
);
559 die(_("cherry-pick --ff cannot be used with --signoff"));
561 die(_("cherry-pick --ff cannot be used with --no-commit"));
563 die(_("cherry-pick --ff cannot be used with -x"));
565 die(_("cherry-pick --ff cannot be used with --edit"));
568 read_and_refresh_cache(me
);
572 while ((commit
= get_revision(&revs
))) {
573 int res
= do_pick_commit();
581 int cmd_revert(int argc
, const char **argv
, const char *prefix
)
586 return revert_or_cherry_pick(argc
, argv
);
589 int cmd_cherry_pick(int argc
, const char **argv
, const char *prefix
)
591 action
= CHERRY_PICK
;
592 return revert_or_cherry_pick(argc
, argv
);