Re: [PATCH 1/1] stash: document stash.useBuiltin

From: Eric Sunshine <sunshine@sunshineco.com>
Date: May 14, 2019, 19:57 UTC
Message-ID: <CAPig+cRoyOJrEuVY109NKafTCUc399p9tk64L9sZok=AOZ1MPg@mail.gmail.com>
In-Reply-To: <6c250451658f34c1415bfcba35ee6303cecac0dc.1557825553.git.gitgitgadget@gmail.com>

On Tue, May 14, 2019 at 5:19 AM Johannes Schindelin via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 8 quoted lines

> 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.

Show 5 quoted lines

> 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/