summaryrefslogtreecommitdiff
path: root/Documentation/config/rebase.txt
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2018-11-18 18:23:59 +0900
committerLibravatar Junio C Hamano <gitster@pobox.com>2018-11-18 18:23:59 +0900
commit4520c233742cca267e1c0ba55f04f35ef7e9baf7 (patch)
treec492d0450700e918465d75e01e924d18f9327b2a /Documentation/config/rebase.txt
parentMerge branch 'js/rebase-am-options' (diff)
parenttests: add a special setup where rebase.useBuiltin is off (diff)
downloadtgif-4520c233742cca267e1c0ba55f04f35ef7e9baf7.tar.xz
Merge branch 'ab/rebase-in-c-escape-hatch'
The recently merged "rebase in C" has an escape hatch to use the scripted version when necessary, but it hasn't been documented, which has been corrected. * ab/rebase-in-c-escape-hatch: tests: add a special setup where rebase.useBuiltin is off rebase doc: document rebase.useBuiltin
Diffstat (limited to 'Documentation/config/rebase.txt')
-rw-r--r--Documentation/config/rebase.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/config/rebase.txt b/Documentation/config/rebase.txt
index 42e1ba7575..f079bf6b7e 100644
--- a/Documentation/config/rebase.txt
+++ b/Documentation/config/rebase.txt
@@ -1,3 +1,17 @@
+rebase.useBuiltin::
+ Set to `false` to use the legacy shellscript implementation of
+ linkgit:git-rebase[1]. Is `true` by default, which means use
+ the built-in rewrite of it in C.
++
+The C rewrite is first included with Git version 2.20. This option
+serves an an escape hatch to re-enable the legacy version in case any
+bugs are found in the rewrite. This option and the shellscript version
+of linkgit:git-rebase[1] will be removed in some future release.
++
+If you find some reason to set this option to `false` other than
+one-off testing you should report the behavior difference as a bug in
+git.
+
rebase.stat::
Whether to show a diffstat of what changed upstream since the last
rebase. False by default.