rebase: add a config option to default to --reschedule-failed-exec
[git.git] / Documentation / config / rebase.txt
blob331d250e0468df8ec51bdb3348d6a30274da26ed
1 rebase.useBuiltin::
2         Set to `false` to use the legacy shellscript implementation of
3         linkgit:git-rebase[1]. Is `true` by default, which means use
4         the built-in rewrite of it in C.
6 The C rewrite is first included with Git version 2.20. This option
7 serves an an escape hatch to re-enable the legacy version in case any
8 bugs are found in the rewrite. This option and the shellscript version
9 of linkgit:git-rebase[1] will be removed in some future release.
11 If you find some reason to set this option to `false` other than
12 one-off testing you should report the behavior difference as a bug in
13 git.
15 rebase.stat::
16         Whether to show a diffstat of what changed upstream since the last
17         rebase. False by default.
19 rebase.autoSquash::
20         If set to true enable `--autosquash` option by default.
22 rebase.autoStash::
23         When set to true, automatically create a temporary stash entry
24         before the operation begins, and apply it after the operation
25         ends.  This means that you can run rebase on a dirty worktree.
26         However, use with care: the final stash application after a
27         successful rebase might result in non-trivial conflicts.
28         This option can be overridden by the `--no-autostash` and
29         `--autostash` options of linkgit:git-rebase[1].
30         Defaults to false.
32 rebase.missingCommitsCheck::
33         If set to "warn", git rebase -i will print a warning if some
34         commits are removed (e.g. a line was deleted), however the
35         rebase will still proceed. If set to "error", it will print
36         the previous warning and stop the rebase, 'git rebase
37         --edit-todo' can then be used to correct the error. If set to
38         "ignore", no checking is done.
39         To drop a commit without warning or error, use the `drop`
40         command in the todo list.
41         Defaults to "ignore".
43 rebase.instructionFormat::
44         A format string, as specified in linkgit:git-log[1], to be used for the
45         todo list during an interactive rebase.  The format will
46         automatically have the long commit hash prepended to the format.
48 rebase.abbreviateCommands::
49         If set to true, `git rebase` will use abbreviated command names in the
50         todo list resulting in something like this:
52 -------------------------------------------
53         p deadbee The oneline of the commit
54         p fa1afe1 The oneline of the next commit
55         ...
56 -------------------------------------------
58 instead of:
60 -------------------------------------------
61         pick deadbee The oneline of the commit
62         pick fa1afe1 The oneline of the next commit
63         ...
64 -------------------------------------------
66 Defaults to false.
68 rebase.rescheduleFailedExec::
69         Automatically reschedule `exec` commands that failed. This only makes
70         sense in interactive mode (or when an `--exec` option was provided).
71         This is the same as specifying the `--reschedule-failed-exec` option.