Skip to content

Commit f471dbc

Browse files
committed
fetch doc: update note on '+' in front of the refspec
While it is not *wrong* per-se to say that pulling a rewound/rebased branch will lead to an unnecessary merge conflict, that is not what the leading "+" sign to allow non-fast-forward update of remote-tracking branch is at all. Helped-by: Marc Branchaud <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 366a018 commit f471dbc

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Documentation/pull-fetch-param.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ is updated even if it does not result in a fast-forward
2424
update.
2525
+
2626
[NOTE]
27-
If the remote branch from which you want to pull is
28-
modified in non-linear ways such as being rewound and
29-
rebased frequently, then a pull will attempt a merge with
30-
an older version of itself, likely conflict, and fail.
31-
It is under these conditions that you would want to use
32-
the `+` sign to indicate non-fast-forward updates will
33-
be needed. There is currently no easy way to determine
34-
or declare that a branch will be made available in a
35-
repository with this behavior; the pulling user simply
27+
When the remote branch you want to fetch is known to
28+
be rewound and rebased regularly, it is expected that
29+
its new tip will not be descendant of its previous tip
30+
(as stored in your remote-tracking branch the last time
31+
you fetched). You would want
32+
to use the `+` sign to indicate non-fast-forward updates
33+
will be needed for such branches. There is no way to
34+
determine or declare that a branch will be made available
35+
in a repository with this behavior; the pulling user simply
3636
must know this is the expected usage pattern for a branch.
3737
+
3838
[NOTE]

0 commit comments

Comments
 (0)