# [PATCH] doc: improve readability of --rebase-merges in git-rebase 6 messages from 2019-11-10 to 2019-11-12. Participants: Naveen Nathan, Johannes Schindelin, Junio C Hamano. Thread: https://gitlist.dev/t/52230 ## Naveen Nathan, 2019-11-10 09:59 Subject: [PATCH] doc: improve readability of --rebase-merges in git-rebase Message-ID: <20191110095942.GB6071@a.local> URL: https://gitlist.dev/e/20191110095942.GB6071%40a.local ``` 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 --- 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 `` (or ``, 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 ``` ## Johannes Schindelin, 2019-11-11 08:49 Subject: Re: [PATCH] doc: improve readability of --rebase-merges in git-rebase Message-ID: URL: https://gitlist.dev/e/nycvar.QRO.7.76.6.1911110948270.46%40tvgsbejvaqbjf.bet In-Reply-To: <20191110095942.GB6071@a.local> ``` 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 > --- > 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 `` (or ``, 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 > > > ``` ## Junio C Hamano, 2019-11-11 09:08 Subject: Re: [PATCH] doc: improve readability of --rebase-merges in git-rebase Message-ID: URL: https://gitlist.dev/e/xmqqr22ehjbg.fsf%40gitster-ct.c.googlers.com In-Reply-To: <20191110095942.GB6071@a.local> ``` Naveen Nathan 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. ``` ## Naveen Nathan, 2019-11-11 21:44 Subject: Re: [PATCH] doc: improve readability of --rebase-merges in git-rebase Message-ID: <556b38ff-a118-43b3-8024-cf6dd97253ff@www.fastmail.com> URL: https://gitlist.dev/e/556b38ff-a118-43b3-8024-cf6dd97253ff%40www.fastmail.com In-Reply-To: ``` > 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 ``` ## Naveen Nathan, 2019-11-11 23:21 Subject: [PATCH v2] doc: improve readability of --rebase-merges in git-rebase Message-ID: <20191111232137.GA29586@a.local> URL: https://gitlist.dev/e/20191111232137.GA29586%40a.local In-Reply-To: ``` 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 --- 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 `` (or ``, 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 ``` ## Junio C Hamano, 2019-11-12 04:18 Subject: Re: [PATCH v2] doc: improve readability of --rebase-merges in git-rebase Message-ID: URL: https://gitlist.dev/e/xmqqy2wlg22e.fsf%40gitster-ct.c.googlers.com In-Reply-To: <20191111232137.GA29586@a.local> ``` Naveen Nathan 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. ```