{"thread":{"id":"51088","subject":"[PATCH 0/1] Document the stash.useBuiltin escape hatch","startedAt":"2019-05-14T09:19:18Z","lastAt":"2019-05-17T18:30:25Z","messageCount":8,"participants":["Johannes Schindelin via GitGitGadget","Ævar Arnfjörð Bjarmason","Eric Sunshine","Junio C Hamano","Johannes Schindelin"],"isPatch":true,"patchVersion":1,"patchTotal":1},"messages":[{"id":"375481","messageId":"pull.193.git.gitgitgadget@gmail.com","threadId":"51088","inReplyTo":null,"subject":"[PATCH 0/1] Document the stash.useBuiltin escape hatch","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-05-14T09:19:14Z","receivedAt":"2019-05-14T09:19:18Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Shamelessly copy-edited from Ævar's d8d0a546f0 (rebase doc: document\nrebase.useBuiltin, 2018-11-14)\n\n:-D\n\nJohannes Schindelin (1):\n stash: document stash.useBuiltin\n\n Documentation/config/stash.txt | 15 +++++++++++++++\n 1 file changed, 15 insertions(+)\n\n\nbase-commit: ab15ad1a3b4b04a29415aef8c9afa2f64fc194a2\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-193%2Fdscho%2Fbuiltin-stash-knob-docs-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-193/dscho/builtin-stash-knob-docs-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/193\n-- \ngitgitgadget\n"},{"id":"375482","messageId":"6c250451658f34c1415bfcba35ee6303cecac0dc.1557825553.git.gitgitgadget@gmail.com","threadId":"51088","inReplyTo":"pull.193.git.gitgitgadget@gmail.com","subject":"[PATCH 1/1] stash: document stash.useBuiltin","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-05-14T09:19:15Z","receivedAt":"2019-05-14T09:19:19Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"From: Johannes Schindelin \n\nThe stash.useBuiltin variable introduced in 90a462725e (\"stash:\noptionally use the scripted version again\", 2019-02-25) was turned on by\ndefault, but had no documentation.\n\nLet's document it so that users who run into any stability issues with\nthe C rewrite know there's an escape hatch, and spell out that the\nuser should please report the bug when they have to turn off the\nbuilt-in stash.\n\nSigned-off-by: Johannes Schindelin \n---\n Documentation/config/stash.txt | 15 +++++++++++++++\n 1 file changed, 15 insertions(+)\n\ndiff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt\nindex c583d46d6b..d7bf6ec61f 100644\n--- a/Documentation/config/stash.txt\n+++ b/Documentation/config/stash.txt\n@@ -1,3 +1,18 @@\n+stash.useBuiltin::\n+ Set to `false` to use the legacy shell script implementation of\n+ linkgit:git-stash[1]. Is `true` by default, which means use\n+ the built-in rewrite of it in C.\n++\n+The C rewrite is first included with Git version 2.22 (and Git for Windows\n+version 2.19). This option serves an an escape hatch to re-enable the\n+legacy version in case any bugs are found in the rewrite. This option and\n+the shell script version of linkgit:git-stash[1] will be removed in some\n+future release.\n++\n+If you find some reason to set this option to `false` other than\n+one-off testing you should report the behavior difference as a bug in\n+git (see https://git-scm.com/community for details).\n+\n stash.showPatch::\n \tIf this is set to true, the `git stash show` command without an\n \toption will show the stash entry in patch form. Defaults to false.\n-- \ngitgitgadget\n"},{"id":"375491","messageId":"87k1etwesp.fsf@evledraar.gmail.com","threadId":"51088","inReplyTo":"6c250451658f34c1415bfcba35ee6303cecac0dc.1557825553.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 1/1] stash: document stash.useBuiltin","fromName":"Ævar Arnfjörð Bjarmason","fromEmail":"avarab@gmail.com","sentAt":"2019-05-14T09:44:54Z","receivedAt":"2019-05-14T09:44:58Z","isPatch":true,"sender":{"key":"avarab@gmail.com","avatar":"https://avatars.githubusercontent.com/u/45301?v=4"},"body":"\nOn Tue, May 14 2019, Johannes Schindelin via GitGitGadget wrote:\n\n> From: Johannes Schindelin \n>\n> The stash.useBuiltin variable introduced in 90a462725e (\"stash:\n> optionally use the scripted version again\", 2019-02-25) was turned on by\n> default, but had no documentation.\n>\n> Let's document it so that users who run into any stability issues with\n> the C rewrite know there's an escape hatch, and spell out that the\n> user should please report the bug when they have to turn off the\n> built-in stash.\n>\n> Signed-off-by: Johannes Schindelin \n> ---\n> Documentation/config/stash.txt | 15 +++++++++++++++\n> 1 file changed, 15 insertions(+)\n>\n> diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt\n> index c583d46d6b..d7bf6ec61f 100644\n> --- a/Documentation/config/stash.txt\n> +++ b/Documentation/config/stash.txt\n> @@ -1,3 +1,18 @@\n> +stash.useBuiltin::\n> + Set to `false` to use the legacy shell script implementation of\n> + linkgit:git-stash[1]. Is `true` by default, which means use\n> + the built-in rewrite of it in C.\n> ++\n> +The C rewrite is first included with Git version 2.22 (and Git for Windows\n> +version 2.19). This option serves an an escape hatch to re-enable the\n> +legacy version in case any bugs are found in the rewrite. This option and\n> +the shell script version of linkgit:git-stash[1] will be removed in some\n> +future release.\n> ++\n> +If you find some reason to set this option to `false` other than\n> +one-off testing you should report the behavior difference as a bug in\n> +git (see https://git-scm.com/community for details).\n> +\n> stash.showPatch::\n> \tIf this is set to true, the `git stash show` command without an\n> \toption will show the stash entry in patch form. Defaults to false.\n\nThanks for following up on this. LGTM.\n"},{"id":"375565","messageId":"CAPig+cRoyOJrEuVY109NKafTCUc399p9tk64L9sZok=AOZ1MPg@mail.gmail.com","threadId":"51088","inReplyTo":"6c250451658f34c1415bfcba35ee6303cecac0dc.1557825553.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 1/1] stash: document stash.useBuiltin","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2019-05-14T19:57:10Z","receivedAt":"2019-05-14T19:57:25Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Tue, May 14, 2019 at 5:19 AM Johannes Schindelin via GitGitGadget\n wrote:\n> The stash.useBuiltin variable introduced in 90a462725e (\"stash:\n> optionally use the scripted version again\", 2019-02-25) was turned on by\n> default, but had no documentation.\n>\n> Let's document it so that users who run into any stability issues with\n> the C rewrite know there's an escape hatch, and spell out that the\n> user should please report the bug when they have to turn off the\n> built-in stash.\n\nSee a few nits below, none of which are necessarily worth a re-roll.\n\n> Signed-off-by: Johannes Schindelin \n> ---\n> diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt\n> @@ -1,3 +1,18 @@\n> +If you find some reason to set this option to `false` other than\n\ns/`false`/&,/\n\n> +one-off testing you should report the behavior difference as a bug in\n\ns/testing/&,/\n\n> +git (see https://git-scm.com/community for details).\n\ns/^git/Git/\n"},{"id":"375579","messageId":"xmqqk1es8qml.fsf@gitster-ct.c.googlers.com","threadId":"51088","inReplyTo":"87k1etwesp.fsf@evledraar.gmail.com","subject":"Re: [PATCH 1/1] stash: document stash.useBuiltin","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-05-15T01:15:30Z","receivedAt":"2019-05-15T01:15:33Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Ævar Arnfjörð Bjarmason writes:\n\n> Thanks for following up on this. LGTM.\n\nYeah, thanks, both.\n"},{"id":"375609","messageId":"nycvar.QRO.7.76.6.1905151025580.44@tvgsbejvaqbjf.bet","threadId":"51088","inReplyTo":"CAPig+cRoyOJrEuVY109NKafTCUc399p9tk64L9sZok=AOZ1MPg@mail.gmail.com","subject":"Re: [PATCH 1/1] stash: document stash.useBuiltin","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2019-05-15T08:26:36Z","receivedAt":"2019-05-15T08:26:37Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi Eric,\n\nOn Tue, 14 May 2019, Eric Sunshine wrote:\n\n> On Tue, May 14, 2019 at 5:19 AM Johannes Schindelin via GitGitGadget\n> wrote:\n> > The stash.useBuiltin variable introduced in 90a462725e (\"stash:\n> > optionally use the scripted version again\", 2019-02-25) was turned on by\n> > default, but had no documentation.\n> >\n> > Let's document it so that users who run into any stability issues with\n> > the C rewrite know there's an escape hatch, and spell out that the\n> > user should please report the bug when they have to turn off the\n> > built-in stash.\n>\n> See a few nits below, none of which are necessarily worth a re-roll.\n\nThanks!\n\nJunio, do you agree, do you want to fix it up on your side?\n\nCiao,\nDscho\n\n>\n> > Signed-off-by: Johannes Schindelin \n> > ---\n> > diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt\n> > @@ -1,3 +1,18 @@\n> > +If you find some reason to set this option to `false` other than\n>\n> s/`false`/&,/\n>\n> > +one-off testing you should report the behavior difference as a bug in\n>\n> s/testing/&,/\n>\n> > +git (see https://git-scm.com/community for details).\n>\n> s/^git/Git/\n>\n"},{"id":"375614","messageId":"xmqqo9445cba.fsf@gitster-ct.c.googlers.com","threadId":"51088","inReplyTo":"nycvar.QRO.7.76.6.1905151025580.44@tvgsbejvaqbjf.bet","subject":"Re: [PATCH 1/1] stash: document stash.useBuiltin","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-05-15T08:52:57Z","receivedAt":"2019-05-15T08:53:03Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Johannes Schindelin writes:\n\n>> See a few nits below, none of which are necessarily worth a re-roll.\n>\n> Thanks!\n>\n> Junio, do you agree, do you want to fix it up on your side?\n\nI think you'd see all of them in what I've pushed out.\n\n>> > +one-off testing you should report the behavior difference as a bug in\n>>\n>> s/testing/&,/\n>>\n>> > +git (see https://git-scm.com/community for details).\n>>\n>> s/^git/Git/\n\nThe last one might be a bit iffy, as we are talking about (a\npossible bug in) a specific implementation of \"git\", as opposed to\nGit as general concept, but I took it anyway.\n\nThanks, all.\n"},{"id":"375808","messageId":"nycvar.QRO.7.76.6.1905172030050.46@tvgsbejvaqbjf.bet","threadId":"51088","inReplyTo":"xmqqo9445cba.fsf@gitster-ct.c.googlers.com","subject":"Re: [PATCH 1/1] stash: document stash.useBuiltin","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2019-05-17T18:30:24Z","receivedAt":"2019-05-17T18:30:25Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi Junio,\n\nOn Wed, 15 May 2019, Junio C Hamano wrote:\n\n> Johannes Schindelin writes:\n>\n> >> See a few nits below, none of which are necessarily worth a re-roll.\n> >\n> > Thanks!\n> >\n> > Junio, do you agree, do you want to fix it up on your side?\n>\n> I think you'd see all of them in what I've pushed out.\n\nIndeed, what you merged to `next` looks good to me, too.\n\nThanks,\nDscho\n"}]}