7 #include "run-command.h"
10 #include "parse-options.h"
11 #include "cache-tree.h"
15 #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
;
39 static enum { REVERT
, CHERRY_PICK
} action
;
40 static struct commit
*commit
;
41 static const char *commit_name
;
42 static int allow_rerere_auto
;
44 static const char *me
;
46 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
48 static char *get_encoding(const char *message
);
50 static void parse_args(int argc
, const char **argv
)
52 const char * const * usage_str
=
53 action
== REVERT
? revert_usage
: cherry_pick_usage
;
54 unsigned char sha1
[20];
56 struct option options
[] = {
57 OPT_BOOLEAN('n', "no-commit", &no_commit
, "don't automatically commit"),
58 OPT_BOOLEAN('e', "edit", &edit
, "edit the commit message"),
59 OPT_BOOLEAN('x', NULL
, &no_replay
, "append commit name when cherry-picking"),
60 OPT_BOOLEAN('r', NULL
, &noop
, "no-op (backward compatibility)"),
61 OPT_BOOLEAN('s', "signoff", &signoff
, "add Signed-off-by:"),
62 OPT_INTEGER('m', "mainline", &mainline
, "parent number"),
63 OPT_RERERE_AUTOUPDATE(&allow_rerere_auto
),
67 if (parse_options(argc
, argv
, NULL
, options
, usage_str
, 0) != 1)
68 usage_with_options(usage_str
, options
);
70 commit_name
= argv
[0];
71 if (get_sha1(commit_name
, sha1
))
72 die ("Cannot find '%s'", commit_name
);
73 commit
= lookup_commit_reference(sha1
);
78 struct commit_message
{
82 char *reencoded_message
;
86 static int get_message(const char *raw_message
, struct commit_message
*out
)
89 const char *p
, *abbrev
, *eol
;
91 int abbrev_len
, oneline_len
;
95 encoding
= get_encoding(raw_message
);
98 if (!git_commit_encoding
)
99 git_commit_encoding
= "UTF-8";
100 if ((out
->reencoded_message
= reencode_string(raw_message
,
101 git_commit_encoding
, encoding
)))
102 out
->message
= out
->reencoded_message
;
104 abbrev
= find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
);
105 abbrev_len
= strlen(abbrev
);
107 /* Find beginning and end of commit subject. */
109 while (*p
&& (*p
!= '\n' || p
[1] != '\n'))
113 for (eol
= p
+ 1; *eol
&& *eol
!= '\n'; eol
++)
117 oneline_len
= eol
- p
;
119 out
->parent_label
= xmalloc(strlen("parent of ") + abbrev_len
+
120 strlen("... ") + oneline_len
+ 1);
121 q
= out
->parent_label
;
122 q
= mempcpy(q
, "parent of ", strlen("parent of "));
124 q
= mempcpy(q
, abbrev
, abbrev_len
);
125 q
= mempcpy(q
, "... ", strlen("... "));
127 q
= mempcpy(q
, p
, oneline_len
);
132 static void free_message(struct commit_message
*msg
)
134 free(msg
->parent_label
);
135 free(msg
->reencoded_message
);
138 static char *get_encoding(const char *message
)
140 const char *p
= message
, *eol
;
143 die ("Could not read commit message of %s",
144 sha1_to_hex(commit
->object
.sha1
));
145 while (*p
&& *p
!= '\n') {
146 for (eol
= p
+ 1; *eol
&& *eol
!= '\n'; eol
++)
148 if (!prefixcmp(p
, "encoding ")) {
149 char *result
= xmalloc(eol
- 8 - p
);
150 strlcpy(result
, p
+ 9, eol
- 8 - p
);
160 static struct lock_file msg_file
;
163 static void add_to_msg(const char *string
)
165 int len
= strlen(string
);
166 if (write_in_full(msg_fd
, string
, len
) < 0)
167 die_errno ("Could not write to MERGE_MSG");
170 static void add_message_to_msg(const char *message
)
172 const char *p
= message
;
173 while (*p
&& (*p
!= '\n' || p
[1] != '\n'))
177 add_to_msg(sha1_to_hex(commit
->object
.sha1
));
184 static void set_author_ident_env(const char *message
)
186 const char *p
= message
;
188 die ("Could not read commit message of %s",
189 sha1_to_hex(commit
->object
.sha1
));
190 while (*p
&& *p
!= '\n') {
193 for (eol
= p
; *eol
&& *eol
!= '\n'; eol
++)
195 if (!prefixcmp(p
, "author ")) {
196 char *line
, *pend
, *email
, *timestamp
;
199 line
= xmemdupz(p
, eol
- p
);
200 email
= strchr(line
, '<');
202 die ("Could not extract author email from %s",
203 sha1_to_hex(commit
->object
.sha1
));
207 for (pend
= email
; pend
!= line
+ 1 &&
208 isspace(pend
[-1]); pend
--);
212 timestamp
= strchr(email
, '>');
214 die ("Could not extract author time from %s",
215 sha1_to_hex(commit
->object
.sha1
));
217 for (timestamp
++; *timestamp
&& isspace(*timestamp
);
220 setenv("GIT_AUTHOR_NAME", line
, 1);
221 setenv("GIT_AUTHOR_EMAIL", email
, 1);
222 setenv("GIT_AUTHOR_DATE", timestamp
, 1);
230 die ("No author information found in %s",
231 sha1_to_hex(commit
->object
.sha1
));
234 static char *help_msg(const char *name
)
236 struct strbuf helpbuf
= STRBUF_INIT
;
237 char *msg
= getenv("GIT_CHERRY_PICK_HELP");
242 strbuf_addstr(&helpbuf
, " After resolving the conflicts,\n"
243 "mark the corrected paths with 'git add <paths>' or 'git rm <paths>'\n"
244 "and commit the result");
246 if (action
== CHERRY_PICK
) {
247 strbuf_addf(&helpbuf
, " with: \n"
249 " git commit -c %s\n",
253 strbuf_addch(&helpbuf
, '.');
254 return strbuf_detach(&helpbuf
, NULL
);
257 static struct tree
*empty_tree(void)
259 struct tree
*tree
= xcalloc(1, sizeof(struct tree
));
261 tree
->object
.parsed
= 1;
262 tree
->object
.type
= OBJ_TREE
;
263 pretend_sha1_file(NULL
, 0, OBJ_TREE
, tree
->object
.sha1
);
267 static NORETURN
void die_dirty_index(const char *me
)
269 if (read_cache_unmerged()) {
270 die_resolve_conflict(me
);
272 if (advice_commit_before_merge
)
273 die("Your local changes would be overwritten by %s.\n"
274 "Please, commit your changes or stash them to proceed.", me
);
276 die("Your local changes would be overwritten by %s.\n", me
);
280 static int revert_or_cherry_pick(int argc
, const char **argv
)
282 unsigned char head
[20];
283 struct commit
*base
, *next
, *parent
;
284 const char *base_label
, *next_label
;
285 int i
, index_fd
, clean
;
286 struct commit_message msg
= { NULL
, NULL
, NULL
, NULL
, NULL
};
288 char *defmsg
= git_pathdup("MERGE_MSG");
289 struct merge_options o
;
290 struct tree
*result
, *next_tree
, *base_tree
, *head_tree
;
291 static struct lock_file index_lock
;
293 git_config(git_default_config
, NULL
);
294 me
= action
== REVERT
? "revert" : "cherry-pick";
295 setenv(GIT_REFLOG_ACTION
, me
, 0);
296 parse_args(argc
, argv
);
298 /* this is copied from the shell script, but it's never triggered... */
299 if (action
== REVERT
&& !no_replay
)
300 die("revert is incompatible with replay");
302 if (read_cache() < 0)
303 die("git %s: failed to read the index", me
);
306 * We do not intend to commit immediately. We just want to
307 * merge the differences in, so let's compute the tree
308 * that represents the "current" state for merge-recursive
311 if (write_cache_as_tree(head
, 0, NULL
))
312 die ("Your index file is unmerged.");
314 if (get_sha1("HEAD", head
))
315 die ("You do not have a valid HEAD");
316 if (index_differs_from("HEAD", 0))
321 index_fd
= hold_locked_index(&index_lock
, 1);
323 if (!commit
->parents
) {
324 if (action
== REVERT
)
325 die ("Cannot revert a root commit");
328 else if (commit
->parents
->next
) {
329 /* Reverting or cherry-picking a merge commit */
331 struct commit_list
*p
;
334 die("Commit %s is a merge but no -m option was given.",
335 sha1_to_hex(commit
->object
.sha1
));
337 for (cnt
= 1, p
= commit
->parents
;
338 cnt
!= mainline
&& p
;
341 if (cnt
!= mainline
|| !p
)
342 die("Commit %s does not have parent %d",
343 sha1_to_hex(commit
->object
.sha1
), mainline
);
345 } else if (0 < mainline
)
346 die("Mainline was specified but commit %s is not a merge.",
347 sha1_to_hex(commit
->object
.sha1
));
349 parent
= commit
->parents
->item
;
351 if (parent
&& parse_commit(parent
) < 0)
352 die("%s: cannot parse parent commit %s",
353 me
, sha1_to_hex(parent
->object
.sha1
));
355 if (get_message(commit
->buffer
, &msg
) != 0)
356 die("Cannot get commit message for %s",
357 sha1_to_hex(commit
->object
.sha1
));
360 * "commit" is an existing commit. We would want to apply
361 * the difference it introduces since its first parent "prev"
362 * on top of the current HEAD if we are cherry-pick. Or the
363 * reverse of it if we are revert.
366 msg_fd
= hold_lock_file_for_update(&msg_file
, defmsg
,
369 if (action
== REVERT
) {
371 base_label
= msg
.label
;
373 next_label
= msg
.parent_label
;
374 add_to_msg("Revert \"");
375 add_to_msg(msg
.subject
);
376 add_to_msg("\"\n\nThis reverts commit ");
377 add_to_msg(sha1_to_hex(commit
->object
.sha1
));
379 if (commit
->parents
->next
) {
380 add_to_msg(", reversing\nchanges made to ");
381 add_to_msg(sha1_to_hex(parent
->object
.sha1
));
386 base_label
= msg
.parent_label
;
388 next_label
= msg
.label
;
389 set_author_ident_env(msg
.message
);
390 add_message_to_msg(msg
.message
);
392 add_to_msg("(cherry picked from commit ");
393 add_to_msg(sha1_to_hex(commit
->object
.sha1
));
399 init_merge_options(&o
);
400 o
.ancestor
= base
? base_label
: "(empty tree)";
402 o
.branch2
= next
? next_label
: "(empty tree)";
404 head_tree
= parse_tree_indirect(head
);
405 next_tree
= next
? next
->tree
: empty_tree();
406 base_tree
= base
? base
->tree
: empty_tree();
408 clean
= merge_trees(&o
,
410 next_tree
, base_tree
, &result
);
412 if (active_cache_changed
&&
413 (write_cache(index_fd
, active_cache
, active_nr
) ||
414 commit_locked_index(&index_lock
)))
415 die("%s: Unable to write new index file", me
);
416 rollback_lock_file(&index_lock
);
419 add_to_msg("\nConflicts:\n\n");
420 for (i
= 0; i
< active_nr
;) {
421 struct cache_entry
*ce
= active_cache
[i
++];
424 add_to_msg(ce
->name
);
426 while (i
< active_nr
&& !strcmp(ce
->name
,
427 active_cache
[i
]->name
))
431 if (commit_lock_file(&msg_file
) < 0)
432 die ("Error wrapping up %s", defmsg
);
433 fprintf(stderr
, "Automatic %s failed.%s\n",
434 me
, help_msg(commit_name
));
435 rerere(allow_rerere_auto
);
438 if (commit_lock_file(&msg_file
) < 0)
439 die ("Error wrapping up %s", defmsg
);
440 fprintf(stderr
, "Finished one %s.\n", me
);
444 * If we are cherry-pick, and if the merge did not result in
445 * hand-editing, we will hit this commit and inherit the original
446 * author date and name.
447 * If we are revert, or if our cherry-pick results in a hand merge,
448 * we had better say that the current user is responsible for that.
452 /* 6 is max possible length of our args array including NULL */
455 args
[i
++] = "commit";
464 return execv_git_cmd(args
);
472 int cmd_revert(int argc
, const char **argv
, const char *prefix
)
478 return revert_or_cherry_pick(argc
, argv
);
481 int cmd_cherry_pick(int argc
, const char **argv
, const char *prefix
)
484 action
= CHERRY_PICK
;
485 return revert_or_cherry_pick(argc
, argv
);