| Message ID | 20191110095942.GB6071@a.local (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | doc: improve readability of --rebase-merges in git-rebase | expand |
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 > > >
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.
> 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
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
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(-)