# [PATCH 0/1] Document the stash.useBuiltin escape hatch 8 messages from 2019-05-14 to 2019-05-17. Participants: Johannes Schindelin via GitGitGadget, Ævar Arnfjörð Bjarmason, Eric Sunshine, Junio C Hamano, Johannes Schindelin. Thread: https://gitlist.dev/t/51088 ## Johannes Schindelin via GitGitGadget, 2019-05-14 09:19 Subject: [PATCH 0/1] Document the stash.useBuiltin escape hatch Message-ID: URL: https://gitlist.dev/e/pull.193.git.gitgitgadget%40gmail.com ``` 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 -- gitgitgadget ``` ## Johannes Schindelin via GitGitGadget, 2019-05-14 09:19 Subject: [PATCH 1/1] stash: document stash.useBuiltin Message-ID: <6c250451658f34c1415bfcba35ee6303cecac0dc.1557825553.git.gitgitgadget@gmail.com> URL: https://gitlist.dev/e/6c250451658f34c1415bfcba35ee6303cecac0dc.1557825553.git.gitgitgadget%40gmail.com In-Reply-To: ``` From: Johannes Schindelin 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 --- Documentation/config/stash.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt index c583d46d6b..d7bf6ec61f 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. -- gitgitgadget ``` ## Ævar Arnfjörð Bjarmason, 2019-05-14 09:44 Subject: Re: [PATCH 1/1] stash: document stash.useBuiltin Message-ID: <87k1etwesp.fsf@evledraar.gmail.com> URL: https://gitlist.dev/e/87k1etwesp.fsf%40evledraar.gmail.com In-Reply-To: <6c250451658f34c1415bfcba35ee6303cecac0dc.1557825553.git.gitgitgadget@gmail.com> ``` On Tue, May 14 2019, Johannes Schindelin via GitGitGadget wrote: > From: Johannes Schindelin > > 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 > --- > Documentation/config/stash.txt | 15 +++++++++++++++ > 1 file changed, 15 insertions(+) > > diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt > index c583d46d6b..d7bf6ec61f 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. Thanks for following up on this. LGTM. ``` ## Eric Sunshine, 2019-05-14 19:57 Subject: Re: [PATCH 1/1] stash: document stash.useBuiltin Message-ID: URL: https://gitlist.dev/e/CAPig%2BcRoyOJrEuVY109NKafTCUc399p9tk64L9sZok%3DAOZ1MPg%40mail.gmail.com In-Reply-To: <6c250451658f34c1415bfcba35ee6303cecac0dc.1557825553.git.gitgitgadget@gmail.com> ``` On Tue, May 14, 2019 at 5:19 AM Johannes Schindelin via GitGitGadget wrote: > 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. > Signed-off-by: Johannes Schindelin > --- > diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt > @@ -1,3 +1,18 @@ > +If you find some reason to set this option to `false` other than s/`false`/&,/ > +one-off testing you should report the behavior difference as a bug in s/testing/&,/ > +git (see https://git-scm.com/community for details). s/^git/Git/ ``` ## Junio C Hamano, 2019-05-15 01:15 Subject: Re: [PATCH 1/1] stash: document stash.useBuiltin Message-ID: URL: https://gitlist.dev/e/xmqqk1es8qml.fsf%40gitster-ct.c.googlers.com In-Reply-To: <87k1etwesp.fsf@evledraar.gmail.com> ``` Ævar Arnfjörð Bjarmason writes: > Thanks for following up on this. LGTM. Yeah, thanks, both. ``` ## Johannes Schindelin, 2019-05-15 08:26 Subject: Re: [PATCH 1/1] stash: document stash.useBuiltin Message-ID: URL: https://gitlist.dev/e/nycvar.QRO.7.76.6.1905151025580.44%40tvgsbejvaqbjf.bet In-Reply-To: ``` Hi Eric, On Tue, 14 May 2019, Eric Sunshine wrote: > On Tue, May 14, 2019 at 5:19 AM Johannes Schindelin via GitGitGadget > wrote: > > 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. Thanks! Junio, do you agree, do you want to fix it up on your side? Ciao, Dscho > > > Signed-off-by: Johannes Schindelin > > --- > > diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt > > @@ -1,3 +1,18 @@ > > +If you find some reason to set this option to `false` other than > > s/`false`/&,/ > > > +one-off testing you should report the behavior difference as a bug in > > s/testing/&,/ > > > +git (see https://git-scm.com/community for details). > > s/^git/Git/ > ``` ## Junio C Hamano, 2019-05-15 08:52 Subject: Re: [PATCH 1/1] stash: document stash.useBuiltin Message-ID: URL: https://gitlist.dev/e/xmqqo9445cba.fsf%40gitster-ct.c.googlers.com In-Reply-To: ``` Johannes Schindelin writes: >> 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. >> > +one-off testing you should report the behavior difference as a bug in >> >> s/testing/&,/ >> >> > +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. ``` ## Johannes Schindelin, 2019-05-17 18:30 Subject: Re: [PATCH 1/1] stash: document stash.useBuiltin Message-ID: URL: https://gitlist.dev/e/nycvar.QRO.7.76.6.1905172030050.46%40tvgsbejvaqbjf.bet In-Reply-To: ``` Hi Junio, On Wed, 15 May 2019, Junio C Hamano wrote: > Johannes Schindelin writes: > > >> 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 ```