]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/rebase.c
sequencer: the `am` and `rebase--interactive` scripts are gone
[thirdparty/git.git] / builtin / rebase.c
CommitLineData
55071ea2
PK
1/*
2 * "git rebase" builtin command
3 *
4 * Copyright (c) 2018 Pratik Karki
5 */
6
f8adbec9 7#define USE_THE_INDEX_COMPATIBILITY_MACROS
55071ea2
PK
8#include "builtin.h"
9#include "run-command.h"
10#include "exec-cmd.h"
11#include "argv-array.h"
12#include "dir.h"
ac7f467f
PK
13#include "packfile.h"
14#include "refs.h"
15#include "quote.h"
16#include "config.h"
17#include "cache-tree.h"
18#include "unpack-trees.h"
19#include "lockfile.h"
f28d40d3 20#include "parse-options.h"
075bc852 21#include "commit.h"
bff014da 22#include "diff.h"
e0333e5c 23#include "wt-status.h"
9a48a615 24#include "revision.h"
e0720a38 25#include "commit-reach.h"
122420c2 26#include "rerere.h"
5aec9271 27#include "branch.h"
0609b741
PW
28#include "sequencer.h"
29#include "rebase-interactive.h"
f28d40d3
PK
30
31static char const * const builtin_rebase_usage[] = {
32 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
33 "[<upstream>] [<branch>]"),
34 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
35 "--root [<branch>]"),
36 N_("git rebase --continue | --abort | --skip | --edit-todo"),
37 NULL
38};
ac7f467f 39
0609b741
PW
40static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
41static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
ac7f467f
PK
42static GIT_PATH_FUNC(apply_dir, "rebase-apply")
43static GIT_PATH_FUNC(merge_dir, "rebase-merge")
44
45enum rebase_type {
46 REBASE_UNSPECIFIED = -1,
47 REBASE_AM,
48 REBASE_MERGE,
49 REBASE_INTERACTIVE,
50 REBASE_PRESERVE_MERGES
51};
55071ea2 52
ac7f467f
PK
53struct rebase_options {
54 enum rebase_type type;
55 const char *state_dir;
56 struct commit *upstream;
57 const char *upstream_name;
06e4775a 58 const char *upstream_arg;
ac7f467f
PK
59 char *head_name;
60 struct object_id orig_head;
61 struct commit *onto;
62 const char *onto_name;
63 const char *revisions;
e65123a7 64 const char *switch_to;
ac7f467f 65 int root;
9dba809a 66 struct object_id *squash_onto;
ac7f467f
PK
67 struct commit *restrict_revision;
68 int dont_finish_rebase;
b4c8eb02
PK
69 enum {
70 REBASE_NO_QUIET = 1<<0,
bff014da
PK
71 REBASE_VERBOSE = 1<<1,
72 REBASE_DIFFSTAT = 1<<2,
1ed9c14f 73 REBASE_FORCE = 1<<3,
c54dacb5 74 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
b4c8eb02 75 } flags;
f5769680 76 struct argv_array git_am_opts;
f9573628 77 const char *action;
73d51ed0 78 int signoff;
ead98c11 79 int allow_rerere_autoupdate;
002ee2fe 80 int keep_empty;
051910a9 81 int autosquash;
12026a41 82 char *gpg_sign_opt;
6defce2b 83 int autostash;
68e46d78 84 char *cmd;
9b3a448b 85 int allow_empty_message;
3c3588c7 86 int rebase_merges, rebase_cousins;
ba1905a5 87 char *strategy, *strategy_opts;
cda614e4 88 struct strbuf git_format_patch_opt;
d421afa0 89 int reschedule_failed_exec;
d03ebd41 90 int use_legacy_rebase;
ac7f467f
PK
91};
92
73fdc535
PW
93#define REBASE_OPTIONS_INIT { \
94 .type = REBASE_UNSPECIFIED, \
95 .flags = REBASE_NO_QUIET, \
96 .git_am_opts = ARGV_ARRAY_INIT, \
97 .git_format_patch_opt = STRBUF_INIT \
98 }
99
100static struct replay_opts get_replay_opts(const struct rebase_options *opts)
101{
102 struct replay_opts replay = REPLAY_OPTS_INIT;
103
104 replay.action = REPLAY_INTERACTIVE_REBASE;
105 sequencer_init_config(&replay);
106
107 replay.signoff = opts->signoff;
108 replay.allow_ff = !(opts->flags & REBASE_FORCE);
109 if (opts->allow_rerere_autoupdate)
110 replay.allow_rerere_auto = opts->allow_rerere_autoupdate;
111 replay.allow_empty = 1;
112 replay.allow_empty_message = opts->allow_empty_message;
113 replay.verbose = opts->flags & REBASE_VERBOSE;
114 replay.reschedule_failed_exec = opts->reschedule_failed_exec;
115 replay.gpg_sign = xstrdup_or_null(opts->gpg_sign_opt);
116 replay.strategy = opts->strategy;
0ea0847e
PW
117 if (opts->strategy_opts)
118 parse_strategy_opts(&replay, opts->strategy_opts);
73fdc535
PW
119
120 return replay;
121}
122
297b1e17
PW
123enum action {
124 ACTION_NONE = 0,
125 ACTION_CONTINUE,
126 ACTION_SKIP,
127 ACTION_ABORT,
128 ACTION_QUIT,
129 ACTION_EDIT_TODO,
130 ACTION_SHOW_CURRENT_PATCH,
131 ACTION_SHORTEN_OIDS,
132 ACTION_EXPAND_OIDS,
133 ACTION_CHECK_TODO_LIST,
134 ACTION_REARRANGE_SQUASH,
135 ACTION_ADD_EXEC
136};
137
138static const char *action_names[] = { "undefined",
139 "continue",
140 "skip",
141 "abort",
142 "quit",
143 "edit_todo",
144 "show_current_patch" };
145
0609b741
PW
146static int add_exec_commands(struct string_list *commands)
147{
148 const char *todo_file = rebase_path_todo();
149 struct todo_list todo_list = TODO_LIST_INIT;
150 int res;
151
152 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
153 return error_errno(_("could not read '%s'."), todo_file);
154
155 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
156 &todo_list)) {
157 todo_list_release(&todo_list);
158 return error(_("unusable todo list: '%s'"), todo_file);
159 }
160
161 todo_list_add_exec_commands(&todo_list, commands);
162 res = todo_list_write_to_file(the_repository, &todo_list,
163 todo_file, NULL, NULL, -1, 0);
164 todo_list_release(&todo_list);
165
166 if (res)
167 return error_errno(_("could not write '%s'."), todo_file);
168 return 0;
169}
170
171static int rearrange_squash_in_todo_file(void)
172{
173 const char *todo_file = rebase_path_todo();
174 struct todo_list todo_list = TODO_LIST_INIT;
175 int res = 0;
176
177 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
178 return error_errno(_("could not read '%s'."), todo_file);
179 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
180 &todo_list)) {
181 todo_list_release(&todo_list);
182 return error(_("unusable todo list: '%s'"), todo_file);
183 }
184
185 res = todo_list_rearrange_squash(&todo_list);
186 if (!res)
187 res = todo_list_write_to_file(the_repository, &todo_list,
188 todo_file, NULL, NULL, -1, 0);
189
190 todo_list_release(&todo_list);
191
192 if (res)
193 return error_errno(_("could not write '%s'."), todo_file);
194 return 0;
195}
196
197static int transform_todo_file(unsigned flags)
198{
199 const char *todo_file = rebase_path_todo();
200 struct todo_list todo_list = TODO_LIST_INIT;
201 int res;
202
203 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
204 return error_errno(_("could not read '%s'."), todo_file);
205
206 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
207 &todo_list)) {
208 todo_list_release(&todo_list);
209 return error(_("unusable todo list: '%s'"), todo_file);
210 }
211
212 res = todo_list_write_to_file(the_repository, &todo_list, todo_file,
213 NULL, NULL, -1, flags);
214 todo_list_release(&todo_list);
215
216 if (res)
217 return error_errno(_("could not write '%s'."), todo_file);
218 return 0;
219}
220
221static int edit_todo_file(unsigned flags)
222{
223 const char *todo_file = rebase_path_todo();
224 struct todo_list todo_list = TODO_LIST_INIT,
225 new_todo = TODO_LIST_INIT;
226 int res = 0;
227
228 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
229 return error_errno(_("could not read '%s'."), todo_file);
230
231 strbuf_stripspace(&todo_list.buf, 1);
232 res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
233 if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
234 NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
235 res = error_errno(_("could not write '%s'"), todo_file);
236
237 todo_list_release(&todo_list);
238 todo_list_release(&new_todo);
239
240 return res;
241}
242
7d3488eb 243static int get_revision_ranges(struct commit *upstream, struct commit *onto,
0609b741
PW
244 const char **head_hash,
245 char **revisions, char **shortrevisions)
246{
7d3488eb
PW
247 struct commit *base_rev = upstream ? upstream : onto;
248 const char *shorthead;
0609b741
PW
249 struct object_id orig_head;
250
251 if (get_oid("HEAD", &orig_head))
252 return error(_("no HEAD?"));
253
254 *head_hash = find_unique_abbrev(&orig_head, GIT_MAX_HEXSZ);
7d3488eb
PW
255 *revisions = xstrfmt("%s...%s", oid_to_hex(&base_rev->object.oid),
256 *head_hash);
0609b741
PW
257
258 shorthead = find_unique_abbrev(&orig_head, DEFAULT_ABBREV);
259
260 if (upstream) {
261 const char *shortrev;
0609b741 262
7d3488eb
PW
263 shortrev = find_unique_abbrev(&base_rev->object.oid,
264 DEFAULT_ABBREV);
0609b741
PW
265
266 *shortrevisions = xstrfmt("%s..%s", shortrev, shorthead);
267 } else
268 *shortrevisions = xstrdup(shorthead);
269
270 return 0;
271}
272
273static int init_basic_state(struct replay_opts *opts, const char *head_name,
7d3488eb 274 struct commit *onto, const char *orig_head)
0609b741
PW
275{
276 FILE *interactive;
277
c44c2462
PW
278 if (!is_directory(merge_dir()) && mkdir_in_gitdir(merge_dir()))
279 return error_errno(_("could not create temporary %s"), merge_dir());
0609b741
PW
280
281 delete_reflog("REBASE_HEAD");
282
283 interactive = fopen(path_interactive(), "w");
284 if (!interactive)
285 return error_errno(_("could not mark as interactive"));
286 fclose(interactive);
287
288 return write_basic_state(opts, head_name, onto, orig_head);
289}
290
0ea0847e
PW
291static void split_exec_commands(const char *cmd, struct string_list *commands)
292{
293 if (cmd && *cmd) {
294 string_list_split(commands, cmd, '\n', -1);
295
296 /* rebase.c adds a new line to cmd after every command,
297 * so here the last command is always empty */
298 string_list_remove_empty_items(commands, 0);
299 }
300}
301
302static int do_interactive_rebase(struct rebase_options *opts, unsigned flags)
0609b741
PW
303{
304 int ret;
305 const char *head_hash = NULL;
306 char *revisions = NULL, *shortrevisions = NULL;
307 struct argv_array make_script_args = ARGV_ARRAY_INIT;
308 struct todo_list todo_list = TODO_LIST_INIT;
0ea0847e
PW
309 struct replay_opts replay = get_replay_opts(opts);
310 struct string_list commands = STRING_LIST_INIT_DUP;
0609b741 311
0ea0847e
PW
312 if (prepare_branch_to_be_rebased(the_repository, &replay,
313 opts->switch_to))
0609b741
PW
314 return -1;
315
0ea0847e 316 if (get_revision_ranges(opts->upstream, opts->onto, &head_hash,
0609b741
PW
317 &revisions, &shortrevisions))
318 return -1;
319
460bc3ce
PW
320 if (init_basic_state(&replay,
321 opts->head_name ? opts->head_name : "detached HEAD",
322 opts->onto, head_hash)) {
0609b741
PW
323 free(revisions);
324 free(shortrevisions);
325
326 return -1;
327 }
328
0ea0847e 329 if (!opts->upstream && opts->squash_onto)
33898531 330 write_file(path_squash_onto(), "%s\n",
0ea0847e 331 oid_to_hex(opts->squash_onto));
0609b741
PW
332
333 argv_array_pushl(&make_script_args, "", revisions, NULL);
0ea0847e 334 if (opts->restrict_revision)
7d3488eb 335 argv_array_push(&make_script_args,
0ea0847e 336 oid_to_hex(&opts->restrict_revision->object.oid));
0609b741
PW
337
338 ret = sequencer_make_script(the_repository, &todo_list.buf,
339 make_script_args.argc, make_script_args.argv,
340 flags);
341
342 if (ret)
343 error(_("could not generate todo list"));
344 else {
345 discard_cache();
346 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
347 &todo_list))
348 BUG("unusable todo list");
349
0ea0847e
PW
350 split_exec_commands(opts->cmd, &commands);
351 ret = complete_action(the_repository, &replay, flags,
352 shortrevisions, opts->onto_name, opts->onto, head_hash,
353 &commands, opts->autosquash, &todo_list);
0609b741
PW
354 }
355
0ea0847e 356 string_list_clear(&commands, 0);
0609b741
PW
357 free(revisions);
358 free(shortrevisions);
359 todo_list_release(&todo_list);
360 argv_array_clear(&make_script_args);
361
362 return ret;
363}
364
460bc3ce
PW
365static int run_rebase_interactive(struct rebase_options *opts,
366 enum action command)
367{
368 unsigned flags = 0;
369 int abbreviate_commands = 0, ret = 0;
370
371 git_config_get_bool("rebase.abbreviatecommands", &abbreviate_commands);
372
373 flags |= opts->keep_empty ? TODO_LIST_KEEP_EMPTY : 0;
374 flags |= abbreviate_commands ? TODO_LIST_ABBREVIATE_CMDS : 0;
375 flags |= opts->rebase_merges ? TODO_LIST_REBASE_MERGES : 0;
376 flags |= opts->rebase_cousins > 0 ? TODO_LIST_REBASE_COUSINS : 0;
377 flags |= command == ACTION_SHORTEN_OIDS ? TODO_LIST_SHORTEN_IDS : 0;
378
379 switch (command) {
380 case ACTION_NONE: {
381 if (!opts->onto && !opts->upstream)
382 die(_("a base commit must be provided with --upstream or --onto"));
383
384 ret = do_interactive_rebase(opts, flags);
385 break;
386 }
387 case ACTION_SKIP: {
388 struct string_list merge_rr = STRING_LIST_INIT_DUP;
389
390 rerere_clear(the_repository, &merge_rr);
391 }
392 /* fallthrough */
393 case ACTION_CONTINUE: {
394 struct replay_opts replay_opts = get_replay_opts(opts);
395
396 ret = sequencer_continue(the_repository, &replay_opts);
397 break;
398 }
399 case ACTION_EDIT_TODO:
400 ret = edit_todo_file(flags);
401 break;
402 case ACTION_SHOW_CURRENT_PATCH: {
403 struct child_process cmd = CHILD_PROCESS_INIT;
404
405 cmd.git_cmd = 1;
406 argv_array_pushl(&cmd.args, "show", "REBASE_HEAD", "--", NULL);
407 ret = run_command(&cmd);
408
409 break;
410 }
411 case ACTION_SHORTEN_OIDS:
412 case ACTION_EXPAND_OIDS:
413 ret = transform_todo_file(flags);
414 break;
415 case ACTION_CHECK_TODO_LIST:
416 ret = check_todo_list_from_file(the_repository);
417 break;
418 case ACTION_REARRANGE_SQUASH:
419 ret = rearrange_squash_in_todo_file();
420 break;
421 case ACTION_ADD_EXEC: {
422 struct string_list commands = STRING_LIST_INIT_DUP;
423
424 split_exec_commands(opts->cmd, &commands);
425 ret = add_exec_commands(&commands);
426 string_list_clear(&commands, 0);
427 break;
428 }
429 default:
430 BUG("invalid command '%d'", command);
431 }
432
433 return ret;
434}
435
0609b741
PW
436static const char * const builtin_rebase_interactive_usage[] = {
437 N_("git rebase--interactive [<options>]"),
438 NULL
439};
440
441int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
442{
73fdc535 443 struct rebase_options opts = REBASE_OPTIONS_INIT;
33898531 444 struct object_id squash_onto = null_oid;
297b1e17 445 enum action command = ACTION_NONE;
0609b741 446 struct option options[] = {
73fdc535
PW
447 OPT_NEGBIT(0, "ff", &opts.flags, N_("allow fast-forward"),
448 REBASE_FORCE),
449 OPT_BOOL(0, "keep-empty", &opts.keep_empty, N_("keep empty commits")),
0609b741
PW
450 OPT_BOOL(0, "allow-empty-message", &opts.allow_empty_message,
451 N_("allow commits with empty messages")),
73fdc535
PW
452 OPT_BOOL(0, "rebase-merges", &opts.rebase_merges, N_("rebase merge commits")),
453 OPT_BOOL(0, "rebase-cousins", &opts.rebase_cousins,
0609b741 454 N_("keep original branch points of cousins")),
73fdc535 455 OPT_BOOL(0, "autosquash", &opts.autosquash,
0609b741
PW
456 N_("move commits that begin with squash!/fixup!")),
457 OPT_BOOL(0, "signoff", &opts.signoff, N_("sign commits")),
73fdc535
PW
458 OPT_BIT('v', "verbose", &opts.flags,
459 N_("display a diffstat of what changed upstream"),
460 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
0609b741 461 OPT_CMDMODE(0, "continue", &command, N_("continue rebase"),
297b1e17
PW
462 ACTION_CONTINUE),
463 OPT_CMDMODE(0, "skip", &command, N_("skip commit"), ACTION_SKIP),
0609b741 464 OPT_CMDMODE(0, "edit-todo", &command, N_("edit the todo list"),
297b1e17 465 ACTION_EDIT_TODO),
0609b741 466 OPT_CMDMODE(0, "show-current-patch", &command, N_("show the current patch"),
297b1e17 467 ACTION_SHOW_CURRENT_PATCH),
0609b741 468 OPT_CMDMODE(0, "shorten-ids", &command,
297b1e17 469 N_("shorten commit ids in the todo list"), ACTION_SHORTEN_OIDS),
0609b741 470 OPT_CMDMODE(0, "expand-ids", &command,
297b1e17 471 N_("expand commit ids in the todo list"), ACTION_EXPAND_OIDS),
0609b741 472 OPT_CMDMODE(0, "check-todo-list", &command,
297b1e17 473 N_("check the todo list"), ACTION_CHECK_TODO_LIST),
0609b741 474 OPT_CMDMODE(0, "rearrange-squash", &command,
297b1e17 475 N_("rearrange fixup/squash lines"), ACTION_REARRANGE_SQUASH),
0609b741 476 OPT_CMDMODE(0, "add-exec-commands", &command,
297b1e17 477 N_("insert exec commands in todo list"), ACTION_ADD_EXEC),
73fdc535 478 { OPTION_CALLBACK, 0, "onto", &opts.onto, N_("onto"), N_("onto"),
7d3488eb 479 PARSE_OPT_NONEG, parse_opt_commit, 0 },
73fdc535 480 { OPTION_CALLBACK, 0, "restrict-revision", &opts.restrict_revision,
7d3488eb
PW
481 N_("restrict-revision"), N_("restrict revision"),
482 PARSE_OPT_NONEG, parse_opt_commit, 0 },
33898531
PW
483 { OPTION_CALLBACK, 0, "squash-onto", &squash_onto, N_("squash-onto"),
484 N_("squash onto"), PARSE_OPT_NONEG, parse_opt_object_id, 0 },
73fdc535 485 { OPTION_CALLBACK, 0, "upstream", &opts.upstream, N_("upstream"),
7d3488eb
PW
486 N_("the upstream commit"), PARSE_OPT_NONEG, parse_opt_commit,
487 0 },
73fdc535
PW
488 OPT_STRING(0, "head-name", &opts.head_name, N_("head-name"), N_("head name")),
489 { OPTION_STRING, 'S', "gpg-sign", &opts.gpg_sign_opt, N_("key-id"),
0609b741
PW
490 N_("GPG-sign commits"),
491 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
492 OPT_STRING(0, "strategy", &opts.strategy, N_("strategy"),
493 N_("rebase strategy")),
73fdc535 494 OPT_STRING(0, "strategy-opts", &opts.strategy_opts, N_("strategy-opts"),
0609b741 495 N_("strategy options")),
73fdc535 496 OPT_STRING(0, "switch-to", &opts.switch_to, N_("switch-to"),
0609b741 497 N_("the branch or commit to checkout")),
73fdc535
PW
498 OPT_STRING(0, "onto-name", &opts.onto_name, N_("onto-name"), N_("onto name")),
499 OPT_STRING(0, "cmd", &opts.cmd, N_("cmd"), N_("the command to run")),
500 OPT_RERERE_AUTOUPDATE(&opts.allow_rerere_autoupdate),
0609b741
PW
501 OPT_BOOL(0, "reschedule-failed-exec", &opts.reschedule_failed_exec,
502 N_("automatically re-schedule any `exec` that fails")),
503 OPT_END()
504 };
505
73fdc535 506 opts.rebase_cousins = -1;
0609b741 507
0609b741
PW
508 if (argc == 1)
509 usage_with_options(builtin_rebase_interactive_usage, options);
510
511 argc = parse_options(argc, argv, NULL, options,
512 builtin_rebase_interactive_usage, PARSE_OPT_KEEP_ARGV0);
513
33898531 514 if (!is_null_oid(&squash_onto))
73fdc535 515 opts.squash_onto = &squash_onto;
33898531 516
73fdc535 517 if (opts.rebase_cousins >= 0 && !opts.rebase_merges)
0609b741
PW
518 warning(_("--[no-]rebase-cousins has no effect without "
519 "--rebase-merges"));
520
460bc3ce 521 return !!run_rebase_interactive(&opts, command);
0609b741
PW
522}
523
9a48a615
PK
524static int is_interactive(struct rebase_options *opts)
525{
526 return opts->type == REBASE_INTERACTIVE ||
527 opts->type == REBASE_PRESERVE_MERGES;
528}
529
002ee2fe
PK
530static void imply_interactive(struct rebase_options *opts, const char *option)
531{
532 switch (opts->type) {
533 case REBASE_AM:
534 die(_("%s requires an interactive rebase"), option);
535 break;
536 case REBASE_INTERACTIVE:
537 case REBASE_PRESERVE_MERGES:
538 break;
539 case REBASE_MERGE:
68aa495b 540 /* we now implement --merge via --interactive */
002ee2fe
PK
541 default:
542 opts->type = REBASE_INTERACTIVE; /* implied */
543 break;
544 }
545}
546
ac7f467f
PK
547/* Returns the filename prefixed by the state_dir */
548static const char *state_dir_path(const char *filename, struct rebase_options *opts)
549{
550 static struct strbuf path = STRBUF_INIT;
551 static size_t prefix_len;
552
553 if (!prefix_len) {
554 strbuf_addf(&path, "%s/", opts->state_dir);
555 prefix_len = path.len;
556 }
557
558 strbuf_setlen(&path, prefix_len);
559 strbuf_addstr(&path, filename);
560 return path.buf;
561}
562
f9573628
PK
563/* Read one file, then strip line endings */
564static int read_one(const char *path, struct strbuf *buf)
565{
566 if (strbuf_read_file(buf, path, 0) < 0)
567 return error_errno(_("could not read '%s'"), path);
568 strbuf_trim_trailing_newline(buf);
569 return 0;
570}
571
572/* Initialize the rebase options from the state directory. */
573static int read_basic_state(struct rebase_options *opts)
574{
575 struct strbuf head_name = STRBUF_INIT;
576 struct strbuf buf = STRBUF_INIT;
577 struct object_id oid;
578
579 if (read_one(state_dir_path("head-name", opts), &head_name) ||
580 read_one(state_dir_path("onto", opts), &buf))
581 return -1;
582 opts->head_name = starts_with(head_name.buf, "refs/") ?
583 xstrdup(head_name.buf) : NULL;
584 strbuf_release(&head_name);
585 if (get_oid(buf.buf, &oid))
586 return error(_("could not get 'onto': '%s'"), buf.buf);
587 opts->onto = lookup_commit_or_die(&oid, buf.buf);
588
589 /*
590 * We always write to orig-head, but interactive rebase used to write to
591 * head. Fall back to reading from head to cover for the case that the
592 * user upgraded git with an ongoing interactive rebase.
593 */
594 strbuf_reset(&buf);
595 if (file_exists(state_dir_path("orig-head", opts))) {
596 if (read_one(state_dir_path("orig-head", opts), &buf))
597 return -1;
598 } else if (read_one(state_dir_path("head", opts), &buf))
599 return -1;
600 if (get_oid(buf.buf, &opts->orig_head))
601 return error(_("invalid orig-head: '%s'"), buf.buf);
602
899b49c4 603 if (file_exists(state_dir_path("quiet", opts)))
f9573628
PK
604 opts->flags &= ~REBASE_NO_QUIET;
605 else
606 opts->flags |= REBASE_NO_QUIET;
607
608 if (file_exists(state_dir_path("verbose", opts)))
609 opts->flags |= REBASE_VERBOSE;
610
73d51ed0
PK
611 if (file_exists(state_dir_path("signoff", opts))) {
612 opts->signoff = 1;
613 opts->flags |= REBASE_FORCE;
614 }
615
ead98c11
PK
616 if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
617 strbuf_reset(&buf);
618 if (read_one(state_dir_path("allow_rerere_autoupdate", opts),
619 &buf))
620 return -1;
621 if (!strcmp(buf.buf, "--rerere-autoupdate"))
6023c928 622 opts->allow_rerere_autoupdate = RERERE_AUTOUPDATE;
ead98c11 623 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
6023c928 624 opts->allow_rerere_autoupdate = RERERE_NOAUTOUPDATE;
ead98c11
PK
625 else
626 warning(_("ignoring invalid allow_rerere_autoupdate: "
627 "'%s'"), buf.buf);
6023c928 628 }
ead98c11 629
12026a41
PK
630 if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
631 strbuf_reset(&buf);
632 if (read_one(state_dir_path("gpg_sign_opt", opts),
633 &buf))
634 return -1;
635 free(opts->gpg_sign_opt);
636 opts->gpg_sign_opt = xstrdup(buf.buf);
637 }
638
ba1905a5
PK
639 if (file_exists(state_dir_path("strategy", opts))) {
640 strbuf_reset(&buf);
641 if (read_one(state_dir_path("strategy", opts), &buf))
642 return -1;
643 free(opts->strategy);
644 opts->strategy = xstrdup(buf.buf);
645 }
646
647 if (file_exists(state_dir_path("strategy_opts", opts))) {
648 strbuf_reset(&buf);
649 if (read_one(state_dir_path("strategy_opts", opts), &buf))
650 return -1;
651 free(opts->strategy_opts);
652 opts->strategy_opts = xstrdup(buf.buf);
653 }
654
f9573628
PK
655 strbuf_release(&buf);
656
657 return 0;
658}
659
28dc09de 660static int rebase_write_basic_state(struct rebase_options *opts)
21853626
JS
661{
662 write_file(state_dir_path("head-name", opts), "%s",
663 opts->head_name ? opts->head_name : "detached HEAD");
664 write_file(state_dir_path("onto", opts), "%s",
665 opts->onto ? oid_to_hex(&opts->onto->object.oid) : "");
666 write_file(state_dir_path("orig-head", opts), "%s",
667 oid_to_hex(&opts->orig_head));
668 write_file(state_dir_path("quiet", opts), "%s",
669 opts->flags & REBASE_NO_QUIET ? "" : "t");
670 if (opts->flags & REBASE_VERBOSE)
671 write_file(state_dir_path("verbose", opts), "%s", "");
672 if (opts->strategy)
673 write_file(state_dir_path("strategy", opts), "%s",
674 opts->strategy);
675 if (opts->strategy_opts)
676 write_file(state_dir_path("strategy_opts", opts), "%s",
677 opts->strategy_opts);
6023c928 678 if (opts->allow_rerere_autoupdate > 0)
21853626
JS
679 write_file(state_dir_path("allow_rerere_autoupdate", opts),
680 "-%s-rerere-autoupdate",
6023c928
PW
681 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
682 "" : "-no");
21853626
JS
683 if (opts->gpg_sign_opt)
684 write_file(state_dir_path("gpg_sign_opt", opts), "%s",
685 opts->gpg_sign_opt);
686 if (opts->signoff)
687 write_file(state_dir_path("strategy", opts), "--signoff");
688
689 return 0;
690}
691
6defce2b
PK
692static int apply_autostash(struct rebase_options *opts)
693{
694 const char *path = state_dir_path("autostash", opts);
695 struct strbuf autostash = STRBUF_INIT;
696 struct child_process stash_apply = CHILD_PROCESS_INIT;
697
698 if (!file_exists(path))
699 return 0;
700
71064e60 701 if (read_one(path, &autostash))
6defce2b 702 return error(_("Could not read '%s'"), path);
b98e914e
JS
703 /* Ensure that the hash is not mistaken for a number */
704 strbuf_addstr(&autostash, "^0");
6defce2b
PK
705 argv_array_pushl(&stash_apply.args,
706 "stash", "apply", autostash.buf, NULL);
707 stash_apply.git_cmd = 1;
708 stash_apply.no_stderr = stash_apply.no_stdout =
709 stash_apply.no_stdin = 1;
710 if (!run_command(&stash_apply))
711 printf(_("Applied autostash.\n"));
712 else {
713 struct argv_array args = ARGV_ARRAY_INIT;
714 int res = 0;
715
716 argv_array_pushl(&args,
717 "stash", "store", "-m", "autostash", "-q",
718 autostash.buf, NULL);
719 if (run_command_v_opt(args.argv, RUN_GIT_CMD))
720 res = error(_("Cannot store %s"), autostash.buf);
721 argv_array_clear(&args);
722 strbuf_release(&autostash);
723 if (res)
724 return res;
725
726 fprintf(stderr,
727 _("Applying autostash resulted in conflicts.\n"
728 "Your changes are safe in the stash.\n"
729 "You can run \"git stash pop\" or \"git stash drop\" "
730 "at any time.\n"));
731 }
732
733 strbuf_release(&autostash);
734 return 0;
735}
736
ac7f467f
PK
737static int finish_rebase(struct rebase_options *opts)
738{
739 struct strbuf dir = STRBUF_INIT;
740 const char *argv_gc_auto[] = { "gc", "--auto", NULL };
741
742 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
6defce2b 743 apply_autostash(opts);
ac7f467f
PK
744 close_all_packs(the_repository->objects);
745 /*
746 * We ignore errors in 'gc --auto', since the
747 * user should see them.
748 */
749 run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
750 strbuf_addstr(&dir, opts->state_dir);
751 remove_dir_recursively(&dir, 0);
752 strbuf_release(&dir);
753
754 return 0;
755}
756
757static struct commit *peel_committish(const char *name)
758{
759 struct object *obj;
760 struct object_id oid;
761
762 if (get_oid(name, &oid))
763 return NULL;
764 obj = parse_object(the_repository, &oid);
765 return (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
766}
767
768static void add_var(struct strbuf *buf, const char *name, const char *value)
769{
770 if (!value)
771 strbuf_addf(buf, "unset %s; ", name);
772 else {
773 strbuf_addf(buf, "%s=", name);
774 sq_quote_buf(buf, value);
775 strbuf_addstr(buf, "; ");
776 }
777}
778
c5233708
JS
779#define GIT_REFLOG_ACTION_ENVIRONMENT "GIT_REFLOG_ACTION"
780
781#define RESET_HEAD_DETACH (1<<0)
782#define RESET_HEAD_HARD (1<<1)
e52c6bbd
JH
783#define RESET_HEAD_RUN_POST_CHECKOUT_HOOK (1<<2)
784#define RESET_HEAD_REFS_ONLY (1<<3)
9fbcc3d2 785#define RESET_ORIG_HEAD (1<<4)
c5233708
JS
786
787static int reset_head(struct object_id *oid, const char *action,
788 const char *switch_to_branch, unsigned flags,
789 const char *reflog_orig_head, const char *reflog_head)
790{
791 unsigned detach_head = flags & RESET_HEAD_DETACH;
792 unsigned reset_hard = flags & RESET_HEAD_HARD;
e52c6bbd 793 unsigned run_hook = flags & RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
414f3360 794 unsigned refs_only = flags & RESET_HEAD_REFS_ONLY;
cbd29ead 795 unsigned update_orig_head = flags & RESET_ORIG_HEAD;
c5233708
JS
796 struct object_id head_oid;
797 struct tree_desc desc[2] = { { NULL }, { NULL } };
798 struct lock_file lock = LOCK_INIT;
799 struct unpack_trees_options unpack_tree_opts;
800 struct tree *tree;
801 const char *reflog_action;
802 struct strbuf msg = STRBUF_INIT;
803 size_t prefix_len;
804 struct object_id *orig = NULL, oid_orig,
805 *old_orig = NULL, oid_old_orig;
806 int ret = 0, nr = 0;
807
808 if (switch_to_branch && !starts_with(switch_to_branch, "refs/"))
809 BUG("Not a fully qualified branch: '%s'", switch_to_branch);
810
414f3360 811 if (!refs_only && hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0) {
c5233708
JS
812 ret = -1;
813 goto leave_reset_head;
814 }
815
816 if ((!oid || !reset_hard) && get_oid("HEAD", &head_oid)) {
817 ret = error(_("could not determine HEAD revision"));
818 goto leave_reset_head;
819 }
820
821 if (!oid)
822 oid = &head_oid;
823
414f3360
JS
824 if (refs_only)
825 goto reset_head_refs;
826
c5233708
JS
827 memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
828 setup_unpack_trees_porcelain(&unpack_tree_opts, action);
829 unpack_tree_opts.head_idx = 1;
830 unpack_tree_opts.src_index = the_repository->index;
831 unpack_tree_opts.dst_index = the_repository->index;
832 unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
833 unpack_tree_opts.update = 1;
834 unpack_tree_opts.merge = 1;
835 if (!detach_head)
836 unpack_tree_opts.reset = 1;
837
7589e636 838 if (repo_read_index_unmerged(the_repository) < 0) {
c5233708
JS
839 ret = error(_("could not read index"));
840 goto leave_reset_head;
841 }
842
843 if (!reset_hard && !fill_tree_descriptor(&desc[nr++], &head_oid)) {
844 ret = error(_("failed to find tree of %s"),
845 oid_to_hex(&head_oid));
846 goto leave_reset_head;
847 }
848
849 if (!fill_tree_descriptor(&desc[nr++], oid)) {
850 ret = error(_("failed to find tree of %s"), oid_to_hex(oid));
851 goto leave_reset_head;
852 }
853
854 if (unpack_trees(nr, desc, &unpack_tree_opts)) {
855 ret = -1;
856 goto leave_reset_head;
857 }
858
859 tree = parse_tree_indirect(oid);
e52c6bbd 860 prime_cache_tree(the_repository, the_repository->index, tree);
c5233708
JS
861
862 if (write_locked_index(the_repository->index, &lock, COMMIT_LOCK) < 0) {
863 ret = error(_("could not write index"));
864 goto leave_reset_head;
865 }
866
414f3360 867reset_head_refs:
c5233708
JS
868 reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
869 strbuf_addf(&msg, "%s: ", reflog_action ? reflog_action : "rebase");
870 prefix_len = msg.len;
871
cbd29ead
JS
872 if (update_orig_head) {
873 if (!get_oid("ORIG_HEAD", &oid_old_orig))
874 old_orig = &oid_old_orig;
875 if (!get_oid("HEAD", &oid_orig)) {
876 orig = &oid_orig;
877 if (!reflog_orig_head) {
878 strbuf_addstr(&msg, "updating ORIG_HEAD");
879 reflog_orig_head = msg.buf;
880 }
881 update_ref(reflog_orig_head, "ORIG_HEAD", orig,
882 old_orig, 0, UPDATE_REFS_MSG_ON_ERR);
883 } else if (old_orig)
884 delete_ref(NULL, "ORIG_HEAD", old_orig, 0);
885 }
886
c5233708
JS
887 if (!reflog_head) {
888 strbuf_setlen(&msg, prefix_len);
889 strbuf_addstr(&msg, "updating HEAD");
890 reflog_head = msg.buf;
891 }
892 if (!switch_to_branch)
893 ret = update_ref(reflog_head, "HEAD", oid, orig,
894 detach_head ? REF_NO_DEREF : 0,
895 UPDATE_REFS_MSG_ON_ERR);
896 else {
eaf81605 897 ret = update_ref(reflog_head, switch_to_branch, oid,
5b2237a8 898 NULL, 0, UPDATE_REFS_MSG_ON_ERR);
c5233708 899 if (!ret)
5b2237a8
JS
900 ret = create_symref("HEAD", switch_to_branch,
901 reflog_head);
c5233708 902 }
e52c6bbd
JH
903 if (run_hook)
904 run_hook_le(NULL, "post-checkout",
905 oid_to_hex(orig ? orig : &null_oid),
906 oid_to_hex(oid), "1", NULL);
c5233708
JS
907
908leave_reset_head:
909 strbuf_release(&msg);
910 rollback_lock_file(&lock);
911 while (nr)
912 free((void *)desc[--nr].buffer);
913 return ret;
914}
915
21853626
JS
916static int move_to_original_branch(struct rebase_options *opts)
917{
918 struct strbuf orig_head_reflog = STRBUF_INIT, head_reflog = STRBUF_INIT;
919 int ret;
920
921 if (!opts->head_name)
922 return 0; /* nothing to move back to */
923
924 if (!opts->onto)
925 BUG("move_to_original_branch without onto");
926
927 strbuf_addf(&orig_head_reflog, "rebase finished: %s onto %s",
928 opts->head_name, oid_to_hex(&opts->onto->object.oid));
929 strbuf_addf(&head_reflog, "rebase finished: returning to %s",
930 opts->head_name);
931 ret = reset_head(NULL, "", opts->head_name, RESET_HEAD_REFS_ONLY,
932 orig_head_reflog.buf, head_reflog.buf);
933
934 strbuf_release(&orig_head_reflog);
935 strbuf_release(&head_reflog);
936 return ret;
937}
938
bc24382c
JS
939static const char *resolvemsg =
940N_("Resolve all conflicts manually, mark them as resolved with\n"
941"\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
942"You can instead skip this commit: run \"git rebase --skip\".\n"
943"To abort and get back to the state before \"git rebase\", run "
944"\"git rebase --abort\".");
945
21853626
JS
946static int run_am(struct rebase_options *opts)
947{
948 struct child_process am = CHILD_PROCESS_INIT;
949 struct child_process format_patch = CHILD_PROCESS_INIT;
950 struct strbuf revisions = STRBUF_INIT;
951 int status;
952 char *rebased_patches;
953
954 am.git_cmd = 1;
955 argv_array_push(&am.args, "am");
956
957 if (opts->action && !strcmp("continue", opts->action)) {
958 argv_array_push(&am.args, "--resolved");
959 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
960 if (opts->gpg_sign_opt)
961 argv_array_push(&am.args, opts->gpg_sign_opt);
962 status = run_command(&am);
963 if (status)
964 return status;
965
966 return move_to_original_branch(opts);
967 }
968 if (opts->action && !strcmp("skip", opts->action)) {
969 argv_array_push(&am.args, "--skip");
970 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
971 status = run_command(&am);
972 if (status)
973 return status;
974
975 return move_to_original_branch(opts);
976 }
977 if (opts->action && !strcmp("show-current-patch", opts->action)) {
978 argv_array_push(&am.args, "--show-current-patch");
979 return run_command(&am);
980 }
981
982 strbuf_addf(&revisions, "%s...%s",
983 oid_to_hex(opts->root ?
984 /* this is now equivalent to !opts->upstream */
985 &opts->onto->object.oid :
986 &opts->upstream->object.oid),
987 oid_to_hex(&opts->orig_head));
988
989 rebased_patches = xstrdup(git_path("rebased-patches"));
990 format_patch.out = open(rebased_patches,
991 O_WRONLY | O_CREAT | O_TRUNC, 0666);
992 if (format_patch.out < 0) {
993 status = error_errno(_("could not open '%s' for writing"),
994 rebased_patches);
995 free(rebased_patches);
996 argv_array_clear(&am.args);
997 return status;
998 }
999
1000 format_patch.git_cmd = 1;
1001 argv_array_pushl(&format_patch.args, "format-patch", "-k", "--stdout",
1002 "--full-index", "--cherry-pick", "--right-only",
1003 "--src-prefix=a/", "--dst-prefix=b/", "--no-renames",
e52c6bbd 1004 "--no-cover-letter", "--pretty=mboxrd", "--topo-order", NULL);
21853626
JS
1005 if (opts->git_format_patch_opt.len)
1006 argv_array_split(&format_patch.args,
1007 opts->git_format_patch_opt.buf);
1008 argv_array_push(&format_patch.args, revisions.buf);
1009 if (opts->restrict_revision)
1010 argv_array_pushf(&format_patch.args, "^%s",
1011 oid_to_hex(&opts->restrict_revision->object.oid));
1012
1013 status = run_command(&format_patch);
1014 if (status) {
1015 unlink(rebased_patches);
1016 free(rebased_patches);
1017 argv_array_clear(&am.args);
1018
1019 reset_head(&opts->orig_head, "checkout", opts->head_name, 0,
1020 "HEAD", NULL);
1021 error(_("\ngit encountered an error while preparing the "
1022 "patches to replay\n"
1023 "these revisions:\n"
1024 "\n %s\n\n"
1025 "As a result, git cannot rebase them."),
1026 opts->revisions);
1027
1028 strbuf_release(&revisions);
1029 return status;
1030 }
1031 strbuf_release(&revisions);
1032
1033 am.in = open(rebased_patches, O_RDONLY);
1034 if (am.in < 0) {
1035 status = error_errno(_("could not open '%s' for reading"),
1036 rebased_patches);
1037 free(rebased_patches);
1038 argv_array_clear(&am.args);
1039 return status;
1040 }
1041
1042 argv_array_pushv(&am.args, opts->git_am_opts.argv);
1043 argv_array_push(&am.args, "--rebasing");
1044 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
1045 argv_array_push(&am.args, "--patch-format=mboxrd");
6023c928 1046 if (opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE)
21853626 1047 argv_array_push(&am.args, "--rerere-autoupdate");
6023c928 1048 else if (opts->allow_rerere_autoupdate == RERERE_NOAUTOUPDATE)
21853626
JS
1049 argv_array_push(&am.args, "--no-rerere-autoupdate");
1050 if (opts->gpg_sign_opt)
1051 argv_array_push(&am.args, opts->gpg_sign_opt);
1052 status = run_command(&am);
1053 unlink(rebased_patches);
1054 free(rebased_patches);
1055
1056 if (!status) {
1057 return move_to_original_branch(opts);
1058 }
1059
1060 if (is_directory(opts->state_dir))
28dc09de 1061 rebase_write_basic_state(opts);
21853626
JS
1062
1063 return status;
1064}
1065
460bc3ce 1066static int run_specific_rebase(struct rebase_options *opts, enum action action)
ac7f467f
PK
1067{
1068 const char *argv[] = { NULL, NULL };
f5769680 1069 struct strbuf script_snippet = STRBUF_INIT, buf = STRBUF_INIT;
ac7f467f
PK
1070 int status;
1071 const char *backend, *backend_func;
1072
bc24382c
JS
1073 if (opts->type == REBASE_INTERACTIVE) {
1074 /* Run builtin interactive rebase */
460bc3ce 1075 setenv("GIT_CHERRY_PICK_HELP", resolvemsg, 1);
bc24382c 1076 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
460bc3ce 1077 setenv("GIT_SEQUENCE_EDITOR", ":", 1);
bc24382c
JS
1078 opts->autosquash = 0;
1079 }
460bc3ce
PW
1080 if (opts->gpg_sign_opt) {
1081 /* remove the leading "-S" */
1082 char *tmp = xstrdup(opts->gpg_sign_opt + 2);
1083 free(opts->gpg_sign_opt);
1084 opts->gpg_sign_opt = tmp;
1085 }
bc24382c 1086
460bc3ce 1087 status = run_rebase_interactive(opts, action);
bc24382c
JS
1088 goto finished_rebase;
1089 }
1090
21853626
JS
1091 if (opts->type == REBASE_AM) {
1092 status = run_am(opts);
1093 goto finished_rebase;
1094 }
1095
ac7f467f
PK
1096 add_var(&script_snippet, "GIT_DIR", absolute_path(get_git_dir()));
1097 add_var(&script_snippet, "state_dir", opts->state_dir);
1098
1099 add_var(&script_snippet, "upstream_name", opts->upstream_name);
f9573628
PK
1100 add_var(&script_snippet, "upstream", opts->upstream ?
1101 oid_to_hex(&opts->upstream->object.oid) : NULL);
d4c569f8
PK
1102 add_var(&script_snippet, "head_name",
1103 opts->head_name ? opts->head_name : "detached HEAD");
ac7f467f 1104 add_var(&script_snippet, "orig_head", oid_to_hex(&opts->orig_head));
f9573628
PK
1105 add_var(&script_snippet, "onto", opts->onto ?
1106 oid_to_hex(&opts->onto->object.oid) : NULL);
ac7f467f
PK
1107 add_var(&script_snippet, "onto_name", opts->onto_name);
1108 add_var(&script_snippet, "revisions", opts->revisions);
1109 add_var(&script_snippet, "restrict_revision", opts->restrict_revision ?
1110 oid_to_hex(&opts->restrict_revision->object.oid) : NULL);
b4c8eb02
PK
1111 add_var(&script_snippet, "GIT_QUIET",
1112 opts->flags & REBASE_NO_QUIET ? "" : "t");
f5769680
JS
1113 sq_quote_argv_pretty(&buf, opts->git_am_opts.argv);
1114 add_var(&script_snippet, "git_am_opt", buf.buf);
1115 strbuf_release(&buf);
bff014da
PK
1116 add_var(&script_snippet, "verbose",
1117 opts->flags & REBASE_VERBOSE ? "t" : "");
1118 add_var(&script_snippet, "diffstat",
1119 opts->flags & REBASE_DIFFSTAT ? "t" : "");
1ed9c14f
PK
1120 add_var(&script_snippet, "force_rebase",
1121 opts->flags & REBASE_FORCE ? "t" : "");
e65123a7
PK
1122 if (opts->switch_to)
1123 add_var(&script_snippet, "switch_to", opts->switch_to);
f9573628 1124 add_var(&script_snippet, "action", opts->action ? opts->action : "");
73d51ed0 1125 add_var(&script_snippet, "signoff", opts->signoff ? "--signoff" : "");
ead98c11 1126 add_var(&script_snippet, "allow_rerere_autoupdate",
ead98c11 1127 opts->allow_rerere_autoupdate ?
6023c928
PW
1128 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
1129 "--rerere-autoupdate" : "--no-rerere-autoupdate" : "");
002ee2fe 1130 add_var(&script_snippet, "keep_empty", opts->keep_empty ? "yes" : "");
051910a9 1131 add_var(&script_snippet, "autosquash", opts->autosquash ? "t" : "");
12026a41 1132 add_var(&script_snippet, "gpg_sign_opt", opts->gpg_sign_opt);
68e46d78 1133 add_var(&script_snippet, "cmd", opts->cmd);
9b3a448b
PK
1134 add_var(&script_snippet, "allow_empty_message",
1135 opts->allow_empty_message ? "--allow-empty-message" : "");
3c3588c7
PK
1136 add_var(&script_snippet, "rebase_merges",
1137 opts->rebase_merges ? "t" : "");
1138 add_var(&script_snippet, "rebase_cousins",
1139 opts->rebase_cousins ? "t" : "");
ba1905a5
PK
1140 add_var(&script_snippet, "strategy", opts->strategy);
1141 add_var(&script_snippet, "strategy_opts", opts->strategy_opts);
9dba809a
PK
1142 add_var(&script_snippet, "rebase_root", opts->root ? "t" : "");
1143 add_var(&script_snippet, "squash_onto",
1144 opts->squash_onto ? oid_to_hex(opts->squash_onto) : "");
cda614e4
PK
1145 add_var(&script_snippet, "git_format_patch_opt",
1146 opts->git_format_patch_opt.buf);
ac7f467f 1147
3dba9d08
PK
1148 if (is_interactive(opts) &&
1149 !(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
1150 strbuf_addstr(&script_snippet,
891d4a03 1151 "GIT_SEQUENCE_EDITOR=:; export GIT_SEQUENCE_EDITOR; ");
3dba9d08
PK
1152 opts->autosquash = 0;
1153 }
ac7f467f
PK
1154
1155 switch (opts->type) {
ac7f467f
PK
1156 case REBASE_PRESERVE_MERGES:
1157 backend = "git-rebase--preserve-merges";
1158 backend_func = "git_rebase__preserve_merges";
1159 break;
1160 default:
1161 BUG("Unhandled rebase type %d", opts->type);
1162 break;
1163 }
1164
1165 strbuf_addf(&script_snippet,
1166 ". git-sh-setup && . git-rebase--common &&"
1167 " . %s && %s", backend, backend_func);
1168 argv[0] = script_snippet.buf;
1169
1170 status = run_command_v_opt(argv, RUN_USING_SHELL);
bc24382c 1171finished_rebase:
ac7f467f
PK
1172 if (opts->dont_finish_rebase)
1173 ; /* do nothing */
bc24382c
JS
1174 else if (opts->type == REBASE_INTERACTIVE)
1175 ; /* interactive rebase cleans up after itself */
ac7f467f
PK
1176 else if (status == 0) {
1177 if (!file_exists(state_dir_path("stopped-sha", opts)))
1178 finish_rebase(opts);
1179 } else if (status == 2) {
1180 struct strbuf dir = STRBUF_INIT;
1181
6defce2b 1182 apply_autostash(opts);
ac7f467f
PK
1183 strbuf_addstr(&dir, opts->state_dir);
1184 remove_dir_recursively(&dir, 0);
1185 strbuf_release(&dir);
1186 die("Nothing to do");
1187 }
1188
1189 strbuf_release(&script_snippet);
1190
1191 return status ? -1 : 0;
1192}
1193
bff014da
PK
1194static int rebase_config(const char *var, const char *value, void *data)
1195{
1196 struct rebase_options *opts = data;
1197
1198 if (!strcmp(var, "rebase.stat")) {
1199 if (git_config_bool(var, value))
1200 opts->flags |= REBASE_DIFFSTAT;
1201 else
1202 opts->flags &= !REBASE_DIFFSTAT;
1203 return 0;
1204 }
1205
051910a9
PK
1206 if (!strcmp(var, "rebase.autosquash")) {
1207 opts->autosquash = git_config_bool(var, value);
1208 return 0;
1209 }
1210
12026a41
PK
1211 if (!strcmp(var, "commit.gpgsign")) {
1212 free(opts->gpg_sign_opt);
1213 opts->gpg_sign_opt = git_config_bool(var, value) ?
1214 xstrdup("-S") : NULL;
1215 return 0;
1216 }
1217
6defce2b
PK
1218 if (!strcmp(var, "rebase.autostash")) {
1219 opts->autostash = git_config_bool(var, value);
1220 return 0;
1221 }
1222
969de3ff
JS
1223 if (!strcmp(var, "rebase.reschedulefailedexec")) {
1224 opts->reschedule_failed_exec = git_config_bool(var, value);
1225 return 0;
1226 }
1227
d03ebd41
ÆAB
1228 if (!strcmp(var, "rebase.usebuiltin")) {
1229 opts->use_legacy_rebase = !git_config_bool(var, value);
1230 return 0;
1231 }
1232
bff014da
PK
1233 return git_default_config(var, value, data);
1234}
1235
9a48a615
PK
1236/*
1237 * Determines whether the commits in from..to are linear, i.e. contain
1238 * no merge commits. This function *expects* `from` to be an ancestor of
1239 * `to`.
1240 */
1241static int is_linear_history(struct commit *from, struct commit *to)
1242{
1243 while (to && to != from) {
1244 parse_commit(to);
1245 if (!to->parents)
1246 return 1;
1247 if (to->parents->next)
1248 return 0;
1249 to = to->parents->item;
1250 }
1251 return 1;
1252}
1253
1254static int can_fast_forward(struct commit *onto, struct object_id *head_oid,
1255 struct object_id *merge_base)
1256{
1257 struct commit *head = lookup_commit(the_repository, head_oid);
1258 struct commit_list *merge_bases;
1259 int res;
1260
1261 if (!head)
1262 return 0;
1263
1264 merge_bases = get_merge_bases(onto, head);
1265 if (merge_bases && !merge_bases->next) {
1266 oidcpy(merge_base, &merge_bases->item->object.oid);
b17ca8f9 1267 res = oideq(merge_base, &onto->object.oid);
9a48a615
PK
1268 } else {
1269 oidcpy(merge_base, &null_oid);
1270 res = 0;
1271 }
1272 free_commit_list(merge_bases);
1273 return res && is_linear_history(onto, head);
1274}
1275
361badd3
PK
1276/* -i followed by -m is still -i */
1277static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
1278{
1279 struct rebase_options *opts = opt->value;
1280
517fe807
JK
1281 BUG_ON_OPT_NEG(unset);
1282 BUG_ON_OPT_ARG(arg);
1283
361badd3
PK
1284 if (!is_interactive(opts))
1285 opts->type = REBASE_MERGE;
1286
1287 return 0;
1288}
1289
1290/* -i followed by -p is still explicitly interactive, but -p alone is not */
1291static int parse_opt_interactive(const struct option *opt, const char *arg,
1292 int unset)
1293{
1294 struct rebase_options *opts = opt->value;
1295
517fe807
JK
1296 BUG_ON_OPT_NEG(unset);
1297 BUG_ON_OPT_ARG(arg);
1298
361badd3
PK
1299 opts->type = REBASE_INTERACTIVE;
1300 opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
1301
1302 return 0;
1303}
1304
8f5986d9
PK
1305static void NORETURN error_on_missing_default_upstream(void)
1306{
1307 struct branch *current_branch = branch_get(NULL);
1308
1309 printf(_("%s\n"
1310 "Please specify which branch you want to rebase against.\n"
1311 "See git-rebase(1) for details.\n"
1312 "\n"
1313 " git rebase '<branch>'\n"
1314 "\n"),
1315 current_branch ? _("There is no tracking information for "
1316 "the current branch.") :
1317 _("You are not currently on a branch."));
1318
1319 if (current_branch) {
1320 const char *remote = current_branch->remote_name;
1321
1322 if (!remote)
1323 remote = _("<remote>");
1324
1325 printf(_("If you wish to set tracking information for this "
1326 "branch you can do so with:\n"
1327 "\n"
1328 " git branch --set-upstream-to=%s/<branch> %s\n"
1329 "\n"),
1330 remote, current_branch->name);
1331 }
1332 exit(1);
1333}
1334
13a5a9f0
JS
1335static void set_reflog_action(struct rebase_options *options)
1336{
1337 const char *env;
1338 struct strbuf buf = STRBUF_INIT;
1339
1340 if (!is_interactive(options))
1341 return;
1342
1343 env = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
1344 if (env && strcmp("rebase", env))
1345 return; /* only override it if it is "rebase" */
1346
1347 strbuf_addf(&buf, "rebase -i (%s)", options->action);
1348 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, buf.buf, 1);
1349 strbuf_release(&buf);
1350}
1351
c762aada
PW
1352static int check_exec_cmd(const char *cmd)
1353{
1354 if (strchr(cmd, '\n'))
1355 return error(_("exec commands cannot contain newlines"));
1356
1357 /* Does the command consist purely of whitespace? */
1358 if (!cmd[strspn(cmd, " \t\r\f\v")])
1359 return error(_("empty exec command"));
1360
1361 return 0;
1362}
1363
1364
55071ea2
PK
1365int cmd_rebase(int argc, const char **argv, const char *prefix)
1366{
73fdc535 1367 struct rebase_options options = REBASE_OPTIONS_INIT;
ac7f467f 1368 const char *branch_name;
f9573628 1369 int ret, flags, total_argc, in_progress = 0;
06e4775a 1370 int ok_to_skip_pre_rebase = 0;
ac7f467f
PK
1371 struct strbuf msg = STRBUF_INIT;
1372 struct strbuf revisions = STRBUF_INIT;
c54dacb5 1373 struct strbuf buf = STRBUF_INIT;
075bc852 1374 struct object_id merge_base;
297b1e17 1375 enum action action = ACTION_NONE;
12026a41 1376 const char *gpg_sign = NULL;
68e46d78 1377 struct string_list exec = STRING_LIST_INIT_NODUP;
3c3588c7 1378 const char *rebase_merges = NULL;
92d0d74e 1379 int fork_point = -1;
ba1905a5 1380 struct string_list strategy_options = STRING_LIST_INIT_NODUP;
9dba809a
PK
1381 struct object_id squash_onto;
1382 char *squash_onto_name = NULL;
f28d40d3
PK
1383 struct option builtin_rebase_options[] = {
1384 OPT_STRING(0, "onto", &options.onto_name,
1385 N_("revision"),
1386 N_("rebase onto given branch instead of upstream")),
06e4775a
PK
1387 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
1388 N_("allow pre-rebase hook to run")),
b4c8eb02
PK
1389 OPT_NEGBIT('q', "quiet", &options.flags,
1390 N_("be quiet. implies --no-stat"),
bff014da
PK
1391 REBASE_NO_QUIET| REBASE_VERBOSE | REBASE_DIFFSTAT),
1392 OPT_BIT('v', "verbose", &options.flags,
1393 N_("display a diffstat of what changed upstream"),
1394 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1395 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
1396 N_("do not show diffstat of what changed upstream"),
1397 PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
73d51ed0
PK
1398 OPT_BOOL(0, "signoff", &options.signoff,
1399 N_("add a Signed-off-by: line to each commit")),
f5769680
JS
1400 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &options.git_am_opts,
1401 NULL, N_("passed to 'git am'"),
1402 PARSE_OPT_NOARG),
1403 OPT_PASSTHRU_ARGV(0, "committer-date-is-author-date",
1404 &options.git_am_opts, NULL,
1405 N_("passed to 'git am'"), PARSE_OPT_NOARG),
1406 OPT_PASSTHRU_ARGV(0, "ignore-date", &options.git_am_opts, NULL,
1407 N_("passed to 'git am'"), PARSE_OPT_NOARG),
1408 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
1409 N_("passed to 'git apply'"), 0),
1410 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
1411 N_("action"), N_("passed to 'git apply'"), 0),
1ed9c14f
PK
1412 OPT_BIT('f', "force-rebase", &options.flags,
1413 N_("cherry-pick all commits, even if unchanged"),
1414 REBASE_FORCE),
1415 OPT_BIT(0, "no-ff", &options.flags,
1416 N_("cherry-pick all commits, even if unchanged"),
1417 REBASE_FORCE),
f9573628
PK
1418 OPT_CMDMODE(0, "continue", &action, N_("continue"),
1419 ACTION_CONTINUE),
122420c2
PK
1420 OPT_CMDMODE(0, "skip", &action,
1421 N_("skip current patch and continue"), ACTION_SKIP),
5e5d9619
PK
1422 OPT_CMDMODE(0, "abort", &action,
1423 N_("abort and check out the original branch"),
1424 ACTION_ABORT),
5a614945
PK
1425 OPT_CMDMODE(0, "quit", &action,
1426 N_("abort but keep HEAD where it is"), ACTION_QUIT),
51e9ea6d
PK
1427 OPT_CMDMODE(0, "edit-todo", &action, N_("edit the todo list "
1428 "during an interactive rebase"), ACTION_EDIT_TODO),
1429 OPT_CMDMODE(0, "show-current-patch", &action,
1430 N_("show the patch file being applied or merged"),
1431 ACTION_SHOW_CURRENT_PATCH),
361badd3
PK
1432 { OPTION_CALLBACK, 'm', "merge", &options, NULL,
1433 N_("use merging strategies to rebase"),
1434 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1435 parse_opt_merge },
1436 { OPTION_CALLBACK, 'i', "interactive", &options, NULL,
1437 N_("let the user edit the list of commits to rebase"),
1438 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1439 parse_opt_interactive },
1440 OPT_SET_INT('p', "preserve-merges", &options.type,
427c3bd2
JS
1441 N_("(DEPRECATED) try to recreate merges instead of "
1442 "ignoring them"), REBASE_PRESERVE_MERGES),
6023c928 1443 OPT_RERERE_AUTOUPDATE(&options.allow_rerere_autoupdate),
002ee2fe
PK
1444 OPT_BOOL('k', "keep-empty", &options.keep_empty,
1445 N_("preserve empty commits during rebase")),
051910a9
PK
1446 OPT_BOOL(0, "autosquash", &options.autosquash,
1447 N_("move commits that begin with "
1448 "squash!/fixup! under -i")),
12026a41
PK
1449 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
1450 N_("GPG-sign commits"),
1451 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
6defce2b
PK
1452 OPT_BOOL(0, "autostash", &options.autostash,
1453 N_("automatically stash/stash pop before and after")),
68e46d78
PK
1454 OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
1455 N_("add exec lines after each commit of the "
1456 "editable list")),
9b3a448b
PK
1457 OPT_BOOL(0, "allow-empty-message",
1458 &options.allow_empty_message,
1459 N_("allow rebasing commits with empty messages")),
3c3588c7
PK
1460 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
1461 N_("mode"),
1462 N_("try to rebase merges instead of skipping them"),
1463 PARSE_OPT_OPTARG, NULL, (intptr_t)""},
92d0d74e
PK
1464 OPT_BOOL(0, "fork-point", &fork_point,
1465 N_("use 'merge-base --fork-point' to refine upstream")),
ba1905a5
PK
1466 OPT_STRING('s', "strategy", &options.strategy,
1467 N_("strategy"), N_("use the given merge strategy")),
1468 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
1469 N_("option"),
1470 N_("pass the argument through to the merge "
1471 "strategy")),
9dba809a
PK
1472 OPT_BOOL(0, "root", &options.root,
1473 N_("rebase all reachable commits up to the root(s)")),
d421afa0
JS
1474 OPT_BOOL(0, "reschedule-failed-exec",
1475 &options.reschedule_failed_exec,
1476 N_("automatically re-schedule any `exec` that fails")),
f28d40d3
PK
1477 OPT_END(),
1478 };
f5769680 1479 int i;
ac7f467f 1480
f28d40d3
PK
1481 if (argc == 2 && !strcmp(argv[1], "-h"))
1482 usage_with_options(builtin_rebase_usage,
1483 builtin_rebase_options);
1484
55071ea2
PK
1485 prefix = setup_git_directory();
1486 trace_repo_setup(prefix);
1487 setup_work_tree();
1488
73fdc535 1489 options.allow_empty_message = 1;
bff014da
PK
1490 git_config(rebase_config, &options);
1491
d03ebd41
ÆAB
1492 if (options.use_legacy_rebase ||
1493 !git_env_bool("GIT_TEST_REBASE_USE_BUILTIN", -1))
1494 warning(_("the rebase.useBuiltin support has been removed!\n"
1495 "See its entry in 'git help config' for details."));
1496
0eabf4b9
PK
1497 strbuf_reset(&buf);
1498 strbuf_addf(&buf, "%s/applying", apply_dir());
1499 if(file_exists(buf.buf))
1500 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1501
c54dacb5
PK
1502 if (is_directory(apply_dir())) {
1503 options.type = REBASE_AM;
1504 options.state_dir = apply_dir();
1505 } else if (is_directory(merge_dir())) {
1506 strbuf_reset(&buf);
1507 strbuf_addf(&buf, "%s/rewritten", merge_dir());
1508 if (is_directory(buf.buf)) {
1509 options.type = REBASE_PRESERVE_MERGES;
1510 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1511 } else {
1512 strbuf_reset(&buf);
1513 strbuf_addf(&buf, "%s/interactive", merge_dir());
1514 if(file_exists(buf.buf)) {
1515 options.type = REBASE_INTERACTIVE;
1516 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1517 } else
1518 options.type = REBASE_MERGE;
1519 }
1520 options.state_dir = merge_dir();
1521 }
1522
1523 if (options.type != REBASE_UNSPECIFIED)
1524 in_progress = 1;
1525
f9573628 1526 total_argc = argc;
f28d40d3
PK
1527 argc = parse_options(argc, argv, prefix,
1528 builtin_rebase_options,
1529 builtin_rebase_usage, 0);
1530
297b1e17 1531 if (action != ACTION_NONE && total_argc != 2) {
f9573628
PK
1532 usage_with_options(builtin_rebase_usage,
1533 builtin_rebase_options);
1534 }
1535
f28d40d3
PK
1536 if (argc > 2)
1537 usage_with_options(builtin_rebase_usage,
1538 builtin_rebase_options);
ac7f467f 1539
427c3bd2
JS
1540 if (options.type == REBASE_PRESERVE_MERGES)
1541 warning(_("git rebase --preserve-merges is deprecated. "
1542 "Use --rebase-merges instead."));
1543
297b1e17 1544 if (action != ACTION_NONE && !in_progress)
d732a570 1545 die(_("No rebase in progress?"));
13a5a9f0 1546 setenv(GIT_REFLOG_ACTION_ENVIRONMENT, "rebase", 0);
d732a570 1547
51e9ea6d
PK
1548 if (action == ACTION_EDIT_TODO && !is_interactive(&options))
1549 die(_("The --edit-todo action can only be used during "
1550 "interactive rebase."));
1551
b3a5d5a8
JH
1552 if (trace2_is_enabled()) {
1553 if (is_interactive(&options))
1554 trace2_cmd_mode("interactive");
1555 else if (exec.nr)
1556 trace2_cmd_mode("interactive-exec");
1557 else
1558 trace2_cmd_mode(action_names[action]);
1559 }
1560
f9573628
PK
1561 switch (action) {
1562 case ACTION_CONTINUE: {
1563 struct object_id head;
1564 struct lock_file lock_file = LOCK_INIT;
1565 int fd;
1566
1567 options.action = "continue";
13a5a9f0 1568 set_reflog_action(&options);
f9573628
PK
1569
1570 /* Sanity check */
1571 if (get_oid("HEAD", &head))
1572 die(_("Cannot read HEAD"));
1573
1574 fd = hold_locked_index(&lock_file, 0);
e1ff0a32 1575 if (repo_read_index(the_repository) < 0)
f9573628
PK
1576 die(_("could not read index"));
1577 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1578 NULL);
1579 if (0 <= fd)
1b0d968b 1580 repo_update_index_if_able(the_repository, &lock_file);
f9573628
PK
1581 rollback_lock_file(&lock_file);
1582
5b02ca38 1583 if (has_unstaged_changes(the_repository, 1)) {
f9573628
PK
1584 puts(_("You must edit all merge conflicts and then\n"
1585 "mark them as resolved using git add"));
1586 exit(1);
1587 }
1588 if (read_basic_state(&options))
1589 exit(1);
1590 goto run_rebase;
1591 }
122420c2
PK
1592 case ACTION_SKIP: {
1593 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1594
1595 options.action = "skip";
13a5a9f0 1596 set_reflog_action(&options);
122420c2 1597
55e6b354 1598 rerere_clear(the_repository, &merge_rr);
122420c2
PK
1599 string_list_clear(&merge_rr, 1);
1600
bac2a1e3
JS
1601 if (reset_head(NULL, "reset", NULL, RESET_HEAD_HARD,
1602 NULL, NULL) < 0)
122420c2 1603 die(_("could not discard worktree changes"));
cde55548 1604 remove_branch_state(the_repository);
122420c2
PK
1605 if (read_basic_state(&options))
1606 exit(1);
1607 goto run_rebase;
1608 }
5e5d9619
PK
1609 case ACTION_ABORT: {
1610 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1611 options.action = "abort";
13a5a9f0 1612 set_reflog_action(&options);
5e5d9619 1613
55e6b354 1614 rerere_clear(the_repository, &merge_rr);
5e5d9619
PK
1615 string_list_clear(&merge_rr, 1);
1616
1617 if (read_basic_state(&options))
1618 exit(1);
1619 if (reset_head(&options.orig_head, "reset",
bac2a1e3
JS
1620 options.head_name, RESET_HEAD_HARD,
1621 NULL, NULL) < 0)
5e5d9619
PK
1622 die(_("could not move back to %s"),
1623 oid_to_hex(&options.orig_head));
cde55548 1624 remove_branch_state(the_repository);
5e5d9619
PK
1625 ret = finish_rebase(&options);
1626 goto cleanup;
1627 }
5a614945
PK
1628 case ACTION_QUIT: {
1629 strbuf_reset(&buf);
1630 strbuf_addstr(&buf, options.state_dir);
1631 ret = !!remove_dir_recursively(&buf, 0);
1632 if (ret)
1633 die(_("could not remove '%s'"), options.state_dir);
1634 goto cleanup;
1635 }
51e9ea6d
PK
1636 case ACTION_EDIT_TODO:
1637 options.action = "edit-todo";
1638 options.dont_finish_rebase = 1;
1639 goto run_rebase;
1640 case ACTION_SHOW_CURRENT_PATCH:
1641 options.action = "show-current-patch";
1642 options.dont_finish_rebase = 1;
1643 goto run_rebase;
297b1e17 1644 case ACTION_NONE:
51e9ea6d 1645 break;
f9573628 1646 default:
51e9ea6d 1647 BUG("action: %d", action);
f9573628
PK
1648 }
1649
c54dacb5
PK
1650 /* Make sure no rebase is in progress */
1651 if (in_progress) {
1652 const char *last_slash = strrchr(options.state_dir, '/');
1653 const char *state_dir_base =
1654 last_slash ? last_slash + 1 : options.state_dir;
1655 const char *cmd_live_rebase =
1656 "git rebase (--continue | --abort | --skip)";
1657 strbuf_reset(&buf);
1658 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1659 die(_("It seems that there is already a %s directory, and\n"
1660 "I wonder if you are in the middle of another rebase. "
1661 "If that is the\n"
1662 "case, please try\n\t%s\n"
1663 "If that is not the case, please\n\t%s\n"
1664 "and run me again. I am stopping in case you still "
1665 "have something\n"
1666 "valuable there.\n"),
1667 state_dir_base, cmd_live_rebase, buf.buf);
1668 }
1669
f5769680 1670 for (i = 0; i < options.git_am_opts.argc; i++) {
04519d72 1671 const char *option = options.git_am_opts.argv[i], *p;
f5769680
JS
1672 if (!strcmp(option, "--committer-date-is-author-date") ||
1673 !strcmp(option, "--ignore-date") ||
1674 !strcmp(option, "--whitespace=fix") ||
1675 !strcmp(option, "--whitespace=strip"))
1676 options.flags |= REBASE_FORCE;
04519d72
JS
1677 else if (skip_prefix(option, "-C", &p)) {
1678 while (*p)
1679 if (!isdigit(*(p++)))
1680 die(_("switch `C' expects a "
1681 "numerical value"));
1682 } else if (skip_prefix(option, "--whitespace=", &p)) {
1683 if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1684 strcmp(p, "error") && strcmp(p, "error-all"))
1685 die("Invalid whitespace option: '%s'", p);
1686 }
38dbcef2
PK
1687 }
1688
c762aada
PW
1689 for (i = 0; i < exec.nr; i++)
1690 if (check_exec_cmd(exec.items[i].string))
1691 exit(1);
1692
f5769680
JS
1693 if (!(options.flags & REBASE_NO_QUIET))
1694 argv_array_push(&options.git_am_opts, "-q");
53f9e5be 1695
002ee2fe
PK
1696 if (options.keep_empty)
1697 imply_interactive(&options, "--keep-empty");
1698
12026a41
PK
1699 if (gpg_sign) {
1700 free(options.gpg_sign_opt);
1701 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1702 }
1703
68e46d78
PK
1704 if (exec.nr) {
1705 int i;
1706
1707 imply_interactive(&options, "--exec");
1708
1709 strbuf_reset(&buf);
1710 for (i = 0; i < exec.nr; i++)
1711 strbuf_addf(&buf, "exec %s\n", exec.items[i].string);
1712 options.cmd = xstrdup(buf.buf);
1713 }
1714
3c3588c7
PK
1715 if (rebase_merges) {
1716 if (!*rebase_merges)
1717 ; /* default mode; do nothing */
1718 else if (!strcmp("rebase-cousins", rebase_merges))
1719 options.rebase_cousins = 1;
1720 else if (strcmp("no-rebase-cousins", rebase_merges))
1721 die(_("Unknown mode: %s"), rebase_merges);
1722 options.rebase_merges = 1;
1723 imply_interactive(&options, "--rebase-merges");
1724 }
1725
ba1905a5
PK
1726 if (strategy_options.nr) {
1727 int i;
1728
1729 if (!options.strategy)
1730 options.strategy = "recursive";
1731
1732 strbuf_reset(&buf);
1733 for (i = 0; i < strategy_options.nr; i++)
1734 strbuf_addf(&buf, " --%s",
1735 strategy_options.items[i].string);
1736 options.strategy_opts = xstrdup(buf.buf);
1737 }
1738
1739 if (options.strategy) {
1740 options.strategy = xstrdup(options.strategy);
1741 switch (options.type) {
1742 case REBASE_AM:
1743 die(_("--strategy requires --merge or --interactive"));
1744 case REBASE_MERGE:
1745 case REBASE_INTERACTIVE:
1746 case REBASE_PRESERVE_MERGES:
1747 /* compatible */
1748 break;
1749 case REBASE_UNSPECIFIED:
1750 options.type = REBASE_MERGE;
1751 break;
1752 default:
1753 BUG("unhandled rebase type (%d)", options.type);
1754 }
1755 }
1756
68aa495b
EN
1757 if (options.type == REBASE_MERGE)
1758 imply_interactive(&options, "--merge");
1759
9dba809a
PK
1760 if (options.root && !options.onto_name)
1761 imply_interactive(&options, "--root without --onto");
1762
cda614e4
PK
1763 if (isatty(2) && options.flags & REBASE_NO_QUIET)
1764 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1765
ac7f467f
PK
1766 switch (options.type) {
1767 case REBASE_MERGE:
1768 case REBASE_INTERACTIVE:
1769 case REBASE_PRESERVE_MERGES:
1770 options.state_dir = merge_dir();
1771 break;
1772 case REBASE_AM:
1773 options.state_dir = apply_dir();
1774 break;
1775 default:
1776 /* the default rebase backend is `--am` */
1777 options.type = REBASE_AM;
1778 options.state_dir = apply_dir();
1779 break;
1780 }
1781
d421afa0 1782 if (options.reschedule_failed_exec && !is_interactive(&options))
32ceace3 1783 die(_("%s requires an interactive rebase"), "--reschedule-failed-exec");
d421afa0 1784
f5769680 1785 if (options.git_am_opts.argc) {
b361bd75 1786 /* all am options except -q are compatible only with --am */
f5769680
JS
1787 for (i = options.git_am_opts.argc - 1; i >= 0; i--)
1788 if (strcmp(options.git_am_opts.argv[i], "-q"))
1789 break;
b361bd75 1790
f5769680 1791 if (is_interactive(&options) && i >= 0)
68aa495b
EN
1792 die(_("cannot combine am options with either "
1793 "interactive or merge options"));
b361bd75
PK
1794 }
1795
73d51ed0
PK
1796 if (options.signoff) {
1797 if (options.type == REBASE_PRESERVE_MERGES)
1798 die("cannot combine '--signoff' with "
1799 "'--preserve-merges'");
f5769680 1800 argv_array_push(&options.git_am_opts, "--signoff");
73d51ed0
PK
1801 options.flags |= REBASE_FORCE;
1802 }
1803
d421afa0 1804 if (options.type == REBASE_PRESERVE_MERGES) {
b361bd75
PK
1805 /*
1806 * Note: incompatibility with --signoff handled in signoff block above
1807 * Note: incompatibility with --interactive is just a strong warning;
1808 * git-rebase.txt caveats with "unless you know what you are doing"
1809 */
1810 if (options.rebase_merges)
c913c596 1811 die(_("cannot combine '--preserve-merges' with "
b361bd75
PK
1812 "'--rebase-merges'"));
1813
d421afa0
JS
1814 if (options.reschedule_failed_exec)
1815 die(_("error: cannot combine '--preserve-merges' with "
1816 "'--reschedule-failed-exec'"));
1817 }
1818
b361bd75
PK
1819 if (options.rebase_merges) {
1820 if (strategy_options.nr)
c913c596 1821 die(_("cannot combine '--rebase-merges' with "
b361bd75
PK
1822 "'--strategy-option'"));
1823 if (options.strategy)
c913c596 1824 die(_("cannot combine '--rebase-merges' with "
b361bd75
PK
1825 "'--strategy'"));
1826 }
1827
ac7f467f 1828 if (!options.root) {
8f5986d9
PK
1829 if (argc < 1) {
1830 struct branch *branch;
1831
1832 branch = branch_get(NULL);
1833 options.upstream_name = branch_get_upstream(branch,
1834 NULL);
1835 if (!options.upstream_name)
1836 error_on_missing_default_upstream();
1837 if (fork_point < 0)
1838 fork_point = 1;
1839 } else {
f28d40d3 1840 options.upstream_name = argv[0];
ac7f467f
PK
1841 argc--;
1842 argv++;
1843 if (!strcmp(options.upstream_name, "-"))
1844 options.upstream_name = "@{-1}";
1845 }
1846 options.upstream = peel_committish(options.upstream_name);
1847 if (!options.upstream)
1848 die(_("invalid upstream '%s'"), options.upstream_name);
06e4775a 1849 options.upstream_arg = options.upstream_name;
9dba809a
PK
1850 } else {
1851 if (!options.onto_name) {
1852 if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1853 &squash_onto, NULL, NULL) < 0)
1854 die(_("Could not create new root commit"));
1855 options.squash_onto = &squash_onto;
1856 options.onto_name = squash_onto_name =
1857 xstrdup(oid_to_hex(&squash_onto));
1858 }
1859 options.upstream_name = NULL;
1860 options.upstream = NULL;
1861 if (argc > 1)
1862 usage_with_options(builtin_rebase_usage,
1863 builtin_rebase_options);
1864 options.upstream_arg = "--root";
1865 }
ac7f467f
PK
1866
1867 /* Make sure the branch to rebase onto is valid. */
1868 if (!options.onto_name)
1869 options.onto_name = options.upstream_name;
1870 if (strstr(options.onto_name, "...")) {
075bc852
PK
1871 if (get_oid_mb(options.onto_name, &merge_base) < 0)
1872 die(_("'%s': need exactly one merge base"),
1873 options.onto_name);
1874 options.onto = lookup_commit_or_die(&merge_base,
1875 options.onto_name);
ac7f467f
PK
1876 } else {
1877 options.onto = peel_committish(options.onto_name);
1878 if (!options.onto)
1879 die(_("Does not point to a valid commit '%s'"),
1880 options.onto_name);
1881 }
1882
1883 /*
1884 * If the branch to rebase is given, that is the branch we will rebase
1885 * branch_name -- branch/commit being rebased, or
1886 * HEAD (already detached)
1887 * orig_head -- commit object name of tip of the branch before rebasing
d4c569f8 1888 * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
ac7f467f 1889 */
e65123a7
PK
1890 if (argc == 1) {
1891 /* Is it "rebase other branchname" or "rebase other commit"? */
1892 branch_name = argv[0];
1893 options.switch_to = argv[0];
1894
1895 /* Is it a local branch? */
1896 strbuf_reset(&buf);
1897 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1898 if (!read_ref(buf.buf, &options.orig_head))
1899 options.head_name = xstrdup(buf.buf);
1900 /* If not is it a valid ref (branch or commit)? */
1901 else if (!get_oid(branch_name, &options.orig_head))
1902 options.head_name = NULL;
1903 else
1904 die(_("fatal: no such branch/commit '%s'"),
1905 branch_name);
1906 } else if (argc == 0) {
ac7f467f
PK
1907 /* Do not need to switch branches, we are already on it. */
1908 options.head_name =
1909 xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
1910 &flags));
1911 if (!options.head_name)
1912 die(_("No such ref: %s"), "HEAD");
1913 if (flags & REF_ISSYMREF) {
1914 if (!skip_prefix(options.head_name,
1915 "refs/heads/", &branch_name))
1916 branch_name = options.head_name;
1917
1918 } else {
7762f44e 1919 FREE_AND_NULL(options.head_name);
ac7f467f
PK
1920 branch_name = "HEAD";
1921 }
1922 if (get_oid("HEAD", &options.orig_head))
1923 die(_("Could not resolve HEAD to a revision"));
e65123a7
PK
1924 } else
1925 BUG("unexpected number of arguments left to parse");
ac7f467f 1926
92d0d74e
PK
1927 if (fork_point > 0) {
1928 struct commit *head =
1929 lookup_commit_reference(the_repository,
1930 &options.orig_head);
1931 options.restrict_revision =
1932 get_fork_point(options.upstream_name, head);
1933 }
1934
e1ff0a32 1935 if (repo_read_index(the_repository) < 0)
e0333e5c
PK
1936 die(_("could not read index"));
1937
6defce2b
PK
1938 if (options.autostash) {
1939 struct lock_file lock_file = LOCK_INIT;
1940 int fd;
1941
1942 fd = hold_locked_index(&lock_file, 0);
1943 refresh_cache(REFRESH_QUIET);
1944 if (0 <= fd)
1b0d968b 1945 repo_update_index_if_able(the_repository, &lock_file);
6defce2b
PK
1946 rollback_lock_file(&lock_file);
1947
5b02ca38
NTND
1948 if (has_unstaged_changes(the_repository, 1) ||
1949 has_uncommitted_changes(the_repository, 1)) {
6defce2b
PK
1950 const char *autostash =
1951 state_dir_path("autostash", &options);
1952 struct child_process stash = CHILD_PROCESS_INIT;
1953 struct object_id oid;
1954 struct commit *head =
1955 lookup_commit_reference(the_repository,
1956 &options.orig_head);
1957
1958 argv_array_pushl(&stash.args,
1959 "stash", "create", "autostash", NULL);
1960 stash.git_cmd = 1;
1961 stash.no_stdin = 1;
1962 strbuf_reset(&buf);
1963 if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
1964 die(_("Cannot autostash"));
1965 strbuf_trim_trailing_newline(&buf);
1966 if (get_oid(buf.buf, &oid))
1967 die(_("Unexpected stash response: '%s'"),
1968 buf.buf);
1969 strbuf_reset(&buf);
1970 strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
1971
1972 if (safe_create_leading_directories_const(autostash))
1973 die(_("Could not create directory for '%s'"),
1974 options.state_dir);
12aeb00a 1975 write_file(autostash, "%s", oid_to_hex(&oid));
6defce2b
PK
1976 printf(_("Created autostash: %s\n"), buf.buf);
1977 if (reset_head(&head->object.oid, "reset --hard",
bac2a1e3 1978 NULL, RESET_HEAD_HARD, NULL, NULL) < 0)
6defce2b
PK
1979 die(_("could not reset --hard"));
1980 printf(_("HEAD is now at %s"),
1981 find_unique_abbrev(&head->object.oid,
1982 DEFAULT_ABBREV));
1983 strbuf_reset(&buf);
1984 pp_commit_easy(CMIT_FMT_ONELINE, head, &buf);
1985 if (buf.len > 0)
1986 printf(" %s", buf.buf);
1987 putchar('\n');
1988
1989 if (discard_index(the_repository->index) < 0 ||
e1ff0a32 1990 repo_read_index(the_repository) < 0)
6defce2b
PK
1991 die(_("could not read index"));
1992 }
1993 }
1994
5b02ca38 1995 if (require_clean_work_tree(the_repository, "rebase",
e0333e5c
PK
1996 _("Please commit or stash them."), 1, 1)) {
1997 ret = 1;
1998 goto cleanup;
ac7f467f
PK
1999 }
2000
9a48a615
PK
2001 /*
2002 * Now we are rebasing commits upstream..orig_head (or with --root,
2003 * everything leading up to orig_head) on top of onto.
2004 */
2005
2006 /*
2007 * Check if we are already based on onto with linear history,
2008 * but this should be done only when upstream and onto are the same
2009 * and if this is not an interactive rebase.
2010 */
2011 if (can_fast_forward(options.onto, &options.orig_head, &merge_base) &&
2012 !is_interactive(&options) && !options.restrict_revision &&
9dba809a 2013 options.upstream &&
9a48a615
PK
2014 !oidcmp(&options.upstream->object.oid, &options.onto->object.oid)) {
2015 int flag;
2016
1ed9c14f 2017 if (!(options.flags & REBASE_FORCE)) {
e65123a7
PK
2018 /* Lazily switch to the target branch if needed... */
2019 if (options.switch_to) {
2020 struct object_id oid;
2021
2022 if (get_oid(options.switch_to, &oid) < 0) {
2023 ret = !!error(_("could not parse '%s'"),
2024 options.switch_to);
2025 goto cleanup;
2026 }
2027
2028 strbuf_reset(&buf);
13a5a9f0
JS
2029 strbuf_addf(&buf, "%s: checkout %s",
2030 getenv(GIT_REFLOG_ACTION_ENVIRONMENT),
e65123a7
PK
2031 options.switch_to);
2032 if (reset_head(&oid, "checkout",
8581df65
OS
2033 options.head_name,
2034 RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
13a5a9f0 2035 NULL, buf.buf) < 0) {
e65123a7
PK
2036 ret = !!error(_("could not switch to "
2037 "%s"),
2038 options.switch_to);
2039 goto cleanup;
2040 }
2041 }
2042
1ed9c14f
PK
2043 if (!(options.flags & REBASE_NO_QUIET))
2044 ; /* be quiet */
2045 else if (!strcmp(branch_name, "HEAD") &&
2046 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
2047 puts(_("HEAD is up to date."));
2048 else
2049 printf(_("Current branch %s is up to date.\n"),
2050 branch_name);
2051 ret = !!finish_rebase(&options);
2052 goto cleanup;
2053 } else if (!(options.flags & REBASE_NO_QUIET))
9a48a615
PK
2054 ; /* be quiet */
2055 else if (!strcmp(branch_name, "HEAD") &&
2056 resolve_ref_unsafe("HEAD", 0, NULL, &flag))
2057 puts(_("HEAD is up to date, rebase forced."));
2058 else
2059 printf(_("Current branch %s is up to date, rebase "
2060 "forced.\n"), branch_name);
2061 }
2062
06e4775a
PK
2063 /* If a hook exists, give it a chance to interrupt*/
2064 if (!ok_to_skip_pre_rebase &&
2065 run_hook_le(NULL, "pre-rebase", options.upstream_arg,
2066 argc ? argv[0] : NULL, NULL))
2067 die(_("The pre-rebase hook refused to rebase."));
2068
bff014da
PK
2069 if (options.flags & REBASE_DIFFSTAT) {
2070 struct diff_options opts;
2071
8797f0f0
JS
2072 if (options.flags & REBASE_VERBOSE) {
2073 if (is_null_oid(&merge_base))
2074 printf(_("Changes to %s:\n"),
2075 oid_to_hex(&options.onto->object.oid));
2076 else
2077 printf(_("Changes from %s to %s:\n"),
2078 oid_to_hex(&merge_base),
2079 oid_to_hex(&options.onto->object.oid));
2080 }
bff014da
PK
2081
2082 /* We want color (if set), but no pager */
2083 diff_setup(&opts);
2084 opts.stat_width = -1; /* use full terminal width */
2085 opts.stat_graph_width = -1; /* respect statGraphWidth config */
2086 opts.output_format |=
2087 DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
2088 opts.detect_rename = DIFF_DETECT_RENAME;
2089 diff_setup_done(&opts);
8797f0f0
JS
2090 diff_tree_oid(is_null_oid(&merge_base) ?
2091 the_hash_algo->empty_tree : &merge_base,
2092 &options.onto->object.oid, "", &opts);
bff014da
PK
2093 diffcore_std(&opts);
2094 diff_flush(&opts);
2095 }
2096
361badd3
PK
2097 if (is_interactive(&options))
2098 goto run_rebase;
2099
bff014da
PK
2100 /* Detach HEAD and reset the tree */
2101 if (options.flags & REBASE_NO_QUIET)
2102 printf(_("First, rewinding head to replay your work on top of "
2103 "it...\n"));
2104
13a5a9f0
JS
2105 strbuf_addf(&msg, "%s: checkout %s",
2106 getenv(GIT_REFLOG_ACTION_ENVIRONMENT), options.onto_name);
73d6d7b2 2107 if (reset_head(&options.onto->object.oid, "checkout", NULL,
9fbcc3d2
JH
2108 RESET_HEAD_DETACH | RESET_ORIG_HEAD |
2109 RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
8581df65 2110 NULL, msg.buf))
ac7f467f
PK
2111 die(_("Could not detach HEAD"));
2112 strbuf_release(&msg);
2113
7eecfa56
PK
2114 /*
2115 * If the onto is a proper descendant of the tip of the branch, then
2116 * we just fast-forwarded.
2117 */
2118 strbuf_reset(&msg);
d2c4e629 2119 if (oideq(&merge_base, &options.orig_head)) {
eff199a6 2120 printf(_("Fast-forwarded %s to %s.\n"),
7eecfa56
PK
2121 branch_name, options.onto_name);
2122 strbuf_addf(&msg, "rebase finished: %s onto %s",
2123 options.head_name ? options.head_name : "detached HEAD",
2124 oid_to_hex(&options.onto->object.oid));
e6aac817
JS
2125 reset_head(NULL, "Fast-forwarded", options.head_name,
2126 RESET_HEAD_REFS_ONLY, "HEAD", msg.buf);
7eecfa56
PK
2127 strbuf_release(&msg);
2128 ret = !!finish_rebase(&options);
2129 goto cleanup;
2130 }
2131
ac7f467f
PK
2132 strbuf_addf(&revisions, "%s..%s",
2133 options.root ? oid_to_hex(&options.onto->object.oid) :
2134 (options.restrict_revision ?
2135 oid_to_hex(&options.restrict_revision->object.oid) :
2136 oid_to_hex(&options.upstream->object.oid)),
2137 oid_to_hex(&options.orig_head));
2138
2139 options.revisions = revisions.buf;
2140
f9573628 2141run_rebase:
460bc3ce 2142 ret = !!run_specific_rebase(&options, action);
ac7f467f 2143
e0333e5c 2144cleanup:
ac7f467f
PK
2145 strbuf_release(&revisions);
2146 free(options.head_name);
12026a41 2147 free(options.gpg_sign_opt);
68e46d78 2148 free(options.cmd);
9dba809a 2149 free(squash_onto_name);
ac7f467f 2150 return ret;
55071ea2 2151}