git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Johannes Schindelin via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
	Johannes Schindelin <johannes.schindelin@gmx.de>
Subject: Re: [PATCH 1/1] stash: document stash.useBuiltin
Date: Tue, 14 May 2019 11:44:54 +0200	[thread overview]
Message-ID: <87k1etwesp.fsf@evledraar.gmail.com> (raw)
In-Reply-To: <6c250451658f34c1415bfcba35ee6303cecac0dc.1557825553.git.gitgitgadget@gmail.com>


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.

  reply	other threads:[~2019-05-14  9:44 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87k1etwesp.fsf@evledraar.gmail.com \
    --to=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=gitster@pobox.com \
    --cc=johannes.schindelin@gmx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).