[v2] doc: improve readability of --rebase-merges in git-rebase
diff mbox series

Message ID 20191111232137.GA29586@a.local
State New
Headers show
Series
  • [v2] doc: improve readability of --rebase-merges in git-rebase
Related show

Commit Message

Naveen Nathan Nov. 11, 2019, 11:21 p.m. UTC
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 <naveen@lastninja.net>
---
 Documentation/git-rebase.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Junio C Hamano Nov. 12, 2019, 4:18 a.m. UTC | #1
Naveen Nathan <naveen@lastninja.net> writes:

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

I notice that the above also was rewritten since v1 and I think it
is a very good change.

Thanks, will queue.

Patch
diff mbox series

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