Re: [PATCH 03/16] pull: cleanup documentation

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 31, 2013, 18:11 UTC
Message-ID: <xmqqiowd71kv.fsf@gitster.dls.corp.google.com>
In-Reply-To: <1383211547-9145-4-git-send-email-felipe.contreras@gmail.com>

Felipe Contreras <felipe.contreras@gmail.com> writes:

Show 21 quoted lines

> 'origin/master' is very clear, no need to specify the 'remotes/' prefix,
> or babysit the user.
>
> Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
> ---
>  Documentation/git-pull.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
> index beea10b..03a39bc 100644
> --- a/Documentation/git-pull.txt
> +++ b/Documentation/git-pull.txt
> @@ -39,7 +39,7 @@ Assume the following history exists and the current branch is
>  "`master`":
>  
>  ------------
> -	  A---B---C master on origin
> +	  A---B---C origin/master
>  	 /
>      D---E---F---G master
>  ------------

This change is wrong; the illustration depicts the distributed world (i.e. a fetch has not happened yet). The next sentence after this picture reads:

    Then "`git pull`" will fetch and replay the changes from the remote
    `master` branch since it diverged from the local `master`

In other words, your (remotes/)origin/master has _not_ caught up to the reality.

Show 9 quoted lines

> @@ -51,7 +51,7 @@ result in a new commit along with the names of the two parent commits
>  and a log message from the user describing the changes.
>  
>  ------------
> -	  A---B---C remotes/origin/master
> +	  A---B---C origin/master
>  	 /         \
>      D---E---F---G---H master
>  ------------

This is a good change, especially in today's world.

Thanks.