Skip to content

Commit 336ad84

Browse files
dschogitster
authored andcommitted
stash: document stash.useBuiltin
The stash.useBuiltin variable introduced in 90a4627 ("stash: optionally use the scripted version again", 2019-02-25) was turned on by default, 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, and spell out that the user should please report the bug when they have to turn off the built-in stash. Signed-off-by: Johannes Schindelin <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent ab15ad1 commit 336ad84

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Documentation/config/stash.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
stash.useBuiltin::
2+
Set to `false` to use the legacy shell script implementation of
3+
linkgit:git-stash[1]. Is `true` by default, which means use
4+
the built-in rewrite of it in C.
5+
+
6+
The C rewrite is first included with Git version 2.22 (and Git for Windows
7+
version 2.19). This option serves an an escape hatch to re-enable the
8+
legacy version in case any bugs are found in the rewrite. This option and
9+
the shell script version of linkgit:git-stash[1] will be removed in some
10+
future release.
11+
+
12+
If you find some reason to set this option to `false`, other than
13+
one-off testing, you should report the behavior difference as a bug in
14+
Git (see https://git-scm.com/community for details).
15+
116
stash.showPatch::
217
If this is set to true, the `git stash show` command without an
318
option will show the stash entry in patch form. Defaults to false.

0 commit comments

Comments
 (0)