Re: [PATCH v2 08/10] git-rebase.txt: correct out-of-date and misleading text about renames

From: Ramsay Jones <ramsay@ramsayjones.plus.com>
Date: Aug 4, 2021, 15:50 UTC
Message-ID: <eff818fc-9f4d-35db-a4df-8b05408d7d6c@ramsayjones.plus.com>
In-Reply-To: <8978132397e95accee5676309d81832724aebba5.1628054936.git.gitgitgadget@gmail.com>

Hi Elijah,

On 04/08/2021 06:28, Elijah Newren via GitGitGadget wrote:

Show 10 quoted lines

> From: Elijah Newren <newren@gmail.com>
> 
> Commit 58634dbff8 ("rebase: Allow merge strategies to be used when
> rebasing", 2006-06-21) added the --merge option to git-rebase so that
> renames could be detected (at least when using the `recursive` merge
> backend).  However, git-am -3 gained that same ability in commit
> 579c9bb198 ("Use merge-recursive in git-am -3.", 2006-12-28).  As such,
> the comment about being able to detect renames is not particularly
> noteworthy.  Remove it.  While tweaking this description, add a quick
> comment about when --merge became the default.

The last sentence of the commit message does not seem to apply to this patch (any more ...?).

[Awesome work on 'merge -sort', by the way!]

ATB, Ramsay Jones

Show 22 quoted lines

> 
> Signed-off-by: Elijah Newren <newren@gmail.com>
> ---
>  Documentation/git-rebase.txt | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index cecdcfff47a..73d49ec8d91 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -340,9 +340,7 @@ See also INCOMPATIBLE OPTIONS below.
>  
>  -m::
>  --merge::
> -	Use merging strategies to rebase.  When the recursive (default) merge
> -	strategy is used, this allows rebase to be aware of renames on the
> -	upstream side.  This is the default.
> +	Using merging strategies to rebase (default).
>  +
>  Note that a rebase merge works by replaying each commit from the working
>  branch on top of the <upstream> branch.  Because of this, when a merge
>