]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/config/rebase.txt
Merge branch 'jx/remote-archive-over-smart-http'
[thirdparty/git.git] / Documentation / config / rebase.txt
CommitLineData
8295ed69
EN
1rebase.backend::
2 Default backend to use for rebasing. Possible choices are
10cdb9f3
EN
3 'apply' or 'merge'. In the future, if the merge backend gains
4 all remaining capabilities of the apply backend, this setting
5 may become unused.
8295ed69 6
946a9f20
LB
7rebase.stat::
8 Whether to show a diffstat of what changed upstream since the last
9 rebase. False by default.
10
11rebase.autoSquash::
75cf39b1
AK
12 If set to true, enable the `--autosquash` option of
13 linkgit:git-rebase[1] by default for interactive mode.
14 This can be overridden with the `--no-autosquash` option.
946a9f20
LB
15
16rebase.autoStash::
17 When set to true, automatically create a temporary stash entry
18 before the operation begins, and apply it after the operation
19 ends. This means that you can run rebase on a dirty worktree.
20 However, use with care: the final stash application after a
21 successful rebase might result in non-trivial conflicts.
22 This option can be overridden by the `--no-autostash` and
23 `--autostash` options of linkgit:git-rebase[1].
24 Defaults to false.
25
3113feda
DS
26rebase.updateRefs::
27 If set to true enable `--update-refs` option by default.
28
946a9f20
LB
29rebase.missingCommitsCheck::
30 If set to "warn", git rebase -i will print a warning if some
31 commits are removed (e.g. a line was deleted), however the
32 rebase will still proceed. If set to "error", it will print
33 the previous warning and stop the rebase, 'git rebase
34 --edit-todo' can then be used to correct the error. If set to
35 "ignore", no checking is done.
36 To drop a commit without warning or error, use the `drop`
f3b633da 37 command in the todo list.
946a9f20
LB
38 Defaults to "ignore".
39
40rebase.instructionFormat::
41 A format string, as specified in linkgit:git-log[1], to be used for the
f3b633da 42 todo list during an interactive rebase. The format will
9cd30af9 43 automatically have the commit hash prepended to the format.
d8ae6c84
LB
44
45rebase.abbreviateCommands::
46 If set to true, `git rebase` will use abbreviated command names in the
47 todo list resulting in something like this:
48+
49-------------------------------------------
50 p deadbee The oneline of the commit
51 p fa1afe1 The oneline of the next commit
52 ...
53-------------------------------------------
54+
55instead of:
56+
57-------------------------------------------
58 pick deadbee The oneline of the commit
59 pick fa1afe1 The oneline of the next commit
60 ...
61-------------------------------------------
62+
63Defaults to false.
969de3ff
JS
64
65rebase.rescheduleFailedExec::
66 Automatically reschedule `exec` commands that failed. This only makes
67 sense in interactive mode (or when an `--exec` option was provided).
68 This is the same as specifying the `--reschedule-failed-exec` option.
2803d800
AH
69
70rebase.forkPoint::
71 If set to false set `--no-fork-point` option by default.
6605fb70
AH
72
73rebase.rebaseMerges::
74 Whether and how to set the `--rebase-merges` option by default. Can
75 be `rebase-cousins`, `no-rebase-cousins`, or a boolean. Setting to
76 true or to `no-rebase-cousins` is equivalent to
77 `--rebase-merges=no-rebase-cousins`, setting to `rebase-cousins` is
78 equivalent to `--rebase-merges=rebase-cousins`, and setting to false is
79 equivalent to `--no-rebase-merges`. Passing `--rebase-merges` on the
80 command line, with or without an argument, overrides any
81 `rebase.rebaseMerges` configuration.
ac300bda
JS
82
83rebase.maxLabelLength::
84 When generating label names from commit subjects, truncate the names to
85 this length. By default, the names are truncated to a little less than
86 `NAME_MAX` (to allow e.g. `.lock` files to be written for the
87 corresponding loose refs).