Document the stash.useBuiltin escape hatch
cover Document the stash.useBuiltin escape hatch
Shamelessly copy-edited from Ævar's d8d0a546f0 (rebase doc: document rebase.useBuiltin, 2018-11-14)
:-D
Johannes Schindelin (1):
stash: document stash.useBuiltin
Documentation/config/stash.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
base-commit: ab15ad1a3b4b04a29415aef8c9afa2f64fc194a2
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-193%2Fdscho%2Fbuiltin-stash-knob-docs-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-193/dscho/builtin-stash-knob-docs-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/193
Signature · 1 line
gitgitgadget
PATCH 1/1 stash: document stash.useBuiltin
From: Johannes Schindelin <[email protected]>
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.
--- Documentation/config/stash.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
Documentation/config/stash.txt +15 -0
@@ -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.
Signature · 1 line
gitgitgadget
Re: [PATCH 1/1] stash: document stash.useBuiltin
Quoted 29 lines · Johannes Schindelin via GitGitGadget
From: Johannes Schindelin <[email protected]>
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 <[email protected]>--- Documentation/config/stash.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+)Documentation/config/stash.txt +8
-0@@ -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
Documentation/config/stash.txt line 18
Quoted 10 lines
Documentation/config/stash.txt +7
-0+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.
Thanks for following up on this. LGTM.
Re: [PATCH 1/1] stash: document stash.useBuiltin
Quoted 1 line · Ævar Arnfjörð Bjarmason
Thanks for following up on this. LGTM.
Yeah, thanks, both.
Re: [PATCH 1/1] stash: document stash.useBuiltin
In reply to Johannes Schindelin via GitGitGadgetQuoted 8 lines · Johannes Schindelin via GitGitGadget
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.
See a few nits below, none of which are necessarily worth a re-roll.
Documentation/config/stash.txt line 1
Quoted 5 lines
Signed-off-by Johannes Schindelin <[email protected]>---
Documentation/config/stash.txt +1
-0@@ -1,3 +1,18 @@ +If you find some reason to set this option to `false` other than
s/false/&,/
Documentation/config/stash.txt line 13
Quoted 1 line
Documentation/config/stash.txt +1
-0+one-off testing you should report the behavior difference as a bug in
s/testing/&,/
Documentation/config/stash.txt line 14
Quoted 1 line
Documentation/config/stash.txt +1
-0+git (see https://git-scm.com/community for details).
s/^git/Git/
Re: [PATCH 1/1] stash: document stash.useBuiltin
Hi Eric,
Quoted 6 lines · Eric Sunshine
Quoted 4 lines · Johannes Schindelin via GitGitGadget
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.
Quoted 6 lines
Quoted 4 lines
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.
See a few nits below, none of which are necessarily worth a re-roll.
Thanks!
Junio, do you agree, do you want to fix it up on your side?
Ciao,
Dscho
Quoted 17 lines
Documentation/config/stash.txt line 1
Quoted 6 lines
Signed-off-by Johannes Schindelin <[email protected]>---
Documentation/config/stash.txt +1
-0@@ -1,3 +1,18 @@ +If you find some reason to set this option to `false` other thans/
false/&,/Documentation/config/stash.txt line 13
Quoted 1 line
Documentation/config/stash.txt +1
-0+one-off testing you should report the behavior difference as a bug ins/testing/&,/
Documentation/config/stash.txt line 14
Quoted 1 line
Documentation/config/stash.txt +1
-0+git (see https://git-scm.com/community for details).s/^git/Git/
Re: [PATCH 1/1] stash: document stash.useBuiltin
Quoted 5 lines · Johannes Schindelin
Quoted 1 line
See a few nits below, none of which are necessarily worth a re-roll.
Thanks!
Junio, do you agree, do you want to fix it up on your side?
I think you'd see all of them in what I've pushed out.
Quoted 7 lines
Quoted 7 lines
Quoted 1 line
+one-off testing you should report the behavior difference as a bug in
s/testing/&,/
Quoted 1 line
+git (see https://git-scm.com/community for details).
s/^git/Git/
The last one might be a bit iffy, as we are talking about (a possible bug in) a specific implementation of "git", as opposed to Git as general concept, but I took it anyway.
Thanks, all.
Re: [PATCH 1/1] stash: document stash.useBuiltin
Hi Junio,
Quoted 9 lines · Junio C Hamano
Quoted 5 lines · Johannes Schindelin
Quoted 1 line
See a few nits below, none of which are necessarily worth a re-roll.
Thanks!
Junio, do you agree, do you want to fix it up on your side?
I think you'd see all of them in what I've pushed out.
Indeed, what you merged to next looks good to me, too.
Thanks,
Dscho