undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'js/stash-in-c-use-builtin-doc'

Browse Source 
Doc update.

* js/stash-in-c-use-builtin-doc:
  stash: document stash.useBuiltin
This commit is contained in:
Junio C Hamano 2019-05-19 16:45:34 +09:00
commit 4ecaedec04
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/config/stash.txt
View File

@ -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:: stash.showPatch::
If this is set to true, the `git stash show` command without an 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. option will show the stash entry in patch form. Defaults to false.