Merge branch 'jk/credential-sample-update'
[git.git] / Documentation / config / rebase.txt
blob7f7a07d22f86bdfb6b1d12d4625f456b5741bee6
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.
8 rebase.backend::
9         Default backend to use for rebasing.  Possible choices are
10         'apply' or 'merge'.  In the future, if the merge backend gains
11         all remaining capabilities of the apply backend, this setting
12         may become unused.
14 rebase.stat::
15         Whether to show a diffstat of what changed upstream since the last
16         rebase. False by default.
18 rebase.autoSquash::
19         If set to true enable `--autosquash` option by default.
21 rebase.autoStash::
22         When set to true, automatically create a temporary stash entry
23         before the operation begins, and apply it after the operation
24         ends.  This means that you can run rebase on a dirty worktree.
25         However, use with care: the final stash application after a
26         successful rebase might result in non-trivial conflicts.
27         This option can be overridden by the `--no-autostash` and
28         `--autostash` options of linkgit:git-rebase[1].
29         Defaults to false.
31 rebase.missingCommitsCheck::
32         If set to "warn", git rebase -i will print a warning if some
33         commits are removed (e.g. a line was deleted), however the
34         rebase will still proceed. If set to "error", it will print
35         the previous warning and stop the rebase, 'git rebase
36         --edit-todo' can then be used to correct the error. If set to
37         "ignore", no checking is done.
38         To drop a commit without warning or error, use the `drop`
39         command in the todo list.
40         Defaults to "ignore".
42 rebase.instructionFormat::
43         A format string, as specified in linkgit:git-log[1], to be used for the
44         todo list during an interactive rebase.  The format will
45         automatically have the long commit hash prepended to the format.
47 rebase.abbreviateCommands::
48         If set to true, `git rebase` will use abbreviated command names in the
49         todo list resulting in something like this:
51 -------------------------------------------
52         p deadbee The oneline of the commit
53         p fa1afe1 The oneline of the next commit
54         ...
55 -------------------------------------------
57 instead of:
59 -------------------------------------------
60         pick deadbee The oneline of the commit
61         pick fa1afe1 The oneline of the next commit
62         ...
63 -------------------------------------------
65 Defaults to false.
67 rebase.rescheduleFailedExec::
68         Automatically reschedule `exec` commands that failed. This only makes
69         sense in interactive mode (or when an `--exec` option was provided).
70         This is the same as specifying the `--reschedule-failed-exec` option.