threads / patch / 6204

patchRe: [PATCH] Documentation/tutorial: misc updates

Subject: Re: [PATCH] Documentation/tutorial: misc updates

## tl;dr

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

replies: 4people: 4as markdown or json

Horst H. von Brand· Jan 3, 2007, 13:50 UTC · lore
Santi Béjar <sbejar@gmail.com> wrote:
Show 25 quoted lines
> Three changes:
> 1) Teach how to delete a branch with "git branch -d name".
> 2) The first commit does not have a parent.
> 3) Teach "git show" instead of "git cat-file -p".
> ---
>  Documentation/tutorial.txt |   17 +++++++++++++----
>  1 files changed, 13 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
> index d043e84..f0a5526 100644
> --- a/Documentation/tutorial.txt
> +++ b/Documentation/tutorial.txt
> @@ -222,6 +222,15 @@ $ gitk
>  
>  will show a nice graphical representation of the resulting history.
>  
> +At this point you could delete the experimental branch with
> +
> +------------------------------------------------
> +$ git branch -d experimental
> +------------------------------------------------
> +
> +This command ensures that the changes in the experimental branch are
> +already in the current branch.
> +
Huh? This deletes the branch, it doesn't ensure changes have been saved.
Show 11 quoted lines
>  If you develop on a branch crazy-idea, then regret it, you can always
>  delete the branch with
>  
> @@ -391,8 +400,8 @@ $ git show HEAD		# the tip of the current branch
>  $ git show experimental	# the tip of the "experimental" branch
>  -------------------------------------
>  
> -Every commit has at least one "parent" commit, which points to the
> -previous state of the project:
> +Every commit has at least one "parent" commit (except the first),
> +which points to the previous state of the project:

And how can it have more than one parent? If you mention it, better come clean about merges (can be explained in detail later).

>  -------------------------------------
>  $ git show HEAD^  # to see the parent of HEAD
And if there are several parents?
> @@ -510,10 +519,10 @@ of the file:
>  $ git diff v2.5:Makefile HEAD:Makefile.in
>  -------------------------------------
HEAD:Makefile.in doesn't need HEAD.
-- 
Dr. Horst H. von Brand                   User #22616 counter.li.org
Departamento de Informatica                    Fono: +56 32 2654431
Universidad Tecnica Federico Santa Maria             +56 32 2654239
Casilla 110-V, Valparaiso, Chile               Fax:  +56 32 2797513
Jakub Narebski· Jan 3, 2007, 14:07 UTC · re: Horst H. von Brand · lore
Horst H. von Brand wrote:
Show 9 quoted lines
>> +------------------------------------------------
>> +$ git branch -d experimental
>> +------------------------------------------------
>> +
>> +This command ensures that the changes in the experimental branch are
>> +already in the current branch.
>> +
> 
> Huh? This deletes the branch, it doesn't ensure changes have been saved.

It ensures that the branch we want to delete is in lineage of current branch (otherwise we would have to use -D).

-- 
Jakub Narebski
Warsaw, Poland
ShadeHawk on #git
Santi Béjar· Jan 3, 2007, 14:09 UTC · re: Horst H. von Brand · lore
On 1/3/07, Horst H. von Brand <vonbrand@inf.utfsm.cl> wrote:
Show 28 quoted lines
> Santi Béjar <sbejar@gmail.com> wrote:
> > Three changes:
> > 1) Teach how to delete a branch with "git branch -d name".
> > 2) The first commit does not have a parent.
> > 3) Teach "git show" instead of "git cat-file -p".
> > ---
> >  Documentation/tutorial.txt |   17 +++++++++++++----
> >  1 files changed, 13 insertions(+), 4 deletions(-)
> >
> > diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
> > index d043e84..f0a5526 100644
> > --- a/Documentation/tutorial.txt
> > +++ b/Documentation/tutorial.txt
> > @@ -222,6 +222,15 @@ $ gitk
> >
> >  will show a nice graphical representation of the resulting history.
> >
> > +At this point you could delete the experimental branch with
> > +
> > +------------------------------------------------
> > +$ git branch -d experimental
> > +------------------------------------------------
> > +
> > +This command ensures that the changes in the experimental branch are
> > +already in the current branch.
> > +
>
> Huh? This deletes the branch, it doesn't ensure changes have been saved.
It deletes the branch only if the current branch is fast-forwarding it.
Could be rephrase as:

This command only delete the experimental branch if it is already merge in the current branch.

