* [PATCH] doc: improve readability of --rebase-merges in git-rebase
@ 2019-11-10 9:59 Naveen Nathan
2019-11-11 8:49 ` Johannes Schindelin
2019-11-11 9:08 ` Junio C Hamano
0 siblings, 2 replies; 6+ messages in thread
From: Naveen Nathan @ 2019-11-10 9:59 UTC (permalink / raw)
To: git
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.
Signed-off-by: Naveen Nathan <naveen@lastninja.net>
---
Documentation/git-rebase.txt | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 639a4179d1..6a826b47bd 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -442,9 +442,9 @@ i.e. commits that would be excluded by linkgit:git-log[1]'s
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.
+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.
+
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
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: improve readability of --rebase-merges in git-rebase
2019-11-10 9:59 [PATCH] doc: improve readability of --rebase-merges in git-rebase Naveen Nathan
@ 2019-11-11 8:49 ` Johannes Schindelin
2019-11-11 9:08 ` Junio C Hamano
1 sibling, 0 replies; 6+ messages in thread
From: Johannes Schindelin @ 2019-11-11 8:49 UTC (permalink / raw)
To: Naveen Nathan; +Cc: git
Hi Naveen,
On Sun, 10 Nov 2019, Naveen Nathan wrote:
> 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.
>
> Signed-off-by: Naveen Nathan <naveen@lastninja.net>
> ---
> Documentation/git-rebase.txt | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index 639a4179d1..6a826b47bd 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -442,9 +442,9 @@ i.e. commits that would be excluded by linkgit:git-log[1]'s
> 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.
> +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 like it!
ACK,
Dscho
> +
> 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
>
>
>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: improve readability of --rebase-merges in git-rebase
2019-11-10 9:59 [PATCH] doc: improve readability of --rebase-merges in git-rebase Naveen Nathan
2019-11-11 8:49 ` Johannes Schindelin
@ 2019-11-11 9:08 ` Junio C Hamano
2019-11-11 21:44 ` Naveen Nathan
2019-11-11 23:21 ` [PATCH v2] " Naveen Nathan
1 sibling, 2 replies; 6+ messages in thread
From: Junio C Hamano @ 2019-11-11 9:08 UTC (permalink / raw)
To: Naveen Nathan; +Cc: git
Naveen Nathan <naveen@lastninja.net> 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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: improve readability of --rebase-merges in git-rebase
2019-11-11 9:08 ` Junio C Hamano
@ 2019-11-11 21:44 ` Naveen Nathan
2019-11-11 23:21 ` [PATCH v2] " Naveen Nathan
1 sibling, 0 replies; 6+ messages in thread
From: Naveen Nathan @ 2019-11-11 21:44 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
> 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
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v2] doc: improve readability of --rebase-merges in git-rebase
2019-11-11 9:08 ` Junio C Hamano
2019-11-11 21:44 ` Naveen Nathan
@ 2019-11-11 23:21 ` Naveen Nathan
2019-11-12 4:18 ` Junio C Hamano
1 sibling, 1 reply; 6+ messages in thread
From: Naveen Nathan @ 2019-11-11 23:21 UTC (permalink / raw)
To: git
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(-)
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
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH v2] doc: improve readability of --rebase-merges in git-rebase
2019-11-11 23:21 ` [PATCH v2] " Naveen Nathan
@ 2019-11-12 4:18 ` Junio C Hamano
0 siblings, 0 replies; 6+ messages in thread
From: Junio C Hamano @ 2019-11-12 4:18 UTC (permalink / raw)
To: Naveen Nathan; +Cc: git
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.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2019-11-12 4:18 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-11-10 9:59 [PATCH] doc: improve readability of --rebase-merges in git-rebase Naveen Nathan
2019-11-11 8:49 ` Johannes Schindelin
2019-11-11 9:08 ` Junio C Hamano
2019-11-11 21:44 ` Naveen Nathan
2019-11-11 23:21 ` [PATCH v2] " Naveen Nathan
2019-11-12 4:18 ` Junio C Hamano
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).