Re: [PATCH] Add a reference to gitk localbranc remote/branch in gittutorial

[Junio C Hamano <gitster@pobox.com>]

"Paolo Ciarrocchi" <paolo.ciarrocchi@gmail.com> writes:

> Maybe something like that?
> Not intended to be applied, probably manglade and with no sob.
> Just for discussion:
>
> diff --git a/gittutorial.txt.txt b/gittutorial.txt.txt
> index 48d1454..4f6d4e9 100644
> --- a/gittutorial.txt.txt
> +++ b/gittutorial.txt.txt
> @@ -321,10 +321,51 @@ pulling, like this:
>
>  ------------------------------------------------
>  alice$ git fetch /home/bob/myrepo master
> -alice$ git log -p ..FETCH_HEAD
> +alice$ git log -p HEAD..FETCH_HEAD
>  ------------------------------------------------
>
>  This operation is safe even if Alice has uncommitted local changes.
> +Note that HEAD, that means your current state, can be dropped on either
> +side of the two-dot range notation.

Descriptions of individual steps all looked good, but the presentation
order is a bit screwy here.  You are introducing two-dot range without
explaining what it means here, and the explanation comes a bit later.

So here are the tweaks I would suggest:

 * Show only "git log -p HEAD..FETCH_HEAD" here;

 * After "This operation is safe ... local changes.", say "The range
   notation HEAD..FETCH_HEAD" means "show everything that is reachable
   from the FETCH_HEAD but exclude anything that is reachable from HEAD.
   Alice already knows everything that leads to her current state (HEAD),
   and reviewing what Bob has in his state (FETCH_HEAD) that she has not
   seen with this command";

 * Drop "This means..." and "log -p ..FETCH" example;
 
 * Replace the explanation for the two-dot range notation after "gitk
   HEAD..FETCH_HEAD" with "This uses the same two-dot range notation we
   saw earlier with 'git log'".

 * And finally, if we wanted to, we can top about omission of HEAD in
   either end of the range notation.  Just before "Please note that these
   range notation...", say "Because viewing range between your current
   state and something else is common, you can omit HEAD from either side
   of two- or three-dot range notation.  I.e. 'git log ..FETCH_HEAD' is a
   shorthand for 'git log HEAD..FETCH_HEAD', and 'gitk ...FETCH_HEAD' is a
   shorthand for 'gitk HEAD...FETCH_HEAD'.

> +This means that Alice can also inspect what Bod did issuing the following
> +command:
> +
> +------------------------------------------------
> +alice$ git log -p ..FETCH_HEAD
> +------------------------------------------------
> +
> +Alice can use gitk to compare what both of them did:
> +
> +------------------------------------------------
> +$ gitk HEAD FETCH_HEAD
> +------------------------------------------------
> +
> +This shows both histories leading to Alice's current state (HEAD) and the
> +state Alice just fetched from Bob (FETCH_HEAD).
> +
> +If Alice wants to visualize what Bob did since their historie forked
> +she can issue the following command:
> +
> +------------------------------------------------
> +$ gitk HEAD..FETCH_HEAD
> +------------------------------------------------
> +
> +Two commits written with two dots in between means "show
> +everything that is reachable from the latter but excluding
> +anything that is reachable from the former".
> +
> +Alice may want to view what both of them did since they forked.
> +She can use three-dot form instead of the two-dot form:
> +
> +------------------------------------------------
> +$ gitk HEAD...FETCH_HEAD
> +------------------------------------------------
> +
> +This means "show everything that is reachable from either one, but
> +exclude anything that is reachable from both of them".
> +
> +Please note that these range notation can be used with both gitk
> +and "git log".
>
>  After inspecting what Bob did, if there is nothing urgent, Alice may
>  decide to continue working without pulling from Bob.  If Bob's history