Merge branch 'bc/misconception-doc' into maint
[git] / Documentation / config / rebase.txt
1 rebase.useBuiltin::
2         Unused configuration variable. Used in Git versions 2.20 and
3         2.21 as an escape hatch to enable the legacy shellscript
4         implementation of rebase. Now the built-in rewrite of it in C
5         is always used. Setting this will emit a warning, to alert any
6         remaining users that setting this now does nothing.
7
8 rebase.stat::
9         Whether to show a diffstat of what changed upstream since the last
10         rebase. False by default.
11
12 rebase.autoSquash::
13         If set to true enable `--autosquash` option by default.
14
15 rebase.autoStash::
16         When set to true, automatically create a temporary stash entry
17         before the operation begins, and apply it after the operation
18         ends.  This means that you can run rebase on a dirty worktree.
19         However, use with care: the final stash application after a
20         successful rebase might result in non-trivial conflicts.
21         This option can be overridden by the `--no-autostash` and
22         `--autostash` options of linkgit:git-rebase[1].
23         Defaults to false.
24
25 rebase.missingCommitsCheck::
26         If set to "warn", git rebase -i will print a warning if some
27         commits are removed (e.g. a line was deleted), however the
28         rebase will still proceed. If set to "error", it will print
29         the previous warning and stop the rebase, 'git rebase
30         --edit-todo' can then be used to correct the error. If set to
31         "ignore", no checking is done.
32         To drop a commit without warning or error, use the `drop`
33         command in the todo list.
34         Defaults to "ignore".
35
36 rebase.instructionFormat::
37         A format string, as specified in linkgit:git-log[1], to be used for the
38         todo list during an interactive rebase.  The format will
39         automatically have the long commit hash prepended to the format.
40
41 rebase.abbreviateCommands::
42         If set to true, `git rebase` will use abbreviated command names in the
43         todo list resulting in something like this:
44 +
45 -------------------------------------------
46         p deadbee The oneline of the commit
47         p fa1afe1 The oneline of the next commit
48         ...
49 -------------------------------------------
50 +
51 instead of:
52 +
53 -------------------------------------------
54         pick deadbee The oneline of the commit
55         pick fa1afe1 The oneline of the next commit
56         ...
57 -------------------------------------------
58 +
59 Defaults to false.
60
61 rebase.rescheduleFailedExec::
62         Automatically reschedule `exec` commands that failed. This only makes
63         sense in interactive mode (or when an `--exec` option was provided).
64         This is the same as specifying the `--reschedule-failed-exec` option.