]> git.ipfire.org Git - thirdparty/git.git/blame_incremental - builtin/rebase.c
The ninth batch
[thirdparty/git.git] / builtin / rebase.c
... / ...
CommitLineData
1/*
2 * "git rebase" builtin command
3 *
4 * Copyright (c) 2018 Pratik Karki
5 */
6
7#define USE_THE_REPOSITORY_VARIABLE
8#define DISABLE_SIGN_COMPARE_WARNINGS
9
10#include "builtin.h"
11
12#include "abspath.h"
13#include "environment.h"
14#include "gettext.h"
15#include "hex.h"
16#include "run-command.h"
17#include "strvec.h"
18#include "dir.h"
19#include "refs.h"
20#include "config.h"
21#include "unpack-trees.h"
22#include "lockfile.h"
23#include "object-file.h"
24#include "object-name.h"
25#include "parse-options.h"
26#include "path.h"
27#include "commit.h"
28#include "diff.h"
29#include "wt-status.h"
30#include "revision.h"
31#include "commit-reach.h"
32#include "rerere.h"
33#include "branch.h"
34#include "sequencer.h"
35#include "rebase-interactive.h"
36#include "reset.h"
37#include "trace2.h"
38#include "hook.h"
39
40static char const * const builtin_rebase_usage[] = {
41 N_("git rebase [-i] [options] [--exec <cmd>] "
42 "[--onto <newbase> | --keep-base] [<upstream> [<branch>]]"),
43 N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
44 "--root [<branch>]"),
45 "git rebase --continue | --abort | --skip | --edit-todo",
46 NULL
47};
48
49static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
50static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
51static GIT_PATH_FUNC(apply_dir, "rebase-apply")
52static GIT_PATH_FUNC(merge_dir, "rebase-merge")
53
54enum rebase_type {
55 REBASE_UNSPECIFIED = -1,
56 REBASE_APPLY,
57 REBASE_MERGE
58};
59
60enum empty_type {
61 EMPTY_UNSPECIFIED = -1,
62 EMPTY_DROP,
63 EMPTY_KEEP,
64 EMPTY_STOP
65};
66
67enum action {
68 ACTION_NONE = 0,
69 ACTION_CONTINUE,
70 ACTION_SKIP,
71 ACTION_ABORT,
72 ACTION_QUIT,
73 ACTION_EDIT_TODO,
74 ACTION_SHOW_CURRENT_PATCH
75};
76
77static const char *action_names[] = {
78 "undefined",
79 "continue",
80 "skip",
81 "abort",
82 "quit",
83 "edit_todo",
84 "show_current_patch"
85};
86
87struct rebase_options {
88 enum rebase_type type;
89 enum empty_type empty;
90 char *default_backend;
91 const char *state_dir;
92 struct commit *upstream;
93 const char *upstream_name;
94 const char *upstream_arg;
95 char *head_name;
96 struct commit *orig_head;
97 struct commit *onto;
98 const char *onto_name;
99 const char *revisions;
100 const char *switch_to;
101 int root, root_with_onto;
102 struct object_id *squash_onto;
103 struct commit *restrict_revision;
104 int dont_finish_rebase;
105 enum {
106 REBASE_NO_QUIET = 1<<0,
107 REBASE_VERBOSE = 1<<1,
108 REBASE_DIFFSTAT = 1<<2,
109 REBASE_FORCE = 1<<3,
110 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
111 } flags;
112 struct strvec git_am_opts;
113 enum action action;
114 char *reflog_action;
115 int signoff;
116 int allow_rerere_autoupdate;
117 int keep_empty;
118 int autosquash;
119 char *gpg_sign_opt;
120 int autostash;
121 int committer_date_is_author_date;
122 int ignore_date;
123 struct string_list exec;
124 int allow_empty_message;
125 int rebase_merges, rebase_cousins;
126 char *strategy;
127 struct string_list strategy_opts;
128 struct strbuf git_format_patch_opt;
129 int reschedule_failed_exec;
130 int reapply_cherry_picks;
131 int fork_point;
132 int update_refs;
133 int config_autosquash;
134 int config_rebase_merges;
135 int config_update_refs;
136};
137
138#define REBASE_OPTIONS_INIT { \
139 .type = REBASE_UNSPECIFIED, \
140 .empty = EMPTY_UNSPECIFIED, \
141 .keep_empty = 1, \
142 .default_backend = xstrdup("merge"), \
143 .flags = REBASE_NO_QUIET, \
144 .git_am_opts = STRVEC_INIT, \
145 .exec = STRING_LIST_INIT_NODUP, \
146 .git_format_patch_opt = STRBUF_INIT, \
147 .fork_point = -1, \
148 .reapply_cherry_picks = -1, \
149 .allow_empty_message = 1, \
150 .autosquash = -1, \
151 .rebase_merges = -1, \
152 .config_rebase_merges = -1, \
153 .update_refs = -1, \
154 .config_update_refs = -1, \
155 .strategy_opts = STRING_LIST_INIT_NODUP,\
156 }
157
158static void rebase_options_release(struct rebase_options *opts)
159{
160 free(opts->default_backend);
161 free(opts->reflog_action);
162 free(opts->head_name);
163 strvec_clear(&opts->git_am_opts);
164 free(opts->gpg_sign_opt);
165 string_list_clear(&opts->exec, 0);
166 free(opts->strategy);
167 string_list_clear(&opts->strategy_opts, 0);
168 strbuf_release(&opts->git_format_patch_opt);
169}
170
171static struct replay_opts get_replay_opts(const struct rebase_options *opts)
172{
173 struct replay_opts replay = REPLAY_OPTS_INIT;
174
175 replay.action = REPLAY_INTERACTIVE_REBASE;
176 replay.strategy = NULL;
177 sequencer_init_config(&replay);
178
179 replay.signoff = opts->signoff;
180 replay.allow_ff = !(opts->flags & REBASE_FORCE);
181 if (opts->allow_rerere_autoupdate)
182 replay.allow_rerere_auto = opts->allow_rerere_autoupdate;
183 replay.allow_empty = 1;
184 replay.allow_empty_message = opts->allow_empty_message;
185 replay.drop_redundant_commits = (opts->empty == EMPTY_DROP);
186 replay.keep_redundant_commits = (opts->empty == EMPTY_KEEP);
187 replay.quiet = !(opts->flags & REBASE_NO_QUIET);
188 replay.verbose = opts->flags & REBASE_VERBOSE;
189 replay.reschedule_failed_exec = opts->reschedule_failed_exec;
190 replay.committer_date_is_author_date =
191 opts->committer_date_is_author_date;
192 replay.ignore_date = opts->ignore_date;
193 free(replay.gpg_sign);
194 replay.gpg_sign = xstrdup_or_null(opts->gpg_sign_opt);
195 replay.reflog_action = xstrdup(opts->reflog_action);
196 if (opts->strategy)
197 replay.strategy = xstrdup_or_null(opts->strategy);
198 else if (!replay.strategy && replay.default_strategy) {
199 replay.strategy = replay.default_strategy;
200 replay.default_strategy = NULL;
201 }
202
203 for (size_t i = 0; i < opts->strategy_opts.nr; i++)
204 strvec_push(&replay.xopts, opts->strategy_opts.items[i].string);
205
206 if (opts->squash_onto) {
207 oidcpy(&replay.squash_onto, opts->squash_onto);
208 replay.have_squash_onto = 1;
209 }
210
211 return replay;
212}
213
214static int edit_todo_file(unsigned flags, struct replay_opts *opts)
215{
216 const char *todo_file = rebase_path_todo();
217 struct todo_list todo_list = TODO_LIST_INIT,
218 new_todo = TODO_LIST_INIT;
219 int res = 0;
220
221 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
222 return error_errno(_("could not read '%s'."), todo_file);
223
224 strbuf_stripspace(&todo_list.buf, comment_line_str);
225 res = edit_todo_list(the_repository, opts, &todo_list, &new_todo,
226 NULL, NULL, flags);
227 if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
228 NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
229 res = error_errno(_("could not write '%s'"), todo_file);
230
231 todo_list_release(&todo_list);
232 todo_list_release(&new_todo);
233
234 return res;
235}
236
237static int get_revision_ranges(struct commit *upstream, struct commit *onto,
238 struct object_id *orig_head, char **revisions,
239 char **shortrevisions)
240{
241 struct commit *base_rev = upstream ? upstream : onto;
242 const char *shorthead;
243
244 *revisions = xstrfmt("%s...%s", oid_to_hex(&base_rev->object.oid),
245 oid_to_hex(orig_head));
246
247 shorthead = repo_find_unique_abbrev(the_repository, orig_head,
248 DEFAULT_ABBREV);
249
250 if (upstream) {
251 const char *shortrev;
252
253 shortrev = repo_find_unique_abbrev(the_repository,
254 &base_rev->object.oid,
255 DEFAULT_ABBREV);
256
257 *shortrevisions = xstrfmt("%s..%s", shortrev, shorthead);
258 } else
259 *shortrevisions = xstrdup(shorthead);
260
261 return 0;
262}
263
264static int init_basic_state(struct replay_opts *opts, const char *head_name,
265 struct commit *onto,
266 const struct object_id *orig_head)
267{
268 FILE *interactive;
269
270 if (!is_directory(merge_dir()) &&
271 safe_create_dir_in_gitdir(the_repository, merge_dir()))
272 return error_errno(_("could not create temporary %s"), merge_dir());
273
274 refs_delete_reflog(get_main_ref_store(the_repository), "REBASE_HEAD");
275
276 interactive = fopen(path_interactive(), "w");
277 if (!interactive)
278 return error_errno(_("could not mark as interactive"));
279 fclose(interactive);
280
281 return write_basic_state(opts, head_name, onto, orig_head);
282}
283
284static int do_interactive_rebase(struct rebase_options *opts, unsigned flags)
285{
286 int ret = -1;
287 char *revisions = NULL, *shortrevisions = NULL;
288 struct strvec make_script_args = STRVEC_INIT;
289 struct todo_list todo_list = TODO_LIST_INIT;
290 struct replay_opts replay = get_replay_opts(opts);
291
292 if (get_revision_ranges(opts->upstream, opts->onto, &opts->orig_head->object.oid,
293 &revisions, &shortrevisions))
294 goto cleanup;
295
296 strvec_pushl(&make_script_args, "", revisions, NULL);
297 if (opts->restrict_revision)
298 strvec_pushf(&make_script_args, "^%s",
299 oid_to_hex(&opts->restrict_revision->object.oid));
300
301 ret = sequencer_make_script(the_repository, &todo_list.buf,
302 make_script_args.nr, make_script_args.v,
303 flags);
304 if (ret) {
305 error(_("could not generate todo list"));
306 goto cleanup;
307 }
308
309 if (init_basic_state(&replay,
310 opts->head_name ? opts->head_name : "detached HEAD",
311 opts->onto, &opts->orig_head->object.oid))
312 goto cleanup;
313
314 if (!opts->upstream && opts->squash_onto)
315 write_file(path_squash_onto(), "%s\n",
316 oid_to_hex(opts->squash_onto));
317
318 discard_index(the_repository->index);
319 if (todo_list_parse_insn_buffer(the_repository, &replay,
320 todo_list.buf.buf, &todo_list))
321 BUG("unusable todo list");
322
323 ret = complete_action(the_repository, &replay, flags,
324 shortrevisions, opts->onto_name, opts->onto,
325 &opts->orig_head->object.oid, &opts->exec,
326 opts->autosquash, opts->update_refs, &todo_list);
327
328cleanup:
329 replay_opts_release(&replay);
330 free(revisions);
331 free(shortrevisions);
332 todo_list_release(&todo_list);
333 strvec_clear(&make_script_args);
334
335 return ret;
336}
337
338static int run_sequencer_rebase(struct rebase_options *opts)
339{
340 unsigned flags = 0;
341 int abbreviate_commands = 0, ret = 0;
342
343 repo_config_get_bool(the_repository, "rebase.abbreviatecommands", &abbreviate_commands);
344
345 flags |= opts->keep_empty ? TODO_LIST_KEEP_EMPTY : 0;
346 flags |= abbreviate_commands ? TODO_LIST_ABBREVIATE_CMDS : 0;
347 flags |= opts->rebase_merges ? TODO_LIST_REBASE_MERGES : 0;
348 flags |= opts->rebase_cousins > 0 ? TODO_LIST_REBASE_COUSINS : 0;
349 flags |= opts->root_with_onto ? TODO_LIST_ROOT_WITH_ONTO : 0;
350 flags |= opts->reapply_cherry_picks ? TODO_LIST_REAPPLY_CHERRY_PICKS : 0;
351 flags |= opts->flags & REBASE_NO_QUIET ? TODO_LIST_WARN_SKIPPED_CHERRY_PICKS : 0;
352
353 switch (opts->action) {
354 case ACTION_NONE: {
355 if (!opts->onto && !opts->upstream)
356 die(_("a base commit must be provided with --upstream or --onto"));
357
358 ret = do_interactive_rebase(opts, flags);
359 break;
360 }
361 case ACTION_SKIP: {
362 struct string_list merge_rr = STRING_LIST_INIT_DUP;
363
364 rerere_clear(the_repository, &merge_rr);
365 }
366 /* fallthrough */
367 case ACTION_CONTINUE: {
368 struct replay_opts replay_opts = get_replay_opts(opts);
369
370 ret = sequencer_continue(the_repository, &replay_opts);
371 replay_opts_release(&replay_opts);
372 break;
373 }
374 case ACTION_EDIT_TODO: {
375 struct replay_opts replay_opts = get_replay_opts(opts);
376
377 ret = edit_todo_file(flags, &replay_opts);
378 replay_opts_release(&replay_opts);
379 break;
380 }
381 case ACTION_SHOW_CURRENT_PATCH: {
382 struct child_process cmd = CHILD_PROCESS_INIT;
383
384 cmd.git_cmd = 1;
385 strvec_pushl(&cmd.args, "show", "REBASE_HEAD", "--", NULL);
386 ret = run_command(&cmd);
387
388 break;
389 }
390 default:
391 BUG("invalid command '%d'", opts->action);
392 }
393
394 return ret;
395}
396
397static int is_merge(struct rebase_options *opts)
398{
399 return opts->type == REBASE_MERGE;
400}
401
402static void imply_merge(struct rebase_options *opts, const char *option)
403{
404 switch (opts->type) {
405 case REBASE_APPLY:
406 die(_("%s requires the merge backend"), option);
407 break;
408 case REBASE_MERGE:
409 break;
410 default:
411 opts->type = REBASE_MERGE; /* implied */
412 break;
413 }
414}
415
416/* Returns the filename prefixed by the state_dir */
417static const char *state_dir_path(const char *filename, struct rebase_options *opts)
418{
419 static struct strbuf path = STRBUF_INIT;
420 static size_t prefix_len;
421
422 if (!prefix_len) {
423 strbuf_addf(&path, "%s/", opts->state_dir);
424 prefix_len = path.len;
425 }
426
427 strbuf_setlen(&path, prefix_len);
428 strbuf_addstr(&path, filename);
429 return path.buf;
430}
431
432/* Initialize the rebase options from the state directory. */
433static int read_basic_state(struct rebase_options *opts)
434{
435 struct strbuf head_name = STRBUF_INIT;
436 struct strbuf buf = STRBUF_INIT;
437 struct object_id oid;
438
439 if (!read_oneliner(&head_name, state_dir_path("head-name", opts),
440 READ_ONELINER_WARN_MISSING) ||
441 !read_oneliner(&buf, state_dir_path("onto", opts),
442 READ_ONELINER_WARN_MISSING))
443 return -1;
444 opts->head_name = starts_with(head_name.buf, "refs/") ?
445 xstrdup(head_name.buf) : NULL;
446 strbuf_release(&head_name);
447 if (get_oid_hex(buf.buf, &oid) ||
448 !(opts->onto = lookup_commit_object(the_repository, &oid)))
449 return error(_("invalid onto: '%s'"), buf.buf);
450
451 /*
452 * We always write to orig-head, but interactive rebase used to write to
453 * head. Fall back to reading from head to cover for the case that the
454 * user upgraded git with an ongoing interactive rebase.
455 */
456 strbuf_reset(&buf);
457 if (file_exists(state_dir_path("orig-head", opts))) {
458 if (!read_oneliner(&buf, state_dir_path("orig-head", opts),
459 READ_ONELINER_WARN_MISSING))
460 return -1;
461 } else if (!read_oneliner(&buf, state_dir_path("head", opts),
462 READ_ONELINER_WARN_MISSING))
463 return -1;
464 if (get_oid_hex(buf.buf, &oid) ||
465 !(opts->orig_head = lookup_commit_object(the_repository, &oid)))
466 return error(_("invalid orig-head: '%s'"), buf.buf);
467
468 if (file_exists(state_dir_path("quiet", opts)))
469 opts->flags &= ~REBASE_NO_QUIET;
470 else
471 opts->flags |= REBASE_NO_QUIET;
472
473 if (file_exists(state_dir_path("verbose", opts)))
474 opts->flags |= REBASE_VERBOSE;
475
476 if (file_exists(state_dir_path("signoff", opts))) {
477 opts->signoff = 1;
478 opts->flags |= REBASE_FORCE;
479 }
480
481 if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
482 strbuf_reset(&buf);
483 if (!read_oneliner(&buf, state_dir_path("allow_rerere_autoupdate", opts),
484 READ_ONELINER_WARN_MISSING))
485 return -1;
486 if (!strcmp(buf.buf, "--rerere-autoupdate"))
487 opts->allow_rerere_autoupdate = RERERE_AUTOUPDATE;
488 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
489 opts->allow_rerere_autoupdate = RERERE_NOAUTOUPDATE;
490 else
491 warning(_("ignoring invalid allow_rerere_autoupdate: "
492 "'%s'"), buf.buf);
493 }
494
495 if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
496 strbuf_reset(&buf);
497 if (!read_oneliner(&buf, state_dir_path("gpg_sign_opt", opts),
498 READ_ONELINER_WARN_MISSING))
499 return -1;
500 free(opts->gpg_sign_opt);
501 opts->gpg_sign_opt = xstrdup(buf.buf);
502 }
503
504 strbuf_release(&buf);
505
506 return 0;
507}
508
509static int rebase_write_basic_state(struct rebase_options *opts)
510{
511 write_file(state_dir_path("head-name", opts), "%s",
512 opts->head_name ? opts->head_name : "detached HEAD");
513 write_file(state_dir_path("onto", opts), "%s",
514 opts->onto ? oid_to_hex(&opts->onto->object.oid) : "");
515 write_file(state_dir_path("orig-head", opts), "%s",
516 oid_to_hex(&opts->orig_head->object.oid));
517 if (!(opts->flags & REBASE_NO_QUIET))
518 write_file(state_dir_path("quiet", opts), "%s", "");
519 if (opts->flags & REBASE_VERBOSE)
520 write_file(state_dir_path("verbose", opts), "%s", "");
521 if (opts->allow_rerere_autoupdate > 0)
522 write_file(state_dir_path("allow_rerere_autoupdate", opts),
523 "-%s-rerere-autoupdate",
524 opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
525 "" : "-no");
526 if (opts->gpg_sign_opt)
527 write_file(state_dir_path("gpg_sign_opt", opts), "%s",
528 opts->gpg_sign_opt);
529 if (opts->signoff)
530 write_file(state_dir_path("signoff", opts), "--signoff");
531
532 return 0;
533}
534
535static int cleanup_autostash(struct rebase_options *opts)
536{
537 int ret;
538 struct strbuf dir = STRBUF_INIT;
539 const char *path = state_dir_path("autostash", opts);
540
541 if (!file_exists(path))
542 return 0;
543 ret = apply_autostash(path);
544 strbuf_addstr(&dir, opts->state_dir);
545 if (remove_dir_recursively(&dir, 0))
546 ret = error_errno(_("could not remove '%s'"), opts->state_dir);
547 strbuf_release(&dir);
548
549 return ret;
550}
551
552static int finish_rebase(struct rebase_options *opts)
553{
554 struct strbuf dir = STRBUF_INIT;
555 int ret = 0;
556
557 refs_delete_ref(get_main_ref_store(the_repository), NULL,
558 "REBASE_HEAD", NULL, REF_NO_DEREF);
559 refs_delete_ref(get_main_ref_store(the_repository), NULL,
560 "AUTO_MERGE", NULL, REF_NO_DEREF);
561 apply_autostash(state_dir_path("autostash", opts));
562 /*
563 * We ignore errors in 'git maintenance run --auto', since the
564 * user should see them.
565 */
566 run_auto_maintenance(!(opts->flags & (REBASE_NO_QUIET|REBASE_VERBOSE)));
567 if (opts->type == REBASE_MERGE) {
568 struct replay_opts replay = REPLAY_OPTS_INIT;
569
570 replay.action = REPLAY_INTERACTIVE_REBASE;
571 ret = sequencer_remove_state(&replay);
572 replay_opts_release(&replay);
573 } else {
574 strbuf_addstr(&dir, opts->state_dir);
575 if (remove_dir_recursively(&dir, 0))
576 ret = error(_("could not remove '%s'"),
577 opts->state_dir);
578 strbuf_release(&dir);
579 }
580
581 return ret;
582}
583
584static int move_to_original_branch(struct rebase_options *opts)
585{
586 struct strbuf branch_reflog = STRBUF_INIT, head_reflog = STRBUF_INIT;
587 struct reset_head_opts ropts = { 0 };
588 int ret;
589
590 if (!opts->head_name)
591 return 0; /* nothing to move back to */
592
593 if (!opts->onto)
594 BUG("move_to_original_branch without onto");
595
596 strbuf_addf(&branch_reflog, "%s (finish): %s onto %s",
597 opts->reflog_action,
598 opts->head_name, oid_to_hex(&opts->onto->object.oid));
599 strbuf_addf(&head_reflog, "%s (finish): returning to %s",
600 opts->reflog_action, opts->head_name);
601 ropts.branch = opts->head_name;
602 ropts.flags = RESET_HEAD_REFS_ONLY;
603 ropts.branch_msg = branch_reflog.buf;
604 ropts.head_msg = head_reflog.buf;
605 ret = reset_head(the_repository, &ropts);
606
607 strbuf_release(&branch_reflog);
608 strbuf_release(&head_reflog);
609 return ret;
610}
611
612static int run_am(struct rebase_options *opts)
613{
614 struct child_process am = CHILD_PROCESS_INIT;
615 struct child_process format_patch = CHILD_PROCESS_INIT;
616 int status;
617 char *rebased_patches;
618
619 am.git_cmd = 1;
620 strvec_push(&am.args, "am");
621 strvec_pushf(&am.env, GIT_REFLOG_ACTION_ENVIRONMENT "=%s (pick)",
622 opts->reflog_action);
623 if (opts->action == ACTION_CONTINUE) {
624 strvec_push(&am.args, "--resolved");
625 strvec_pushf(&am.args, "--resolvemsg=%s", rebase_resolvemsg);
626 if (opts->gpg_sign_opt)
627 strvec_push(&am.args, opts->gpg_sign_opt);
628 status = run_command(&am);
629 if (status)
630 return status;
631
632 return move_to_original_branch(opts);
633 }
634 if (opts->action == ACTION_SKIP) {
635 strvec_push(&am.args, "--skip");
636 strvec_pushf(&am.args, "--resolvemsg=%s", rebase_resolvemsg);
637 status = run_command(&am);
638 if (status)
639 return status;
640
641 return move_to_original_branch(opts);
642 }
643 if (opts->action == ACTION_SHOW_CURRENT_PATCH) {
644 strvec_push(&am.args, "--show-current-patch");
645 return run_command(&am);
646 }
647
648 rebased_patches = repo_git_path(the_repository, "rebased-patches");
649 format_patch.out = open(rebased_patches,
650 O_WRONLY | O_CREAT | O_TRUNC, 0666);
651 if (format_patch.out < 0) {
652 status = error_errno(_("could not open '%s' for writing"),
653 rebased_patches);
654 free(rebased_patches);
655 child_process_clear(&am);
656 return status;
657 }
658
659 format_patch.git_cmd = 1;
660 strvec_pushl(&format_patch.args, "format-patch", "-k", "--stdout",
661 "--full-index", "--cherry-pick", "--right-only",
662 "--default-prefix", "--no-renames",
663 "--no-cover-letter", "--pretty=mboxrd", "--topo-order",
664 "--no-base", NULL);
665 if (opts->git_format_patch_opt.len)
666 strvec_split(&format_patch.args,
667 opts->git_format_patch_opt.buf);
668 strvec_pushf(&format_patch.args, "%s...%s",
669 oid_to_hex(opts->root ?
670 /* this is now equivalent to !opts->upstream */
671 &opts->onto->object.oid :
672 &opts->upstream->object.oid),
673 oid_to_hex(&opts->orig_head->object.oid));
674 if (opts->restrict_revision)
675 strvec_pushf(&format_patch.args, "^%s",
676 oid_to_hex(&opts->restrict_revision->object.oid));
677
678 status = run_command(&format_patch);
679 if (status) {
680 struct reset_head_opts ropts = { 0 };
681 unlink(rebased_patches);
682 free(rebased_patches);
683 child_process_clear(&am);
684
685 ropts.oid = &opts->orig_head->object.oid;
686 ropts.branch = opts->head_name;
687 ropts.default_reflog_action = opts->reflog_action;
688 reset_head(the_repository, &ropts);
689 error(_("\ngit encountered an error while preparing the "
690 "patches to replay\n"
691 "these revisions:\n"
692 "\n %s\n\n"
693 "As a result, git cannot rebase them."),
694 opts->revisions);
695
696 return status;
697 }
698
699 am.in = open(rebased_patches, O_RDONLY);
700 if (am.in < 0) {
701 status = error_errno(_("could not open '%s' for reading"),
702 rebased_patches);
703 free(rebased_patches);
704 child_process_clear(&am);
705 return status;
706 }
707
708 strvec_pushv(&am.args, opts->git_am_opts.v);
709 strvec_push(&am.args, "--rebasing");
710 strvec_pushf(&am.args, "--resolvemsg=%s", rebase_resolvemsg);
711 strvec_push(&am.args, "--patch-format=mboxrd");
712 if (opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE)
713 strvec_push(&am.args, "--rerere-autoupdate");
714 else if (opts->allow_rerere_autoupdate == RERERE_NOAUTOUPDATE)
715 strvec_push(&am.args, "--no-rerere-autoupdate");
716 if (opts->gpg_sign_opt)
717 strvec_push(&am.args, opts->gpg_sign_opt);
718 status = run_command(&am);
719 unlink(rebased_patches);
720 free(rebased_patches);
721
722 if (!status) {
723 return move_to_original_branch(opts);
724 }
725
726 if (is_directory(opts->state_dir))
727 rebase_write_basic_state(opts);
728
729 return status;
730}
731
732static int run_specific_rebase(struct rebase_options *opts)
733{
734 int status;
735
736 if (opts->type == REBASE_MERGE) {
737 /* Run sequencer-based rebase */
738 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT))
739 setenv("GIT_SEQUENCE_EDITOR", ":", 1);
740 if (opts->gpg_sign_opt) {
741 /* remove the leading "-S" */
742 char *tmp = xstrdup(opts->gpg_sign_opt + 2);
743 free(opts->gpg_sign_opt);
744 opts->gpg_sign_opt = tmp;
745 }
746
747 status = run_sequencer_rebase(opts);
748 } else if (opts->type == REBASE_APPLY)
749 status = run_am(opts);
750 else
751 BUG("Unhandled rebase type %d", opts->type);
752
753 if (opts->dont_finish_rebase)
754 ; /* do nothing */
755 else if (opts->type == REBASE_MERGE)
756 ; /* merge backend cleans up after itself */
757 else if (status == 0) {
758 if (!file_exists(state_dir_path("stopped-sha", opts)))
759 finish_rebase(opts);
760 } else if (status == 2) {
761 struct strbuf dir = STRBUF_INIT;
762
763 apply_autostash(state_dir_path("autostash", opts));
764 strbuf_addstr(&dir, opts->state_dir);
765 remove_dir_recursively(&dir, 0);
766 strbuf_release(&dir);
767 die("Nothing to do");
768 }
769
770 return status ? -1 : 0;
771}
772
773static void parse_rebase_merges_value(struct rebase_options *options, const char *value)
774{
775 if (!strcmp("no-rebase-cousins", value))
776 options->rebase_cousins = 0;
777 else if (!strcmp("rebase-cousins", value))
778 options->rebase_cousins = 1;
779 else
780 die(_("Unknown rebase-merges mode: %s"), value);
781}
782
783static int rebase_config(const char *var, const char *value,
784 const struct config_context *ctx, void *data)
785{
786 struct rebase_options *opts = data;
787
788 if (!strcmp(var, "rebase.stat")) {
789 if (git_config_bool(var, value))
790 opts->flags |= REBASE_DIFFSTAT;
791 else
792 opts->flags &= ~REBASE_DIFFSTAT;
793 return 0;
794 }
795
796 if (!strcmp(var, "rebase.autosquash")) {
797 opts->config_autosquash = git_config_bool(var, value);
798 return 0;
799 }
800
801 if (!strcmp(var, "commit.gpgsign")) {
802 free(opts->gpg_sign_opt);
803 opts->gpg_sign_opt = git_config_bool(var, value) ?
804 xstrdup("-S") : NULL;
805 return 0;
806 }
807
808 if (!strcmp(var, "rebase.autostash")) {
809 opts->autostash = git_config_bool(var, value);
810 return 0;
811 }
812
813 if (!strcmp(var, "rebase.rebasemerges")) {
814 opts->config_rebase_merges = git_parse_maybe_bool(value);
815 if (opts->config_rebase_merges < 0) {
816 opts->config_rebase_merges = 1;
817 parse_rebase_merges_value(opts, value);
818 } else {
819 opts->rebase_cousins = 0;
820 }
821 return 0;
822 }
823
824 if (!strcmp(var, "rebase.updaterefs")) {
825 opts->config_update_refs = git_config_bool(var, value);
826 return 0;
827 }
828
829 if (!strcmp(var, "rebase.reschedulefailedexec")) {
830 opts->reschedule_failed_exec = git_config_bool(var, value);
831 return 0;
832 }
833
834 if (!strcmp(var, "rebase.forkpoint")) {
835 opts->fork_point = git_config_bool(var, value) ? -1 : 0;
836 return 0;
837 }
838
839 if (!strcmp(var, "rebase.backend")) {
840 FREE_AND_NULL(opts->default_backend);
841 return git_config_string(&opts->default_backend, var, value);
842 }
843
844 return git_default_config(var, value, ctx, data);
845}
846
847static int checkout_up_to_date(struct rebase_options *options)
848{
849 struct strbuf buf = STRBUF_INIT;
850 struct reset_head_opts ropts = { 0 };
851 int ret = 0;
852
853 strbuf_addf(&buf, "%s: checkout %s",
854 options->reflog_action, options->switch_to);
855 ropts.oid = &options->orig_head->object.oid;
856 ropts.branch = options->head_name;
857 ropts.flags = RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
858 if (!ropts.branch)
859 ropts.flags |= RESET_HEAD_DETACH;
860 ropts.head_msg = buf.buf;
861 if (reset_head(the_repository, &ropts) < 0)
862 ret = error(_("could not switch to %s"), options->switch_to);
863 strbuf_release(&buf);
864
865 return ret;
866}
867
868/*
869 * Determines whether the commits in from..to are linear, i.e. contain
870 * no merge commits. This function *expects* `from` to be an ancestor of
871 * `to`.
872 */
873static int is_linear_history(struct commit *from, struct commit *to)
874{
875 while (to && to != from) {
876 repo_parse_commit(the_repository, to);
877 if (!to->parents)
878 return 1;
879 if (to->parents->next)
880 return 0;
881 to = to->parents->item;
882 }
883 return 1;
884}
885
886static int can_fast_forward(struct commit *onto, struct commit *upstream,
887 struct commit *restrict_revision,
888 struct commit *head, struct object_id *branch_base)
889{
890 struct commit_list *merge_bases = NULL;
891 int res = 0;
892
893 if (is_null_oid(branch_base))
894 goto done; /* fill_branch_base() found multiple merge bases */
895
896 if (!oideq(branch_base, &onto->object.oid))
897 goto done;
898
899 if (restrict_revision && !oideq(&restrict_revision->object.oid, branch_base))
900 goto done;
901
902 if (!upstream)
903 goto done;
904
905 if (repo_get_merge_bases(the_repository, upstream, head, &merge_bases) < 0)
906 exit(128);
907 if (!merge_bases || merge_bases->next)
908 goto done;
909
910 if (!oideq(&onto->object.oid, &merge_bases->item->object.oid))
911 goto done;
912
913 res = 1;
914
915done:
916 free_commit_list(merge_bases);
917 return res && is_linear_history(onto, head);
918}
919
920static void fill_branch_base(struct rebase_options *options,
921 struct object_id *branch_base)
922{
923 struct commit_list *merge_bases = NULL;
924
925 if (repo_get_merge_bases(the_repository, options->onto,
926 options->orig_head, &merge_bases) < 0)
927 exit(128);
928 if (!merge_bases || merge_bases->next)
929 oidcpy(branch_base, null_oid(the_hash_algo));
930 else
931 oidcpy(branch_base, &merge_bases->item->object.oid);
932
933 free_commit_list(merge_bases);
934}
935
936static int parse_opt_am(const struct option *opt, const char *arg, int unset)
937{
938 struct rebase_options *opts = opt->value;
939
940 BUG_ON_OPT_NEG(unset);
941 BUG_ON_OPT_ARG(arg);
942
943 if (opts->type != REBASE_UNSPECIFIED && opts->type != REBASE_APPLY)
944 die(_("apply options and merge options cannot be used together"));
945
946 opts->type = REBASE_APPLY;
947
948 return 0;
949}
950
951/* -i followed by -m is still -i */
952static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
953{
954 struct rebase_options *opts = opt->value;
955
956 BUG_ON_OPT_NEG(unset);
957 BUG_ON_OPT_ARG(arg);
958
959 if (opts->type != REBASE_UNSPECIFIED && opts->type != REBASE_MERGE)
960 die(_("apply options and merge options cannot be used together"));
961
962 opts->type = REBASE_MERGE;
963
964 return 0;
965}
966
967/* -i followed by -r is still explicitly interactive, but -r alone is not */
968static int parse_opt_interactive(const struct option *opt, const char *arg,
969 int unset)
970{
971 struct rebase_options *opts = opt->value;
972
973 BUG_ON_OPT_NEG(unset);
974 BUG_ON_OPT_ARG(arg);
975
976 if (opts->type != REBASE_UNSPECIFIED && opts->type != REBASE_MERGE)
977 die(_("apply options and merge options cannot be used together"));
978
979 opts->type = REBASE_MERGE;
980 opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
981
982 return 0;
983}
984
985static enum empty_type parse_empty_value(const char *value)
986{
987 if (!strcasecmp(value, "drop"))
988 return EMPTY_DROP;
989 else if (!strcasecmp(value, "keep"))
990 return EMPTY_KEEP;
991 else if (!strcasecmp(value, "stop"))
992 return EMPTY_STOP;
993 else if (!strcasecmp(value, "ask")) {
994 warning(_("--empty=ask is deprecated; use '--empty=stop' instead."));
995 return EMPTY_STOP;
996 }
997
998 die(_("unrecognized empty type '%s'; valid values are \"drop\", \"keep\", and \"stop\"."), value);
999}
1000
1001static int parse_opt_keep_empty(const struct option *opt, const char *arg,
1002 int unset)
1003{
1004 struct rebase_options *opts = opt->value;
1005
1006 BUG_ON_OPT_ARG(arg);
1007
1008 imply_merge(opts, unset ? "--no-keep-empty" : "--keep-empty");
1009 opts->keep_empty = !unset;
1010 return 0;
1011}
1012
1013static int parse_opt_empty(const struct option *opt, const char *arg, int unset)
1014{
1015 struct rebase_options *options = opt->value;
1016 enum empty_type value = parse_empty_value(arg);
1017
1018 BUG_ON_OPT_NEG(unset);
1019
1020 options->empty = value;
1021 return 0;
1022}
1023
1024static int parse_opt_rebase_merges(const struct option *opt, const char *arg, int unset)
1025{
1026 struct rebase_options *options = opt->value;
1027
1028 options->rebase_merges = !unset;
1029 options->rebase_cousins = 0;
1030
1031 if (arg) {
1032 if (!*arg) {
1033 warning(_("--rebase-merges with an empty string "
1034 "argument is deprecated and will stop "
1035 "working in a future version of Git. Use "
1036 "--rebase-merges without an argument "
1037 "instead, which does the same thing."));
1038 return 0;
1039 }
1040 parse_rebase_merges_value(options, arg);
1041 }
1042
1043 return 0;
1044}
1045
1046static void NORETURN error_on_missing_default_upstream(void)
1047{
1048 struct branch *current_branch = branch_get(NULL);
1049
1050 printf(_("%s\n"
1051 "Please specify which branch you want to rebase against.\n"
1052 "See git-rebase(1) for details.\n"
1053 "\n"
1054 " git rebase '<branch>'\n"
1055 "\n"),
1056 current_branch ? _("There is no tracking information for "
1057 "the current branch.") :
1058 _("You are not currently on a branch."));
1059
1060 if (current_branch) {
1061 const char *remote = current_branch->remote_name;
1062
1063 if (!remote)
1064 remote = _("<remote>");
1065
1066 printf(_("If you wish to set tracking information for this "
1067 "branch you can do so with:\n"
1068 "\n"
1069 " git branch --set-upstream-to=%s/<branch> %s\n"
1070 "\n"),
1071 remote, current_branch->name);
1072 }
1073 exit(1);
1074}
1075
1076static int check_exec_cmd(const char *cmd)
1077{
1078 if (strchr(cmd, '\n'))
1079 return error(_("exec commands cannot contain newlines"));
1080
1081 /* Does the command consist purely of whitespace? */
1082 if (!cmd[strspn(cmd, " \t\r\f\v")])
1083 return error(_("empty exec command"));
1084
1085 return 0;
1086}
1087
1088int cmd_rebase(int argc,
1089 const char **argv,
1090 const char *prefix,
1091 struct repository *repo UNUSED)
1092{
1093 struct rebase_options options = REBASE_OPTIONS_INIT;
1094 const char *branch_name;
1095 const char *strategy_opt = NULL;
1096 int ret, flags, total_argc, in_progress = 0;
1097 int keep_base = 0;
1098 int ok_to_skip_pre_rebase = 0;
1099 struct strbuf msg = STRBUF_INIT;
1100 struct strbuf revisions = STRBUF_INIT;
1101 struct strbuf buf = STRBUF_INIT;
1102 struct object_id branch_base;
1103 int ignore_whitespace = 0;
1104 const char *gpg_sign = NULL;
1105 struct object_id squash_onto;
1106 char *squash_onto_name = NULL;
1107 char *keep_base_onto_name = NULL;
1108 int reschedule_failed_exec = -1;
1109 int allow_preemptive_ff = 1;
1110 int preserve_merges_selected = 0;
1111 struct reset_head_opts ropts = { 0 };
1112 struct option builtin_rebase_options[] = {
1113 OPT_STRING(0, "onto", &options.onto_name,
1114 N_("revision"),
1115 N_("rebase onto given branch instead of upstream")),
1116 OPT_BOOL(0, "keep-base", &keep_base,
1117 N_("use the merge-base of upstream and branch as the current base")),
1118 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
1119 N_("allow pre-rebase hook to run")),
1120 OPT_NEGBIT('q', "quiet", &options.flags,
1121 N_("be quiet. implies --no-stat"),
1122 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1123 OPT_BIT('v', "verbose", &options.flags,
1124 N_("display a diffstat of what changed upstream"),
1125 REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1126 {
1127 .type = OPTION_NEGBIT,
1128 .short_name = 'n',
1129 .long_name = "no-stat",
1130 .value = &options.flags,
1131 .precision = sizeof(options.flags),
1132 .help = N_("do not show diffstat of what changed upstream"),
1133 .flags = PARSE_OPT_NOARG,
1134 .defval = REBASE_DIFFSTAT,
1135 },
1136 OPT_BOOL(0, "signoff", &options.signoff,
1137 N_("add a Signed-off-by trailer to each commit")),
1138 OPT_BOOL(0, "committer-date-is-author-date",
1139 &options.committer_date_is_author_date,
1140 N_("make committer date match author date")),
1141 OPT_BOOL(0, "reset-author-date", &options.ignore_date,
1142 N_("ignore author date and use current date")),
1143 OPT_HIDDEN_BOOL(0, "ignore-date", &options.ignore_date,
1144 N_("synonym of --reset-author-date")),
1145 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
1146 N_("passed to 'git apply'"), 0),
1147 OPT_BOOL(0, "ignore-whitespace", &ignore_whitespace,
1148 N_("ignore changes in whitespace")),
1149 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
1150 N_("action"), N_("passed to 'git apply'"), 0),
1151 OPT_BIT('f', "force-rebase", &options.flags,
1152 N_("cherry-pick all commits, even if unchanged"),
1153 REBASE_FORCE),
1154 OPT_BIT(0, "no-ff", &options.flags,
1155 N_("cherry-pick all commits, even if unchanged"),
1156 REBASE_FORCE),
1157 OPT_CMDMODE(0, "continue", &options.action, N_("continue"),
1158 ACTION_CONTINUE),
1159 OPT_CMDMODE(0, "skip", &options.action,
1160 N_("skip current patch and continue"), ACTION_SKIP),
1161 OPT_CMDMODE(0, "abort", &options.action,
1162 N_("abort and check out the original branch"),
1163 ACTION_ABORT),
1164 OPT_CMDMODE(0, "quit", &options.action,
1165 N_("abort but keep HEAD where it is"), ACTION_QUIT),
1166 OPT_CMDMODE(0, "edit-todo", &options.action, N_("edit the todo list "
1167 "during an interactive rebase"), ACTION_EDIT_TODO),
1168 OPT_CMDMODE(0, "show-current-patch", &options.action,
1169 N_("show the patch file being applied or merged"),
1170 ACTION_SHOW_CURRENT_PATCH),
1171 OPT_CALLBACK_F(0, "apply", &options, NULL,
1172 N_("use apply strategies to rebase"),
1173 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1174 parse_opt_am),
1175 OPT_CALLBACK_F('m', "merge", &options, NULL,
1176 N_("use merging strategies to rebase"),
1177 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1178 parse_opt_merge),
1179 OPT_CALLBACK_F('i', "interactive", &options, NULL,
1180 N_("let the user edit the list of commits to rebase"),
1181 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1182 parse_opt_interactive),
1183 OPT_SET_INT_F('p', "preserve-merges", &preserve_merges_selected,
1184 N_("(REMOVED) was: try to recreate merges "
1185 "instead of ignoring them"),
1186 1, PARSE_OPT_HIDDEN),
1187 OPT_RERERE_AUTOUPDATE(&options.allow_rerere_autoupdate),
1188 OPT_CALLBACK_F(0, "empty", &options, "(drop|keep|stop)",
1189 N_("how to handle commits that become empty"),
1190 PARSE_OPT_NONEG, parse_opt_empty),
1191 OPT_CALLBACK_F('k', "keep-empty", &options, NULL,
1192 N_("keep commits which start empty"),
1193 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN,
1194 parse_opt_keep_empty),
1195 OPT_BOOL(0, "autosquash", &options.autosquash,
1196 N_("move commits that begin with "
1197 "squash!/fixup! under -i")),
1198 OPT_BOOL(0, "update-refs", &options.update_refs,
1199 N_("update branches that point to commits "
1200 "that are being rebased")),
1201 {
1202 .type = OPTION_STRING,
1203 .short_name = 'S',
1204 .long_name = "gpg-sign",
1205 .value = &gpg_sign,
1206 .argh = N_("key-id"),
1207 .help = N_("GPG-sign commits"),
1208 .flags = PARSE_OPT_OPTARG,
1209 .defval = (intptr_t) "",
1210 },
1211 OPT_AUTOSTASH(&options.autostash),
1212 OPT_STRING_LIST('x', "exec", &options.exec, N_("exec"),
1213 N_("add exec lines after each commit of the "
1214 "editable list")),
1215 OPT_BOOL_F(0, "allow-empty-message",
1216 &options.allow_empty_message,
1217 N_("allow rebasing commits with empty messages"),
1218 PARSE_OPT_HIDDEN),
1219 OPT_CALLBACK_F('r', "rebase-merges", &options, N_("mode"),
1220 N_("try to rebase merges instead of skipping them"),
1221 PARSE_OPT_OPTARG, parse_opt_rebase_merges),
1222 OPT_BOOL(0, "fork-point", &options.fork_point,
1223 N_("use 'merge-base --fork-point' to refine upstream")),
1224 OPT_STRING('s', "strategy", &strategy_opt,
1225 N_("strategy"), N_("use the given merge strategy")),
1226 OPT_STRING_LIST('X', "strategy-option", &options.strategy_opts,
1227 N_("option"),
1228 N_("pass the argument through to the merge "
1229 "strategy")),
1230 OPT_BOOL(0, "root", &options.root,
1231 N_("rebase all reachable commits up to the root(s)")),
1232 OPT_BOOL(0, "reschedule-failed-exec",
1233 &reschedule_failed_exec,
1234 N_("automatically re-schedule any `exec` that fails")),
1235 OPT_BOOL(0, "reapply-cherry-picks", &options.reapply_cherry_picks,
1236 N_("apply all changes, even those already present upstream")),
1237 OPT_END(),
1238 };
1239 int i;
1240
1241 show_usage_with_options_if_asked(argc, argv,
1242 builtin_rebase_usage,
1243 builtin_rebase_options);
1244
1245 prepare_repo_settings(the_repository);
1246 the_repository->settings.command_requires_full_index = 0;
1247
1248 repo_config(the_repository, rebase_config, &options);
1249 /* options.gpg_sign_opt will be either "-S" or NULL */
1250 gpg_sign = options.gpg_sign_opt ? "" : NULL;
1251 FREE_AND_NULL(options.gpg_sign_opt);
1252
1253 strbuf_reset(&buf);
1254 strbuf_addf(&buf, "%s/applying", apply_dir());
1255 if(file_exists(buf.buf))
1256 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1257
1258 if (is_directory(apply_dir())) {
1259 options.type = REBASE_APPLY;
1260 options.state_dir = apply_dir();
1261 } else if (is_directory(merge_dir())) {
1262 strbuf_reset(&buf);
1263 strbuf_addf(&buf, "%s/rewritten", merge_dir());
1264 if (!(options.action == ACTION_ABORT) && is_directory(buf.buf)) {
1265 die(_("`rebase --preserve-merges` (-p) is no longer supported.\n"
1266 "Use `git rebase --abort` to terminate current rebase.\n"
1267 "Or downgrade to v2.33, or earlier, to complete the rebase."));
1268 } else {
1269 strbuf_reset(&buf);
1270 strbuf_addf(&buf, "%s/interactive", merge_dir());
1271 options.type = REBASE_MERGE;
1272 if (file_exists(buf.buf))
1273 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1274 }
1275 options.state_dir = merge_dir();
1276 }
1277
1278 if (options.type != REBASE_UNSPECIFIED)
1279 in_progress = 1;
1280
1281 total_argc = argc;
1282 argc = parse_options(argc, argv, prefix,
1283 builtin_rebase_options,
1284 builtin_rebase_usage, 0);
1285
1286 if (preserve_merges_selected)
1287 die(_("--preserve-merges was replaced by --rebase-merges\n"
1288 "Note: Your `pull.rebase` configuration may also be set to 'preserve',\n"
1289 "which is no longer supported; use 'merges' instead"));
1290
1291 if (options.action != ACTION_NONE && total_argc != 2) {
1292 usage_with_options(builtin_rebase_usage,
1293 builtin_rebase_options);
1294 }
1295
1296 if (argc > 2)
1297 usage_with_options(builtin_rebase_usage,
1298 builtin_rebase_options);
1299
1300 if (keep_base) {
1301 if (options.onto_name)
1302 die(_("options '%s' and '%s' cannot be used together"), "--keep-base", "--onto");
1303 if (options.root)
1304 die(_("options '%s' and '%s' cannot be used together"), "--keep-base", "--root");
1305 /*
1306 * --keep-base defaults to --no-fork-point to keep the
1307 * base the same.
1308 */
1309 if (options.fork_point < 0)
1310 options.fork_point = 0;
1311 }
1312 if (options.root && options.fork_point > 0)
1313 die(_("options '%s' and '%s' cannot be used together"), "--root", "--fork-point");
1314
1315 if (options.action != ACTION_NONE && !in_progress)
1316 die(_("no rebase in progress"));
1317
1318 if (options.action == ACTION_EDIT_TODO && !is_merge(&options))
1319 die(_("The --edit-todo action can only be used during "
1320 "interactive rebase."));
1321
1322 if (trace2_is_enabled()) {
1323 if (is_merge(&options))
1324 trace2_cmd_mode("interactive");
1325 else if (options.exec.nr)
1326 trace2_cmd_mode("interactive-exec");
1327 else
1328 trace2_cmd_mode(action_names[options.action]);
1329 }
1330
1331 options.reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
1332 options.reflog_action =
1333 xstrdup(options.reflog_action ? options.reflog_action : "rebase");
1334
1335 switch (options.action) {
1336 case ACTION_CONTINUE: {
1337 struct object_id head;
1338 struct lock_file lock_file = LOCK_INIT;
1339 int fd;
1340
1341 /* Sanity check */
1342 if (repo_get_oid(the_repository, "HEAD", &head))
1343 die(_("Cannot read HEAD"));
1344
1345 fd = repo_hold_locked_index(the_repository, &lock_file, 0);
1346 if (repo_read_index(the_repository) < 0)
1347 die(_("could not read index"));
1348 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1349 NULL);
1350 if (0 <= fd)
1351 repo_update_index_if_able(the_repository, &lock_file);
1352 rollback_lock_file(&lock_file);
1353
1354 if (has_unstaged_changes(the_repository, 1)) {
1355 puts(_("You must edit all merge conflicts and then\n"
1356 "mark them as resolved using git add"));
1357 exit(1);
1358 }
1359 if (read_basic_state(&options))
1360 exit(1);
1361 goto run_rebase;
1362 }
1363 case ACTION_SKIP: {
1364 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1365
1366 rerere_clear(the_repository, &merge_rr);
1367 string_list_clear(&merge_rr, 1);
1368 ropts.flags = RESET_HEAD_HARD;
1369 if (reset_head(the_repository, &ropts) < 0)
1370 die(_("could not discard worktree changes"));
1371 remove_branch_state(the_repository, 0);
1372 if (read_basic_state(&options))
1373 exit(1);
1374 goto run_rebase;
1375 }
1376 case ACTION_ABORT: {
1377 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1378 struct strbuf head_msg = STRBUF_INIT;
1379
1380 rerere_clear(the_repository, &merge_rr);
1381 string_list_clear(&merge_rr, 1);
1382
1383 if (read_basic_state(&options))
1384 exit(1);
1385
1386 strbuf_addf(&head_msg, "%s (abort): returning to %s",
1387 options.reflog_action,
1388 options.head_name ? options.head_name
1389 : oid_to_hex(&options.orig_head->object.oid));
1390 ropts.oid = &options.orig_head->object.oid;
1391 ropts.head_msg = head_msg.buf;
1392 ropts.branch = options.head_name;
1393 ropts.flags = RESET_HEAD_HARD;
1394 if (reset_head(the_repository, &ropts) < 0)
1395 die(_("could not move back to %s"),
1396 oid_to_hex(&options.orig_head->object.oid));
1397 strbuf_release(&head_msg);
1398 remove_branch_state(the_repository, 0);
1399 ret = finish_rebase(&options);
1400 goto cleanup;
1401 }
1402 case ACTION_QUIT: {
1403 save_autostash(state_dir_path("autostash", &options));
1404 if (options.type == REBASE_MERGE) {
1405 struct replay_opts replay = REPLAY_OPTS_INIT;
1406
1407 replay.action = REPLAY_INTERACTIVE_REBASE;
1408 ret = sequencer_remove_state(&replay);
1409 replay_opts_release(&replay);
1410 } else {
1411 strbuf_reset(&buf);
1412 strbuf_addstr(&buf, options.state_dir);
1413 ret = remove_dir_recursively(&buf, 0);
1414 if (ret)
1415 error(_("could not remove '%s'"),
1416 options.state_dir);
1417 }
1418 goto cleanup;
1419 }
1420 case ACTION_EDIT_TODO:
1421 options.dont_finish_rebase = 1;
1422 goto run_rebase;
1423 case ACTION_SHOW_CURRENT_PATCH:
1424 options.dont_finish_rebase = 1;
1425 goto run_rebase;
1426 case ACTION_NONE:
1427 break;
1428 default:
1429 BUG("action: %d", options.action);
1430 }
1431
1432 /* Make sure no rebase is in progress */
1433 if (in_progress) {
1434 const char *last_slash = strrchr(options.state_dir, '/');
1435 const char *state_dir_base =
1436 last_slash ? last_slash + 1 : options.state_dir;
1437 const char *cmd_live_rebase =
1438 "git rebase (--continue | --abort | --skip)";
1439 strbuf_reset(&buf);
1440 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1441 die(_("It seems that there is already a %s directory, and\n"
1442 "I wonder if you are in the middle of another rebase. "
1443 "If that is the\n"
1444 "case, please try\n\t%s\n"
1445 "If that is not the case, please\n\t%s\n"
1446 "and run me again. I am stopping in case you still "
1447 "have something\n"
1448 "valuable there.\n"),
1449 state_dir_base, cmd_live_rebase, buf.buf);
1450 }
1451
1452 if ((options.flags & REBASE_INTERACTIVE_EXPLICIT) ||
1453 (options.action != ACTION_NONE) ||
1454 (options.exec.nr > 0) ||
1455 options.autosquash == 1) {
1456 allow_preemptive_ff = 0;
1457 }
1458 if (options.committer_date_is_author_date || options.ignore_date)
1459 options.flags |= REBASE_FORCE;
1460
1461 for (i = 0; i < options.git_am_opts.nr; i++) {
1462 const char *option = options.git_am_opts.v[i], *p;
1463 if (!strcmp(option, "--whitespace=fix") ||
1464 !strcmp(option, "--whitespace=strip"))
1465 allow_preemptive_ff = 0;
1466 else if (skip_prefix(option, "-C", &p)) {
1467 while (*p)
1468 if (!isdigit(*(p++)))
1469 die(_("switch `C' expects a "
1470 "numerical value"));
1471 } else if (skip_prefix(option, "--whitespace=", &p)) {
1472 if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1473 strcmp(p, "error") && strcmp(p, "error-all"))
1474 die("Invalid whitespace option: '%s'", p);
1475 }
1476 }
1477
1478 for (i = 0; i < options.exec.nr; i++)
1479 if (check_exec_cmd(options.exec.items[i].string))
1480 exit(1);
1481
1482 if (!(options.flags & REBASE_NO_QUIET))
1483 strvec_push(&options.git_am_opts, "-q");
1484
1485 if (options.empty != EMPTY_UNSPECIFIED)
1486 imply_merge(&options, "--empty");
1487
1488 if (options.reapply_cherry_picks < 0)
1489 /*
1490 * We default to --no-reapply-cherry-picks unless
1491 * --keep-base is given; when --keep-base is given, we want
1492 * to default to --reapply-cherry-picks.
1493 */
1494 options.reapply_cherry_picks = keep_base;
1495 else if (!keep_base)
1496 /*
1497 * The apply backend always searches for and drops cherry
1498 * picks. This is often not wanted with --keep-base, so
1499 * --keep-base allows --reapply-cherry-picks to be
1500 * simulated by altering the upstream such that
1501 * cherry-picks cannot be detected and thus all commits are
1502 * reapplied. Thus, --[no-]reapply-cherry-picks is
1503 * supported when --keep-base is specified, but not when
1504 * --keep-base is left out.
1505 */
1506 imply_merge(&options, options.reapply_cherry_picks ?
1507 "--reapply-cherry-picks" :
1508 "--no-reapply-cherry-picks");
1509
1510 if (gpg_sign)
1511 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1512
1513 if (options.exec.nr)
1514 imply_merge(&options, "--exec");
1515
1516 if (options.type == REBASE_APPLY) {
1517 if (ignore_whitespace)
1518 strvec_push(&options.git_am_opts,
1519 "--ignore-whitespace");
1520 if (options.committer_date_is_author_date)
1521 strvec_push(&options.git_am_opts,
1522 "--committer-date-is-author-date");
1523 if (options.ignore_date)
1524 strvec_push(&options.git_am_opts, "--ignore-date");
1525 } else {
1526 /* REBASE_MERGE */
1527 if (ignore_whitespace) {
1528 string_list_append(&options.strategy_opts,
1529 "ignore-space-change");
1530 }
1531 }
1532
1533 if (strategy_opt)
1534 options.strategy = xstrdup(strategy_opt);
1535 else if (options.strategy_opts.nr && !options.strategy)
1536 options.strategy = xstrdup("ort");
1537 if (options.strategy)
1538 imply_merge(&options, "--strategy");
1539
1540 if (options.root && !options.onto_name)
1541 imply_merge(&options, "--root without --onto");
1542
1543 if (isatty(2) && options.flags & REBASE_NO_QUIET)
1544 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1545
1546 if (options.git_am_opts.nr || options.type == REBASE_APPLY) {
1547 /* all am options except -q are compatible only with --apply */
1548 for (i = options.git_am_opts.nr - 1; i >= 0; i--)
1549 if (strcmp(options.git_am_opts.v[i], "-q"))
1550 break;
1551
1552 if (i >= 0 || options.type == REBASE_APPLY) {
1553 if (is_merge(&options))
1554 die(_("apply options and merge options "
1555 "cannot be used together"));
1556 else if (options.rebase_merges == -1 && options.config_rebase_merges == 1)
1557 die(_("apply options are incompatible with rebase.rebaseMerges. Consider adding --no-rebase-merges"));
1558 else if (options.update_refs == -1 && options.config_update_refs == 1)
1559 die(_("apply options are incompatible with rebase.updateRefs. Consider adding --no-update-refs"));
1560 else
1561 options.type = REBASE_APPLY;
1562 }
1563 }
1564
1565 if (options.update_refs == 1)
1566 imply_merge(&options, "--update-refs");
1567 options.update_refs = (options.update_refs >= 0) ? options.update_refs :
1568 ((options.config_update_refs >= 0) ? options.config_update_refs : 0);
1569
1570 if (options.rebase_merges == 1)
1571 imply_merge(&options, "--rebase-merges");
1572 options.rebase_merges = (options.rebase_merges >= 0) ? options.rebase_merges :
1573 ((options.config_rebase_merges >= 0) ? options.config_rebase_merges : 0);
1574
1575 if (options.autosquash == 1) {
1576 imply_merge(&options, "--autosquash");
1577 } else if (options.autosquash == -1) {
1578 options.autosquash =
1579 options.config_autosquash &&
1580 (options.flags & REBASE_INTERACTIVE_EXPLICIT);
1581 }
1582
1583 if (options.type == REBASE_UNSPECIFIED) {
1584 if (!strcmp(options.default_backend, "merge"))
1585 options.type = REBASE_MERGE;
1586 else if (!strcmp(options.default_backend, "apply"))
1587 options.type = REBASE_APPLY;
1588 else
1589 die(_("Unknown rebase backend: %s"),
1590 options.default_backend);
1591 }
1592
1593 switch (options.type) {
1594 case REBASE_MERGE:
1595 options.state_dir = merge_dir();
1596 break;
1597 case REBASE_APPLY:
1598 options.state_dir = apply_dir();
1599 break;
1600 default:
1601 BUG("options.type was just set above; should be unreachable.");
1602 }
1603
1604 if (options.empty == EMPTY_UNSPECIFIED) {
1605 if (options.flags & REBASE_INTERACTIVE_EXPLICIT)
1606 options.empty = EMPTY_STOP;
1607 else if (options.exec.nr > 0)
1608 options.empty = EMPTY_KEEP;
1609 else
1610 options.empty = EMPTY_DROP;
1611 }
1612 if (reschedule_failed_exec > 0 && !is_merge(&options))
1613 die(_("--reschedule-failed-exec requires "
1614 "--exec or --interactive"));
1615 if (reschedule_failed_exec >= 0)
1616 options.reschedule_failed_exec = reschedule_failed_exec;
1617
1618 if (options.signoff) {
1619 strvec_push(&options.git_am_opts, "--signoff");
1620 options.flags |= REBASE_FORCE;
1621 }
1622
1623 if (!options.root) {
1624 if (argc < 1) {
1625 struct branch *branch;
1626
1627 branch = branch_get(NULL);
1628 options.upstream_name = branch_get_upstream(branch,
1629 NULL);
1630 if (!options.upstream_name)
1631 error_on_missing_default_upstream();
1632 if (options.fork_point < 0)
1633 options.fork_point = 1;
1634 } else {
1635 options.upstream_name = argv[0];
1636 argc--;
1637 argv++;
1638 if (!strcmp(options.upstream_name, "-"))
1639 options.upstream_name = "@{-1}";
1640 }
1641 options.upstream =
1642 lookup_commit_reference_by_name(options.upstream_name);
1643 if (!options.upstream)
1644 die(_("invalid upstream '%s'"), options.upstream_name);
1645 options.upstream_arg = options.upstream_name;
1646 } else {
1647 if (!options.onto_name) {
1648 if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1649 &squash_onto, NULL, NULL) < 0)
1650 die(_("Could not create new root commit"));
1651 options.squash_onto = &squash_onto;
1652 options.onto_name = squash_onto_name =
1653 xstrdup(oid_to_hex(&squash_onto));
1654 } else
1655 options.root_with_onto = 1;
1656
1657 options.upstream_name = NULL;
1658 options.upstream = NULL;
1659 if (argc > 1)
1660 usage_with_options(builtin_rebase_usage,
1661 builtin_rebase_options);
1662 options.upstream_arg = "--root";
1663 }
1664
1665 /*
1666 * If the branch to rebase is given, that is the branch we will rebase
1667 * branch_name -- branch/commit being rebased, or
1668 * HEAD (already detached)
1669 * orig_head -- commit object name of tip of the branch before rebasing
1670 * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1671 */
1672 if (argc == 1) {
1673 /* Is it "rebase other branchname" or "rebase other commit"? */
1674 struct object_id branch_oid;
1675 branch_name = argv[0];
1676 options.switch_to = argv[0];
1677
1678 /* Is it a local branch? */
1679 strbuf_reset(&buf);
1680 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1681 if (!refs_read_ref(get_main_ref_store(the_repository), buf.buf, &branch_oid)) {
1682 die_if_checked_out(buf.buf, 1);
1683 options.head_name = xstrdup(buf.buf);
1684 options.orig_head =
1685 lookup_commit_object(the_repository,
1686 &branch_oid);
1687 /* If not is it a valid ref (branch or commit)? */
1688 } else {
1689 options.orig_head =
1690 lookup_commit_reference_by_name(branch_name);
1691 options.head_name = NULL;
1692 }
1693 if (!options.orig_head)
1694 die(_("no such branch/commit '%s'"), branch_name);
1695 } else if (argc == 0) {
1696 /* Do not need to switch branches, we are already on it. */
1697 options.head_name =
1698 xstrdup_or_null(refs_resolve_ref_unsafe(get_main_ref_store(the_repository), "HEAD", 0, NULL,
1699 &flags));
1700 if (!options.head_name)
1701 die(_("No such ref: %s"), "HEAD");
1702 if (flags & REF_ISSYMREF) {
1703 if (!skip_prefix(options.head_name,
1704 "refs/heads/", &branch_name))
1705 branch_name = options.head_name;
1706
1707 } else {
1708 FREE_AND_NULL(options.head_name);
1709 branch_name = "HEAD";
1710 }
1711 options.orig_head = lookup_commit_reference_by_name("HEAD");
1712 if (!options.orig_head)
1713 die(_("Could not resolve HEAD to a commit"));
1714 } else
1715 BUG("unexpected number of arguments left to parse");
1716
1717 /* Make sure the branch to rebase onto is valid. */
1718 if (keep_base) {
1719 strbuf_reset(&buf);
1720 strbuf_addstr(&buf, options.upstream_name);
1721 strbuf_addstr(&buf, "...");
1722 strbuf_addstr(&buf, branch_name);
1723 options.onto_name = keep_base_onto_name = xstrdup(buf.buf);
1724 } else if (!options.onto_name)
1725 options.onto_name = options.upstream_name;
1726 if (strstr(options.onto_name, "...")) {
1727 if (repo_get_oid_mb(the_repository, options.onto_name, &branch_base) < 0) {
1728 if (keep_base)
1729 die(_("'%s': need exactly one merge base with branch"),
1730 options.upstream_name);
1731 else
1732 die(_("'%s': need exactly one merge base"),
1733 options.onto_name);
1734 }
1735 options.onto = lookup_commit_or_die(&branch_base,
1736 options.onto_name);
1737 } else {
1738 options.onto =
1739 lookup_commit_reference_by_name(options.onto_name);
1740 if (!options.onto)
1741 die(_("Does not point to a valid commit '%s'"),
1742 options.onto_name);
1743 fill_branch_base(&options, &branch_base);
1744 }
1745
1746 if (keep_base && options.reapply_cherry_picks)
1747 options.upstream = options.onto;
1748
1749 if (options.fork_point > 0)
1750 options.restrict_revision =
1751 get_fork_point(options.upstream_name, options.orig_head);
1752
1753 if (repo_read_index(the_repository) < 0)
1754 die(_("could not read index"));
1755
1756 if (options.autostash)
1757 create_autostash(the_repository,
1758 state_dir_path("autostash", &options));
1759
1760
1761 if (require_clean_work_tree(the_repository, "rebase",
1762 _("Please commit or stash them."), 1, 1)) {
1763 ret = -1;
1764 goto cleanup_autostash;
1765 }
1766
1767 /*
1768 * Now we are rebasing commits upstream..orig_head (or with --root,
1769 * everything leading up to orig_head) on top of onto.
1770 */
1771
1772 /*
1773 * Check if we are already based on onto with linear history,
1774 * in which case we could fast-forward without replacing the commits
1775 * with new commits recreated by replaying their changes.
1776 */
1777 if (allow_preemptive_ff &&
1778 can_fast_forward(options.onto, options.upstream, options.restrict_revision,
1779 options.orig_head, &branch_base)) {
1780 int flag;
1781
1782 if (!(options.flags & REBASE_FORCE)) {
1783 /* Lazily switch to the target branch if needed... */
1784 if (options.switch_to) {
1785 ret = checkout_up_to_date(&options);
1786 if (ret)
1787 goto cleanup_autostash;
1788 }
1789
1790 if (!(options.flags & REBASE_NO_QUIET))
1791 ; /* be quiet */
1792 else if (!strcmp(branch_name, "HEAD") &&
1793 refs_resolve_ref_unsafe(get_main_ref_store(the_repository), "HEAD", 0, NULL, &flag))
1794 puts(_("HEAD is up to date."));
1795 else
1796 printf(_("Current branch %s is up to date.\n"),
1797 branch_name);
1798 ret = finish_rebase(&options);
1799 goto cleanup;
1800 } else if (!(options.flags & REBASE_NO_QUIET))
1801 ; /* be quiet */
1802 else if (!strcmp(branch_name, "HEAD") &&
1803 refs_resolve_ref_unsafe(get_main_ref_store(the_repository), "HEAD", 0, NULL, &flag))
1804 puts(_("HEAD is up to date, rebase forced."));
1805 else
1806 printf(_("Current branch %s is up to date, rebase "
1807 "forced.\n"), branch_name);
1808 }
1809
1810 /* If a hook exists, give it a chance to interrupt*/
1811 if (!ok_to_skip_pre_rebase &&
1812 run_hooks_l(the_repository, "pre-rebase", options.upstream_arg,
1813 argc ? argv[0] : NULL, NULL)) {
1814 ret = error(_("The pre-rebase hook refused to rebase."));
1815 goto cleanup_autostash;
1816 }
1817
1818 if (options.flags & REBASE_DIFFSTAT) {
1819 struct diff_options opts;
1820
1821 if (options.flags & REBASE_VERBOSE) {
1822 if (is_null_oid(&branch_base))
1823 printf(_("Changes to %s:\n"),
1824 oid_to_hex(&options.onto->object.oid));
1825 else
1826 printf(_("Changes from %s to %s:\n"),
1827 oid_to_hex(&branch_base),
1828 oid_to_hex(&options.onto->object.oid));
1829 }
1830
1831 /* We want color (if set), but no pager */
1832 repo_diff_setup(the_repository, &opts);
1833 init_diffstat_widths(&opts);
1834 opts.output_format |=
1835 DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1836 opts.detect_rename = DIFF_DETECT_RENAME;
1837 diff_setup_done(&opts);
1838 diff_tree_oid(is_null_oid(&branch_base) ?
1839 the_hash_algo->empty_tree : &branch_base,
1840 &options.onto->object.oid, "", &opts);
1841 diffcore_std(&opts);
1842 diff_flush(&opts);
1843 }
1844
1845 if (is_merge(&options))
1846 goto run_rebase;
1847
1848 /* Detach HEAD and reset the tree */
1849 if (options.flags & REBASE_NO_QUIET)
1850 printf(_("First, rewinding head to replay your work on top of "
1851 "it...\n"));
1852
1853 strbuf_addf(&msg, "%s (start): checkout %s",
1854 options.reflog_action, options.onto_name);
1855 ropts.oid = &options.onto->object.oid;
1856 ropts.orig_head = &options.orig_head->object.oid;
1857 ropts.flags = RESET_HEAD_DETACH | RESET_ORIG_HEAD |
1858 RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
1859 ropts.head_msg = msg.buf;
1860 ropts.default_reflog_action = options.reflog_action;
1861 if (reset_head(the_repository, &ropts)) {
1862 ret = error(_("Could not detach HEAD"));
1863 goto cleanup_autostash;
1864 }
1865
1866 /*
1867 * If the onto is a proper descendant of the tip of the branch, then
1868 * we just fast-forwarded.
1869 */
1870 if (oideq(&branch_base, &options.orig_head->object.oid)) {
1871 printf(_("Fast-forwarded %s to %s.\n"),
1872 branch_name, options.onto_name);
1873 move_to_original_branch(&options);
1874 ret = finish_rebase(&options);
1875 goto cleanup;
1876 }
1877
1878 strbuf_addf(&revisions, "%s..%s",
1879 options.root ? oid_to_hex(&options.onto->object.oid) :
1880 (options.restrict_revision ?
1881 oid_to_hex(&options.restrict_revision->object.oid) :
1882 oid_to_hex(&options.upstream->object.oid)),
1883 oid_to_hex(&options.orig_head->object.oid));
1884
1885 options.revisions = revisions.buf;
1886
1887run_rebase:
1888 ret = run_specific_rebase(&options);
1889
1890cleanup:
1891 strbuf_release(&buf);
1892 strbuf_release(&msg);
1893 strbuf_release(&revisions);
1894 rebase_options_release(&options);
1895 free(squash_onto_name);
1896 free(keep_base_onto_name);
1897 return !!ret;
1898
1899cleanup_autostash:
1900 ret |= !!cleanup_autostash(&options);
1901 goto cleanup;
1902}