Re: [PATCH] doc: improve readability of --rebase-merges in git-rebase

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 11, 2019, 09:08 UTC
Message-ID: <xmqqr22ehjbg.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20191110095942.GB6071@a.local>

Naveen Nathan <naveen@lastninja.net> writes:

Show 12 quoted lines

> When --rebase-merges was introduced in 427c3bd28a the sentence
> describing the difference between --rebase-merges and --preserve-merges
> is a little unclear and difficult to parse. This patch improves readability
> while retaining original meaning.
>
> ...
> -The `--rebase-merges` mode is similar in spirit to the deprecated
> -`--preserve-merges`, but in contrast to that option works well in interactive
> -rebases: commits can be reordered, inserted and dropped at will.
> +The `--rebase-merges` mode is similar in spirit to `--preserve-merges`
> +(deprecated) but actually works with interactive rebases, where commits
> +can be reordered, inserted and dropped at will.

I think the original "to the deprecated `--preserve-merges`" is mildly easier to follow than "to `--preserve-merges` (deprecated)".

The later part of the sentence with this patch does read smoother and is a definite improvement.

Thanks.