git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / Atom feed
* [PATCH 0/1] Document the stash.useBuiltin escape hatch
@ 2019-05-14  9:19 Johannes Schindelin via GitGitGadget
  2019-05-14  9:19 ` [PATCH 1/1] stash: document stash.useBuiltin Johannes Schindelin via GitGitGadget
  0 siblings, 1 reply; 8+ messages in thread
From: Johannes Schindelin via GitGitGadget @ 2019-05-14  9:19 UTC (permalink / raw)
  To: git; +Cc: Ævar Arnfjörð Bjarmason, Junio C Hamano

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

^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH 1/1] stash: document stash.useBuiltin
  2019-05-14  9:19 [PATCH 0/1] Document the stash.useBuiltin escape hatch Johannes Schindelin via GitGitGadget
@ 2019-05-14  9:19 ` Johannes Schindelin via GitGitGadget
  2019-05-14  9:44   ` Ævar Arnfjörð Bjarmason
  2019-05-14 19:57   ` Eric Sunshine
  0 siblings, 2 replies; 8+ messages in thread
From: Johannes Schindelin via GitGitGadget @ 2019-05-14  9:19 UTC (permalink / raw)
  To: git
  Cc: Ævar Arnfjörð Bjarmason, Junio C Hamano,
	Johannes Schindelin

From: Johannes Schindelin <johannes.schindelin@gmx.de>

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 <johannes.schindelin@gmx.de>
---
 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

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] stash: document stash.useBuiltin
  2019-05-14  9:19 ` [PATCH 1/1] stash: document stash.useBuiltin Johannes Schindelin via GitGitGadget
@ 2019-05-14  9:44   ` Ævar Arnfjörð Bjarmason
  2019-05-15  1:15     ` Junio C Hamano
  2019-05-14 19:57   ` Eric Sunshine
  1 sibling, 1 reply; 8+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2019-05-14  9:44 UTC (permalink / raw)
  To: Johannes Schindelin via GitGitGadget
  Cc: git, Junio C Hamano, Johannes Schindelin


On Tue, May 14 2019, Johannes Schindelin via GitGitGadget wrote:

> From: Johannes Schindelin <johannes.schindelin@gmx.de>
>
> 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 <johannes.schindelin@gmx.de>
> ---
>  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.

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] stash: document stash.useBuiltin
  2019-05-14  9:19 ` [PATCH 1/1] stash: document stash.useBuiltin Johannes Schindelin via GitGitGadget
  2019-05-14  9:44   ` Ævar Arnfjörð Bjarmason
@ 2019-05-14 19:57   ` Eric Sunshine
  2019-05-15  8:26     ` Johannes Schindelin
  1 sibling, 1 reply; 8+ messages in thread
From: Eric Sunshine @ 2019-05-14 19:57 UTC (permalink / raw)
  To: Johannes Schindelin via GitGitGadget
  Cc: Git List, Ævar Arnfjörð Bjarmason, Junio C Hamano,
	Johannes Schindelin

On Tue, May 14, 2019 at 5:19 AM Johannes Schindelin via GitGitGadget
<gitgitgadget@gmail.com> 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 <johannes.schindelin@gmx.de>
> ---
> 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/

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] stash: document stash.useBuiltin
  2019-05-14  9:44   ` Ævar Arnfjörð Bjarmason
@ 2019-05-15  1:15     ` Junio C Hamano
  0 siblings, 0 replies; 8+ messages in thread
From: Junio C Hamano @ 2019-05-15  1:15 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason
  Cc: Johannes Schindelin via GitGitGadget, git, Johannes Schindelin

Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:

> Thanks for following up on this. LGTM.

Yeah, thanks, both.

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] stash: document stash.useBuiltin
  2019-05-14 19:57   ` Eric Sunshine
@ 2019-05-15  8:26     ` Johannes Schindelin
  2019-05-15  8:52       ` Junio C Hamano
  0 siblings, 1 reply; 8+ messages in thread
From: Johannes Schindelin @ 2019-05-15  8:26 UTC (permalink / raw)
  To: Eric Sunshine
  Cc: Johannes Schindelin via GitGitGadget, Git List,
	Ævar Arnfjörð Bjarmason, Junio C Hamano

Hi Eric,

On Tue, 14 May 2019, Eric Sunshine wrote:

> On Tue, May 14, 2019 at 5:19 AM Johannes Schindelin via GitGitGadget
> <gitgitgadget@gmail.com> 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 <johannes.schindelin@gmx.de>
> > ---
> > 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/
>

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] stash: document stash.useBuiltin
  2019-05-15  8:26     ` Johannes Schindelin
@ 2019-05-15  8:52       ` Junio C Hamano
  2019-05-17 18:30         ` Johannes Schindelin
  0 siblings, 1 reply; 8+ messages in thread
From: Junio C Hamano @ 2019-05-15  8:52 UTC (permalink / raw)
  To: Johannes Schindelin
  Cc: Eric Sunshine, Johannes Schindelin via GitGitGadget, Git List,
	Ævar Arnfjörð Bjarmason

Johannes Schindelin <Johannes.Schindelin@gmx.de> 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.

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] stash: document stash.useBuiltin
  2019-05-15  8:52       ` Junio C Hamano
@ 2019-05-17 18:30         ` Johannes Schindelin
  0 siblings, 0 replies; 8+ messages in thread
From: Johannes Schindelin @ 2019-05-17 18:30 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: Eric Sunshine, Johannes Schindelin via GitGitGadget, Git List,
	Ævar Arnfjörð Bjarmason

Hi Junio,

On Wed, 15 May 2019, Junio C Hamano wrote:

> Johannes Schindelin <Johannes.Schindelin@gmx.de> 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

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, back to index

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-05-14  9:19 [PATCH 0/1] Document the stash.useBuiltin escape hatch Johannes Schindelin via GitGitGadget
2019-05-14  9:19 ` [PATCH 1/1] stash: document stash.useBuiltin Johannes Schindelin via GitGitGadget
2019-05-14  9:44   ` Ævar Arnfjörð Bjarmason
2019-05-15  1:15     ` Junio C Hamano
2019-05-14 19:57   ` Eric Sunshine
2019-05-15  8:26     ` Johannes Schindelin
2019-05-15  8:52       ` Junio C Hamano
2019-05-17 18:30         ` Johannes Schindelin

git@vger.kernel.org list mirror (unofficial, one of many)

Archives are clonable:
	git clone --mirror https://public-inbox.org/git
	git clone --mirror http://ou63pmih66umazou.onion/git
	git clone --mirror http://czquwvybam4bgbro.onion/git
	git clone --mirror http://hjrcffqmbrq6wope.onion/git

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.version-control.git
	nntp://ou63pmih66umazou.onion/inbox.comp.version-control.git
	nntp://czquwvybam4bgbro.onion/inbox.comp.version-control.git
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.version-control.git
	nntp://news.gmane.org/gmane.comp.version-control.git

 note: .onion URLs require Tor: https://www.torproject.org/

AGPL code for this site: git clone https://public-inbox.org/ public-inbox