diff options
| author | Johannes Schindelin <johannes.schindelin@gmx.de> | 2019-05-14 11:19:15 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2019-05-15 03:47:20 +0200 |
| commit | 336ad8424cb55905f78ff5e496890be3db13c357 (patch) | |
| tree | 84e9800caa7cd4c5b46c8ac2f46bb641052d51b3 /Documentation/config/stash.txt | |
| parent | Git 2.22-rc0 (diff) | |
| download | git-336ad8424cb55905f78ff5e496890be3db13c357.tar.xz git-336ad8424cb55905f78ff5e496890be3db13c357.zip | |
stash: document stash.useBuiltin
The stash.useBuiltin variable introduced in 90a462725e ("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 <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to '')
| -rw-r--r-- | Documentation/config/stash.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt index c583d46d6b..7710758efb 100644 --- a/Documentation/config/stash.txt +++ b/Documentation/config/stash.txt @@ -1,3 +1,18 @@ +stash.useBuiltin:: + Set to `false` to use the legacy shell script implementation of + linkgit:git-stash[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.22 (and Git for Windows +version 2.19). 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 shell script version of linkgit:git-stash[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 (see https://git-scm.com/community for details). + stash.showPatch:: If this is set to true, the `git stash show` command without an option will show the stash entry in patch form. Defaults to false. |