diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2019-05-19 16:45:34 +0900 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2019-05-19 16:45:34 +0900 |
| commit | 4ecaedec042d8114872dd1912b84f420c8a34ccd (patch) | |
| tree | 82d9e777de1672b13a1a6c810c2076743d3a3e12 | |
| parent | Merge branch 'tz/test-lib-check-working-jgit' (diff) | |
| parent | stash: document stash.useBuiltin (diff) | |
| download | tgif-4ecaedec042d8114872dd1912b84f420c8a34ccd.tar.xz | |
Merge branch 'js/stash-in-c-use-builtin-doc'
Doc update.
* js/stash-in-c-use-builtin-doc:
stash: document stash.useBuiltin
| -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. |