From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Phillip Wood" <phillip.wood@dunelm.org.uk>,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
gitgitgadget@gmail.com, "Pratik Karki" <predatoramigo@gmail.com>,
"Jeff King" <peff@peff.net>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH 1/2] rebase doc: document rebase.useBuiltin
Date: Wed, 14 Nov 2018 09:01:43 +0000 [thread overview]
Message-ID: <20181114090144.31412-2-avarab@gmail.com> (raw)
In-Reply-To: <CAGZ79kYX4vNMYgzitY1D8Bu7o=2oY6Aiq0d7KQdCTaC5eu=RYg@mail.gmail.com>
The rebase.useBuiltin variable introduced in 55071ea248 ("rebase:
start implementing it as a builtin", 2018-08-07) was turned on by
default in 5541bd5b8f ("rebase: default to using the builtin rebase",
2018-08-08), but had no documentation.
Let's document it so that users who run into any stability issues with
the C rewrite know there's an escape hatch[1], and make it clear that
needing to turn off builtin rebase means you've found a bug in git.
1. https://public-inbox.org/git/87y39w1wc2.fsf@evledraar.gmail.com/
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
Documentation/config/rebase.txt | 14 ++++++++++++++
1 file changed, 14 insertions(+)
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.
--
2.19.1.1182.g4ecb1133ce
next prev parent reply other threads:[~2018-11-14 9:01 UTC|newest]
Thread overview: 97+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-11-13 12:38 [PATCH 0/1] rebase: understand -C again, refactor Johannes Schindelin via GitGitGadget
2018-11-13 12:38 ` [PATCH 1/1] rebase: really just passthru the `git am` options Johannes Schindelin via GitGitGadget
2018-11-13 13:05 ` Junio C Hamano
2018-11-13 15:05 ` Phillip Wood
2018-11-13 19:21 ` Johannes Schindelin
2018-11-13 19:58 ` Phillip Wood
2018-11-13 21:50 ` rebase-in-C stability for 2.20 Ævar Arnfjörð Bjarmason
2018-11-14 0:07 ` Stefan Beller
2018-11-14 9:01 ` [PATCH 0/2] rebase.useBuiltin doc & test mode Ævar Arnfjörð Bjarmason
2018-11-14 14:07 ` Johannes Schindelin
2018-11-14 9:01 ` Ævar Arnfjörð Bjarmason [this message]
2018-11-14 9:01 ` [PATCH 2/2] tests: add a special setup where rebase.useBuiltin is off Ævar Arnfjörð Bjarmason
2018-11-14 0:36 ` rebase-in-C stability for 2.20 Elijah Newren
2018-11-14 3:39 ` Junio C Hamano
2018-11-24 20:54 ` [ANNOUNCE] Git v2.20.0-rc1 Ævar Arnfjörð Bjarmason
2018-11-25 1:00 ` Junio C Hamano
2018-11-26 6:10 ` [PATCH] rebase: mark the C reimplementation as an experimental opt-in feature (was Re: [ANNOUNCE] Git v2.20.0-rc1) Junio C Hamano
2018-11-28 4:31 ` Jonathan Nieder
2018-11-28 9:23 ` Johannes Schindelin
2018-11-28 12:21 ` Ævar Arnfjörð Bjarmason
2018-11-29 4:58 ` Junio C Hamano
2018-11-29 14:17 ` Johannes Schindelin
2018-11-29 14:30 ` Ian Jackson
2018-11-29 15:39 ` Johannes Schindelin
2018-11-29 15:50 ` Ian Jackson
2018-11-29 16:14 ` Johannes Schindelin
2018-11-29 16:26 ` Ian Jackson
2018-11-26 22:52 ` [ANNOUNCE] Git v2.20.0-rc1 Johannes Schindelin
2018-11-26 23:47 ` Johannes Schindelin
2018-11-28 4:07 ` Junio C Hamano
2018-11-28 9:30 ` Johannes Schindelin
2018-11-14 14:22 ` [PATCH 1/1] rebase: really just passthru the `git am` options Johannes Schindelin
2018-11-14 7:29 ` [PATCH 0/1] rebase: understand -C again, refactor Jeff King
2018-11-14 14:28 ` Johannes Schindelin
2018-11-14 16:25 ` [PATCH v2 0/2] " Johannes Schindelin via GitGitGadget
2018-11-14 16:25 ` [PATCH v2 1/2] rebase: really just passthru the `git am` options Johannes Schindelin via GitGitGadget
2018-11-14 16:25 ` [PATCH v2 2/2] rebase: validate -C<n> and --whitespace=<mode> parameters early Johannes Schindelin via GitGitGadget
2018-11-14 16:37 ` Phillip Wood
2018-11-14 21:24 ` Johannes Schindelin
2018-11-19 12:38 ` Ævar Arnfjörð Bjarmason
2018-11-19 21:37 ` Git Test Coverage Report (v2.20.0-rc0) Ævar Arnfjörð Bjarmason
2018-11-20 10:58 ` [PATCH v2 2/2] rebase: validate -C<n> and --whitespace=<mode> parameters early Johannes Schindelin
2018-11-20 11:42 ` [PATCH] rebase: mark a test as failing with rebase.useBuiltin=false Ævar Arnfjörð Bjarmason
2018-11-20 19:55 ` Johannes Schindelin
-- strict thread matches above, loose matches on Subject: below --
2018-11-19 2:54 Git Test Coverage Report (v2.20.0-rc0) Derrick Stolee
2018-11-19 15:40 ` Derrick Stolee
2018-11-19 16:21 ` Jeff King
2018-11-19 18:44 ` Jeff King
2018-11-19 19:00 ` Ben Peart
2018-11-19 21:06 ` Derrick Stolee
2018-11-20 11:34 ` Jeff King
2018-11-20 12:17 ` Derrick Stolee
2018-11-20 12:40 ` Jeff King
2018-11-19 18:33 ` Ævar Arnfjörð Bjarmason
2018-11-19 18:51 ` [PATCH] tests: add a special setup where rebase.useBuiltin is off (Re: Git Test Coverage Report (v2.20.0-rc0)) Jonathan Nieder
2018-11-19 21:03 ` Ævar Arnfjörð Bjarmason
2018-11-19 19:10 ` Git Test Coverage Report (v2.20.0-rc0) Derrick Stolee
2018-11-19 19:39 ` Ævar Arnfjörð Bjarmason
2018-11-19 19:44 ` Derrick Stolee
2018-11-19 21:31 ` Derrick Stolee
2018-11-20 20:43 ` Johannes Schindelin
2018-11-21 15:20 [ANNOUNCE] Git v2.20.0-rc1 Junio C Hamano
2018-11-22 15:58 ` Ævar Arnfjörð Bjarmason
2018-11-22 19:27 ` Eric Sunshine
2018-11-22 21:12 ` [PATCH 0/2] format-patch: pre-2.20 range-diff regression fix Ævar Arnfjörð Bjarmason
2018-11-22 21:12 ` [PATCH 1/2] format-patch: add a more exhaustive --range-diff test Ævar Arnfjörð Bjarmason
2018-11-24 4:14 ` Junio C Hamano
2018-11-24 11:45 ` Ævar Arnfjörð Bjarmason
2018-11-22 21:12 ` [PATCH 2/2] format-patch: don't include --stat with --range-diff output Ævar Arnfjörð Bjarmason
2018-11-24 2:26 ` Junio C Hamano
2018-11-24 4:17 ` Junio C Hamano
2018-11-28 20:18 ` [PATCH 0/2] format-patch: fix root cause of recent regression Ævar Arnfjörð Bjarmason
2018-11-28 20:18 ` [PATCH 1/2] format-patch: add test for --range-diff diff output Ævar Arnfjörð Bjarmason
2018-11-28 20:18 ` [PATCH 2/2] format-patch: allow for independent diff & range-diff options Ævar Arnfjörð Bjarmason
2018-11-29 2:59 ` Junio C Hamano
2018-11-29 10:07 ` Johannes Schindelin
2018-11-29 10:30 ` Ævar Arnfjörð Bjarmason
2018-11-29 12:12 ` Johannes Schindelin
2018-11-29 14:35 ` Ævar Arnfjörð Bjarmason
2018-11-29 15:41 ` Johannes Schindelin
2018-11-29 16:03 ` Ævar Arnfjörð Bjarmason
2018-11-29 19:03 ` Johannes Schindelin
2018-11-30 2:30 ` Junio C Hamano
2018-11-30 4:27 ` [PATCH] format-patch: do not let its diff-options affect --range-diff (was Re: [PATCH 2/2] format-patch: allow for independent diff & range-diff options) Junio C Hamano
2018-11-30 8:57 ` Junio C Hamano
2018-11-30 9:24 ` Ævar Arnfjörð Bjarmason
2018-11-30 12:32 ` Johannes Schindelin
2018-11-30 9:31 ` Eric Sunshine
2018-12-03 13:27 ` Martin Ågren
2018-12-03 20:07 ` [PATCH v2] range-diff: always pass at least minimal diff options Martin Ågren
2018-12-03 21:21 ` [PATCH v3] " Eric Sunshine
2018-12-04 1:35 ` Junio C Hamano
2018-12-04 5:40 ` Martin Ågren
2018-11-30 9:58 ` [PATCH 2/2] format-patch: allow for independent diff & range-diff options Eric Sunshine
2018-11-26 7:35 ` [ANNOUNCE] Git v2.20.0-rc1 Junio C Hamano
2018-11-26 15:41 ` Elijah Newren
2018-11-27 0:40 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181114090144.31412-2-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=phillip.wood@dunelm.org.uk \
--cc=predatoramigo@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).