threads / patch / 50656

patchdoc/rebase: extend examples to show continuing branches

Subject: [PATCH] doc/rebase: extend examples to show continuing branches

## tl;dr

3 messages between Mar 5, 2019 and Mar 5, 2019. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Robert P. J. Day· Mar 5, 2019, 10:48 UTC · lore

Currently, all of the examples for "man git-rebase" show rebasing from a branch that has had no further development, which might mislead readers into thinking that that is a necessary condition for rebasing, so tweak the examples to show further development on such a branch to clarify that.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
---
Show changes to Documentation/git-rebase.txt +4 −4
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 5629ba4c5d..ba3c44fdaf 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -109,8 +109,8 @@ functionality which is found in 'next'.
     o---o---o---o---o  master
          \
           o---o---o---o---o  next
-                           \
-                            o---o---o  topic
+                   \
+                    o---o---o  topic
 ------------

 We want to make 'topic' forked from branch 'master'; for example,
@@ -134,8 +134,8 @@ Another example of --onto option is to rebase part of a
 branch.  If we have the following situation:

 ------------
-                            H---I---J topicB
-                           /
+                        H---I---J topicB
+                       /
                   E---F---G  topicA
                  /
     A---B---C---D  master

-- 
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                  http://crashcourse.ca/dokuwiki

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
Junio C Hamano· Mar 5, 2019, 14:03 UTC · re: Robert P. J. Day · lore

Re: [PATCH] doc/rebase: extend examples to show continuing branches

"Robert P. J. Day" <rpjday@crashcourse.ca> writes:
Show 5 quoted lines
> Currently, all of the examples for "man git-rebase" show rebasing from
> a branch that has had no further development, which might mislead
> readers into thinking that that is a necessary condition for rebasing,
> so tweak the examples to show further development on such a branch to
> clarify that.

We state the status-quo in present tense to start problem description, so "Currently" is a noise word you can and should omit.

As I already said, at least one example that rebases a branch that was forked from the midpoint of another branch, so the problem description is already false. If we apply this patch, do we lose all examples that rebase a branch that purely builds on top of the tip of another branch? That would also mislead readers into thinking that you need to advance the base branch before you can rebase the forked branch ;-).

Robert P. J. Day· Mar 5, 2019, 14:04 UTC · re: Junio C Hamano · lore

Re: [PATCH] doc/rebase: extend examples to show continuing branches

On Tue, 5 Mar 2019, Junio C Hamano wrote:
Show 18 quoted lines
> "Robert P. J. Day" <rpjday@crashcourse.ca> writes:
>
> > Currently, all of the examples for "man git-rebase" show rebasing from
> > a branch that has had no further development, which might mislead
> > readers into thinking that that is a necessary condition for rebasing,
> > so tweak the examples to show further development on such a branch to
> > clarify that.
>
> We state the status-quo in present tense to start problem
> description, so "Currently" is a noise word you can and should omit.
>
> As I already said, at least one example that rebases a branch that
> was forked from the midpoint of another branch, so the problem
> description is already false.  If we apply this patch, do we lose
> all examples that rebase a branch that purely builds on top of the
> tip of another branch?  That would also mislead readers into
> thinking that you need to advance the base branch before you can
> rebase the forked branch ;-).
  i stand corrected. carry on. :-)
rday
-- 
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                  http://crashcourse.ca/dokuwiki

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

← back to recent threads