Re: [PATCH 06/10] merge-strategies.txt: avoid giving special preference to patience algorithm

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Aug 3, 2021, 17:00 UTC
Message-ID: <CAPig+cRrSnrD4jnOOrbqZUbvkxKi0oLH51L0dxC+m9nzDnmf4w@mail.gmail.com>
In-Reply-To: <6116f4750fd228b96ee293033f867a964b87eb5f.1628004920.git.gitgitgadget@gmail.com>

On Tue, Aug 3, 2021 at 11:35 AM Elijah Newren via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 18 quoted lines

> We already have diff-algorithm that explains why there are special diff
> algorithms, so we do not need to re-explain patience.  patience exists
> as its own toplevel option for historical reasons, but there's no reason
> to give it special preference or document it again and suggest it's more
> important than other diff algorithms, so just refer to it as a
> deprecated shorthand for `diff-algorithm=patience`.
>
> Signed-off-by: Elijah Newren <newren@gmail.com>
> ---
> diff --git a/Documentation/merge-strategies.txt b/Documentation/merge-strategies.txt
> @@ -37,11 +37,7 @@ theirs;;
>  patience;;
> -       With this option, 'merge-recursive' spends a little extra time
> -       to avoid mismerges that sometimes occur due to unimportant
> -       matching lines (e.g., braces from distinct functions).  Use
> -       this when the branches to be merged have diverged wildly.
> -       See also linkgit:git-diff[1] `--patience`.
> +       Deprecated shorthand for diff-algorithm=patience.

Probably want to wrap backticks around `diff-algorithm=patience`. The rest of this file seems to be pretty consistent about it. Indeed, the existing deprecation in this file does so:

    rename-threshold=<n>;;
        Deprecated synonym for `find-renames=<n>`.

Maybe also s/shorthand/synonym/ for consistency with the existing deprecation notice.