7 #include "run-command.h"
10 #include "parse-options.h"
11 #include "cache-tree.h"
15 #include "merge-recursive.h"
19 * This implements the builtins revert and cherry-pick.
21 * Copyright (c) 2007 Johannes E. Schindelin
23 * Based on git-revert.sh, which is
25 * Copyright (c) 2005 Linus Torvalds
26 * Copyright (c) 2005 Junio C Hamano
29 static const char * const revert_usage
[] = {
30 "git revert [options] <commit-ish>",
34 static const char * const cherry_pick_usage
[] = {
35 "git cherry-pick [options] <commit-ish>",
39 static int edit
, no_replay
, no_commit
, mainline
, signoff
, allow_ff
;
40 static enum { REVERT
, CHERRY_PICK
} action
;
41 static struct commit
*commit
;
42 static const char *commit_name
;
43 static int allow_rerere_auto
;
45 static const char *me
;
46 static const char *strategy
;
48 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
50 static char *get_encoding(const char *message
);
52 static void parse_args(int argc
, const char **argv
)
54 const char * const * usage_str
=
55 action
== REVERT
? revert_usage
: cherry_pick_usage
;
56 unsigned char sha1
[20];
58 struct option options
[] = {
59 OPT_BOOLEAN('n', "no-commit", &no_commit
, "don't automatically commit"),
60 OPT_BOOLEAN('e', "edit", &edit
, "edit the commit message"),
61 OPT_BOOLEAN('r', NULL
, &noop
, "no-op (backward compatibility)"),
62 OPT_BOOLEAN('s', "signoff", &signoff
, "add Signed-off-by:"),
63 OPT_INTEGER('m', "mainline", &mainline
, "parent number"),
64 OPT_RERERE_AUTOUPDATE(&allow_rerere_auto
),
65 OPT_STRING(0, "strategy", &strategy
, "strategy", "merge strategy"),
71 if (action
== CHERRY_PICK
) {
72 struct option cp_extra
[] = {
73 OPT_BOOLEAN('x', NULL
, &no_replay
, "append commit name"),
74 OPT_BOOLEAN(0, "ff", &allow_ff
, "allow fast-forward"),
77 if (parse_options_concat(options
, ARRAY_SIZE(options
), cp_extra
))
81 if (parse_options(argc
, argv
, NULL
, options
, usage_str
, 0) != 1)
82 usage_with_options(usage_str
, options
);
84 commit_name
= argv
[0];
85 if (get_sha1(commit_name
, sha1
))
86 die ("Cannot find '%s'", commit_name
);
87 commit
= lookup_commit_reference(sha1
);
92 struct commit_message
{
96 char *reencoded_message
;
100 static int get_message(const char *raw_message
, struct commit_message
*out
)
102 const char *encoding
;
103 const char *p
, *abbrev
, *eol
;
105 int abbrev_len
, oneline_len
;
109 encoding
= get_encoding(raw_message
);
112 if (!git_commit_encoding
)
113 git_commit_encoding
= "UTF-8";
115 out
->reencoded_message
= NULL
;
116 out
->message
= raw_message
;
117 if (strcmp(encoding
, git_commit_encoding
))
118 out
->reencoded_message
= reencode_string(raw_message
,
119 git_commit_encoding
, encoding
);
120 if (out
->reencoded_message
)
121 out
->message
= out
->reencoded_message
;
123 abbrev
= find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
);
124 abbrev_len
= strlen(abbrev
);
126 /* Find beginning and end of commit subject. */
128 while (*p
&& (*p
!= '\n' || p
[1] != '\n'))
132 for (eol
= p
+ 1; *eol
&& *eol
!= '\n'; eol
++)
136 oneline_len
= eol
- p
;
138 out
->parent_label
= xmalloc(strlen("parent of ") + abbrev_len
+
139 strlen("... ") + oneline_len
+ 1);
140 q
= out
->parent_label
;
141 q
= mempcpy(q
, "parent of ", strlen("parent of "));
143 q
= mempcpy(q
, abbrev
, abbrev_len
);
144 q
= mempcpy(q
, "... ", strlen("... "));
146 q
= mempcpy(q
, p
, oneline_len
);
151 static void free_message(struct commit_message
*msg
)
153 free(msg
->parent_label
);
154 free(msg
->reencoded_message
);
157 static char *get_encoding(const char *message
)
159 const char *p
= message
, *eol
;
162 die ("Could not read commit message of %s",
163 sha1_to_hex(commit
->object
.sha1
));
164 while (*p
&& *p
!= '\n') {
165 for (eol
= p
+ 1; *eol
&& *eol
!= '\n'; eol
++)
167 if (!prefixcmp(p
, "encoding ")) {
168 char *result
= xmalloc(eol
- 8 - p
);
169 strlcpy(result
, p
+ 9, eol
- 8 - p
);
179 static void add_message_to_msg(struct strbuf
*msgbuf
, const char *message
)
181 const char *p
= message
;
182 while (*p
&& (*p
!= '\n' || p
[1] != '\n'))
186 strbuf_addstr(msgbuf
, sha1_to_hex(commit
->object
.sha1
));
189 strbuf_addstr(msgbuf
, p
);
192 static void set_author_ident_env(const char *message
)
194 const char *p
= message
;
196 die ("Could not read commit message of %s",
197 sha1_to_hex(commit
->object
.sha1
));
198 while (*p
&& *p
!= '\n') {
201 for (eol
= p
; *eol
&& *eol
!= '\n'; eol
++)
203 if (!prefixcmp(p
, "author ")) {
204 char *line
, *pend
, *email
, *timestamp
;
207 line
= xmemdupz(p
, eol
- p
);
208 email
= strchr(line
, '<');
210 die ("Could not extract author email from %s",
211 sha1_to_hex(commit
->object
.sha1
));
215 for (pend
= email
; pend
!= line
+ 1 &&
216 isspace(pend
[-1]); pend
--);
220 timestamp
= strchr(email
, '>');
222 die ("Could not extract author time from %s",
223 sha1_to_hex(commit
->object
.sha1
));
225 for (timestamp
++; *timestamp
&& isspace(*timestamp
);
228 setenv("GIT_AUTHOR_NAME", line
, 1);
229 setenv("GIT_AUTHOR_EMAIL", email
, 1);
230 setenv("GIT_AUTHOR_DATE", timestamp
, 1);
238 die ("No author information found in %s",
239 sha1_to_hex(commit
->object
.sha1
));
242 static char *help_msg(void)
244 struct strbuf helpbuf
= STRBUF_INIT
;
245 char *msg
= getenv("GIT_CHERRY_PICK_HELP");
250 strbuf_addstr(&helpbuf
, " After resolving the conflicts,\n"
251 "mark the corrected paths with 'git add <paths>' or 'git rm <paths>'\n"
252 "and commit the result");
254 if (action
== CHERRY_PICK
) {
255 strbuf_addf(&helpbuf
, " with: \n"
257 " git commit -c %s\n",
258 sha1_to_hex(commit
->object
.sha1
));
261 strbuf_addch(&helpbuf
, '.');
262 return strbuf_detach(&helpbuf
, NULL
);
265 static void write_message(struct strbuf
*msgbuf
, const char *filename
)
267 static struct lock_file msg_file
;
269 int msg_fd
= hold_lock_file_for_update(&msg_file
, filename
,
271 if (write_in_full(msg_fd
, msgbuf
->buf
, msgbuf
->len
) < 0)
272 die_errno("Could not write to %s.", filename
);
273 strbuf_release(msgbuf
);
274 if (commit_lock_file(&msg_file
) < 0)
275 die("Error wrapping up %s", filename
);
278 static struct tree
*empty_tree(void)
280 struct tree
*tree
= xcalloc(1, sizeof(struct tree
));
282 tree
->object
.parsed
= 1;
283 tree
->object
.type
= OBJ_TREE
;
284 pretend_sha1_file(NULL
, 0, OBJ_TREE
, tree
->object
.sha1
);
288 static NORETURN
void die_dirty_index(const char *me
)
290 if (read_cache_unmerged()) {
291 die_resolve_conflict(me
);
293 if (advice_commit_before_merge
)
294 die("Your local changes would be overwritten by %s.\n"
295 "Please, commit your changes or stash them to proceed.", me
);
297 die("Your local changes would be overwritten by %s.\n", me
);
301 static int fast_forward_to(const unsigned char *to
, const unsigned char *from
)
303 struct ref_lock
*ref_lock
;
306 if (checkout_fast_forward(from
, to
))
307 exit(1); /* the callee should have complained already */
308 ref_lock
= lock_any_ref_for_update("HEAD", from
, 0);
309 return write_ref_sha1(ref_lock
, to
, "cherry-pick");
312 static void do_recursive_merge(struct commit
*base
, struct commit
*next
,
313 const char *base_label
, const char *next_label
,
314 unsigned char *head
, struct strbuf
*msgbuf
,
317 struct merge_options o
;
318 struct tree
*result
, *next_tree
, *base_tree
, *head_tree
;
320 static struct lock_file index_lock
;
322 index_fd
= hold_locked_index(&index_lock
, 1);
325 init_merge_options(&o
);
326 o
.ancestor
= base
? base_label
: "(empty tree)";
328 o
.branch2
= next
? next_label
: "(empty tree)";
330 head_tree
= parse_tree_indirect(head
);
331 next_tree
= next
? next
->tree
: empty_tree();
332 base_tree
= base
? base
->tree
: empty_tree();
334 clean
= merge_trees(&o
,
336 next_tree
, base_tree
, &result
);
338 if (active_cache_changed
&&
339 (write_cache(index_fd
, active_cache
, active_nr
) ||
340 commit_locked_index(&index_lock
)))
341 die("%s: Unable to write new index file", me
);
342 rollback_lock_file(&index_lock
);
346 strbuf_addstr(msgbuf
, "\nConflicts:\n\n");
347 for (i
= 0; i
< active_nr
;) {
348 struct cache_entry
*ce
= active_cache
[i
++];
350 strbuf_addch(msgbuf
, '\t');
351 strbuf_addstr(msgbuf
, ce
->name
);
352 strbuf_addch(msgbuf
, '\n');
353 while (i
< active_nr
&& !strcmp(ce
->name
,
354 active_cache
[i
]->name
))
358 write_message(msgbuf
, defmsg
);
359 fprintf(stderr
, "Automatic %s failed.%s\n",
361 rerere(allow_rerere_auto
);
364 write_message(msgbuf
, defmsg
);
365 fprintf(stderr
, "Finished one %s.\n", me
);
368 static int do_pick_commit(void)
370 unsigned char head
[20];
371 struct commit
*base
, *next
, *parent
;
372 const char *base_label
, *next_label
;
373 struct commit_message msg
= { NULL
, NULL
, NULL
, NULL
, NULL
};
375 struct strbuf msgbuf
= STRBUF_INIT
;
379 * We do not intend to commit immediately. We just want to
380 * merge the differences in, so let's compute the tree
381 * that represents the "current" state for merge-recursive
384 if (write_cache_as_tree(head
, 0, NULL
))
385 die ("Your index file is unmerged.");
387 if (get_sha1("HEAD", head
))
388 die ("You do not have a valid HEAD");
389 if (index_differs_from("HEAD", 0))
394 if (!commit
->parents
) {
395 if (action
== REVERT
)
396 die ("Cannot revert a root commit");
399 else if (commit
->parents
->next
) {
400 /* Reverting or cherry-picking a merge commit */
402 struct commit_list
*p
;
405 die("Commit %s is a merge but no -m option was given.",
406 sha1_to_hex(commit
->object
.sha1
));
408 for (cnt
= 1, p
= commit
->parents
;
409 cnt
!= mainline
&& p
;
412 if (cnt
!= mainline
|| !p
)
413 die("Commit %s does not have parent %d",
414 sha1_to_hex(commit
->object
.sha1
), mainline
);
416 } else if (0 < mainline
)
417 die("Mainline was specified but commit %s is not a merge.",
418 sha1_to_hex(commit
->object
.sha1
));
420 parent
= commit
->parents
->item
;
422 if (allow_ff
&& !hashcmp(parent
->object
.sha1
, head
))
423 return fast_forward_to(commit
->object
.sha1
, head
);
425 if (parent
&& parse_commit(parent
) < 0)
426 die("%s: cannot parse parent commit %s",
427 me
, sha1_to_hex(parent
->object
.sha1
));
429 if (get_message(commit
->buffer
, &msg
) != 0)
430 die("Cannot get commit message for %s",
431 sha1_to_hex(commit
->object
.sha1
));
434 * "commit" is an existing commit. We would want to apply
435 * the difference it introduces since its first parent "prev"
436 * on top of the current HEAD if we are cherry-pick. Or the
437 * reverse of it if we are revert.
440 defmsg
= git_pathdup("MERGE_MSG");
442 if (action
== REVERT
) {
444 base_label
= msg
.label
;
446 next_label
= msg
.parent_label
;
447 strbuf_addstr(&msgbuf
, "Revert \"");
448 strbuf_addstr(&msgbuf
, msg
.subject
);
449 strbuf_addstr(&msgbuf
, "\"\n\nThis reverts commit ");
450 strbuf_addstr(&msgbuf
, sha1_to_hex(commit
->object
.sha1
));
452 if (commit
->parents
->next
) {
453 strbuf_addstr(&msgbuf
, ", reversing\nchanges made to ");
454 strbuf_addstr(&msgbuf
, sha1_to_hex(parent
->object
.sha1
));
456 strbuf_addstr(&msgbuf
, ".\n");
459 base_label
= msg
.parent_label
;
461 next_label
= msg
.label
;
462 set_author_ident_env(msg
.message
);
463 add_message_to_msg(&msgbuf
, msg
.message
);
465 strbuf_addstr(&msgbuf
, "(cherry picked from commit ");
466 strbuf_addstr(&msgbuf
, sha1_to_hex(commit
->object
.sha1
));
467 strbuf_addstr(&msgbuf
, ")\n");
471 if (!strategy
|| !strcmp(strategy
, "recursive") || action
== REVERT
)
472 do_recursive_merge(base
, next
, base_label
, next_label
,
473 head
, &msgbuf
, defmsg
);
476 struct commit_list
*common
= NULL
;
477 struct commit_list
*remotes
= NULL
;
478 write_message(&msgbuf
, defmsg
);
479 commit_list_insert(base
, &common
);
480 commit_list_insert(next
, &remotes
);
481 res
= try_merge_command(strategy
, common
,
482 sha1_to_hex(head
), remotes
);
483 free_commit_list(common
);
484 free_commit_list(remotes
);
486 fprintf(stderr
, "Automatic %s with strategy %s failed.%s\n",
487 me
, strategy
, help_msg());
488 rerere(allow_rerere_auto
);
497 * If we are cherry-pick, and if the merge did not result in
498 * hand-editing, we will hit this commit and inherit the original
499 * author date and name.
500 * If we are revert, or if our cherry-pick results in a hand merge,
501 * we had better say that the current user is responsible for that.
505 /* 6 is max possible length of our args array including NULL */
510 args
[i
++] = "commit";
519 res
= run_command_v_opt(args
, RUN_GIT_CMD
);
530 static int revert_or_cherry_pick(int argc
, const char **argv
)
532 git_config(git_default_config
, NULL
);
533 me
= action
== REVERT
? "revert" : "cherry-pick";
534 setenv(GIT_REFLOG_ACTION
, me
, 0);
535 parse_args(argc
, argv
);
539 die("cherry-pick --ff cannot be used with --signoff");
541 die("cherry-pick --ff cannot be used with --no-commit");
543 die("cherry-pick --ff cannot be used with -x");
545 die("cherry-pick --ff cannot be used with --edit");
548 if (read_cache() < 0)
549 die("git %s: failed to read the index", me
);
551 return do_pick_commit();
554 int cmd_revert(int argc
, const char **argv
, const char *prefix
)
559 return revert_or_cherry_pick(argc
, argv
);
562 int cmd_cherry_pick(int argc
, const char **argv
, const char *prefix
)
564 action
= CHERRY_PICK
;
565 return revert_or_cherry_pick(argc
, argv
);