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

Naveen Nathan [off-list ref] writes:

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.

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

I've incorporated the suggestion and will submit a new patch shortly.

- Naveen

When --preserve-merges was deprecated in 427c3bd28a a sentence
was introduced describing the difference between --rebase-merges and
--preserve-merges which is a little unclear and difficult to parse.
This patch improves readability while retaining original meaning.

Signed-off-by: Naveen Nathan <redacted>
---
 Documentation/git-rebase.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 639a4179d1..0c4f038dd6 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt

@@ -443,8 +443,8 @@ the `rebase-cousins` mode is turned on, such commits are instead rebased
 onto `<upstream>` (or `<onto>`, if specified).
 +
 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.
+`--preserve-merges` but works with interactive rebases,
+where commits can be reordered, inserted and dropped at will.
 +
 It is currently only possible to recreate the merge commits using the
 `recursive` merge strategy; Different merge strategies can be used only via

-- 
2.21.0