Show 15 quoted lines
>
> >  If you develop on a branch crazy-idea, then regret it, you can always
> >  delete the branch with
> >
> > @@ -391,8 +400,8 @@ $ git show HEAD           # the tip of the current branch
> >  $ git show experimental      # the tip of the "experimental" branch
> >  -------------------------------------
> >
> > -Every commit has at least one "parent" commit, which points to the
> > -previous state of the project:
> > +Every commit has at least one "parent" commit (except the first),
> > +which points to the previous state of the project:
>
> And how can it have more than one parent? If you mention it, better come
> clean about merges (can be explained in detail later).

I have not mentined it, I've just added the exception that the firt/root commits have zero parents.

Show 5 quoted lines
>
> >  -------------------------------------
> >  $ git show HEAD^  # to see the parent of HEAD
>
> And if there are several parents?
Already explained before.
Show 6 quoted lines
>
> > @@ -510,10 +519,10 @@ of the file:
> >  $ git diff v2.5:Makefile HEAD:Makefile.in
> >  -------------------------------------
>
> HEAD:Makefile.in doesn't need HEAD.

Not needed if the Makefile.in in the working directory is equal to the file in HEAD. But better explain new things.

Santi
Junio C Hamano· Jan 3, 2007, 16:24 UTC · re: Santi Béjar · lore
"Santi Béjar" <sbejar@gmail.com> writes:
Show 13 quoted lines
> On 1/3/07, Horst H. von Brand <vonbrand@inf.utfsm.cl> wrote:
>> Santi Béjar <sbejar@gmail.com> wrote:
>> >
>> > -Every commit has at least one "parent" commit, which points to the
>> > -previous state of the project:
>> > +Every commit has at least one "parent" commit (except the first),
>> > +which points to the previous state of the project:
>>
>> And how can it have more than one parent? If you mention it, better come
>> clean about merges (can be explained in detail later).
>
> I have not mentined it, I've just added the exception that the
> firt/root commits have zero parents.
Well, it does not matter who originally is at fault ;-).
Let's just do this.
Show changes to Documentation/tutorial.txt +1 −1
diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
index f0a5526..0cc234f 100644
--- a/Documentation/tutorial.txt
+++ b/Documentation/tutorial.txt
@@ -400,7 +400,7 @@ $ git show HEAD		# the tip of the current branch
 $ git show experimental	# the tip of the "experimental" branch
 -------------------------------------
 
-Every commit has at least one "parent" commit (except the first),
+Every commit usually has one "parent" commit
 which points to the previous state of the project:
 
 -------------------------------------

After this paragraph, we say "merge has more than one", so it's
all consistent and presented in the right order.  By the time
the reader starts wondering about the initial commit, we've
shown the use of HEAD^^^^ and HEAD~$n enough that the reader can
experiment on his/her own.
Santi Béjar· Jan 3, 2007, 17:31 UTC · re: Junio C Hamano · lore
On 1/3/07, Junio C Hamano <junkio@cox.net> wrote:
Show 17 quoted lines
> "Santi Béjar" <sbejar@gmail.com> writes:
>
> > On 1/3/07, Horst H. von Brand <vonbrand@inf.utfsm.cl> wrote:
> >> Santi Béjar <sbejar@gmail.com> wrote:
> >> >
> >> > -Every commit has at least one "parent" commit, which points to the
> >> > -previous state of the project:
> >> > +Every commit has at least one "parent" commit (except the first),
> >> > +which points to the previous state of the project:
> >>
> >> And how can it have more than one parent? If you mention it, better come
> >> clean about merges (can be explained in detail later).
> >
> > I have not mentined it, I've just added the exception that the
> > firt/root commits have zero parents.
>
> Well, it does not matter who originally is at fault ;-).
Sure, we all try to make git better and better.
Show 22 quoted lines
>
> Let's just do this.
>
> diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
> index f0a5526..0cc234f 100644
> --- a/Documentation/tutorial.txt
> +++ b/Documentation/tutorial.txt
> @@ -400,7 +400,7 @@ $ git show HEAD             # the tip of the current branch
>  $ git show experimental        # the tip of the "experimental" branch
>  -------------------------------------
>
> -Every commit has at least one "parent" commit (except the first),
> +Every commit usually has one "parent" commit
>  which points to the previous state of the project:
>
>  -------------------------------------
>
> After this paragraph, we say "merge has more than one", so it's
> all consistent and presented in the right order.  By the time
> the reader starts wondering about the initial commit, we've
> shown the use of HEAD^^^^ and HEAD~$n enough that the reader can
> experiment on his/her own.
OK here.
Santi

← back to recent threads