[patch] add simple git documentation

[patch] add simple git documentation

[Pavel Machek]

This adds short intro to git aimed at kernel hackers.

Signed-off-by: Pavel Machek <pavel@suse.cz>

---
commit addb0833bdadda14495d66749e6cb95b6a9445d7
tree 7e66cb899004fbec0fadae5c9265d0731d3a26f3
parent 1f9ca1262e6b27dde44d456a87c456d15f0a9b80
author <pavel@amd.(none)> 1115288688 +0200
committer <pavel@amd.(none)> 1115288688 +0200

Index: Documentation/git.txt
===================================================================
--- /dev/null  (tree:de65e7579ed050d324357e3040b37c561676ab7d)
+++ 7e66cb899004fbec0fadae5c9265d0731d3a26f3/Documentation/git.txt  (mode:100644 sha1:353d5ae7f46eeb79c058be611cb429622167f784)
@@ -0,0 +1,41 @@
+	Kernel hacker's guide to git
+	~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+      2005 Pavel Machek <pavel@suse.cz>
+
+You can get cogito at http://www.kernel.org/pub/software/scm/cogito/
+. Compile it, and place it somewhere in $PATH. Then you can get kernel
+by running
+
+mkdir clean-cg; cd clean-cg
+cg-init rsync://rsync.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
+
+... Do cg-update origin to pickup latest changes from Linus. You can
+do cg-diff to see what changes you done in your local tree. cg-cancel
+will kill any such changes, and cg-commit will make them permanent.
+
+To get diff between your working tree and "next tree up", do cg-diff
+-r origin: . If you want to get the same diff but separated
+patch-by-patch, do cg-mkpatch origin: . If you want to pull changes
+from the "up" tree to your working tree, do cg-update origin.
+
+
+How to set up your trees so that you can cooperate with Linus
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+What I did:
+
+Created clean-cg. Initialized straight from Linus (as above). Then I
+created "nice" tree, good for Linus to pull from 
+
+mkdir /data/l/linux-good; cd /data/l/linux-good
+cg-init /data/l/clean-cg
+
+and then my working tree, based on linux-good
+
+mkdir /data/l/linux-cg; cd /data/l/linux-cg
+cg-init /data/l/linux-good
+
+. I do my work in linux-cg. If someone sends me nice patch I should
+pass up, I apply it to linux-good with nice message and do
+
+cd /data/l/linux-cg; cg-update origin

-- 
Boycott Kodak -- for their patent abuse against Java.

Re: [patch] add simple git documentation

[Andrew Morton]

Pavel Machek <pavel@ucw.cz> wrote:
>
> This adds short intro to git aimed at kernel hackers.
> 

OK, but I'm hoping that shortly we'll have something more complete than
this, and your patch might not be a suitable starting point for that. 
(Large hint-dropping sounds).



> 
> ---
> commit addb0833bdadda14495d66749e6cb95b6a9445d7
> tree 7e66cb899004fbec0fadae5c9265d0731d3a26f3
> parent 1f9ca1262e6b27dde44d456a87c456d15f0a9b80
> author <pavel@amd.(none)> 1115288688 +0200
> committer <pavel@amd.(none)> 1115288688 +0200
> 
> Index: Documentation/git.txt
> ===================================================================
> --- /dev/null  (tree:de65e7579ed050d324357e3040b37c561676ab7d)
> +++ 7e66cb899004fbec0fadae5c9265d0731d3a26f3/Documentation/git.txt  (mode:100644 sha1:353d5ae7f46eeb79c058be611cb429622167f784)
> @@ -0,0 +1,41 @@
> +	Kernel hacker's guide to git
> +	~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +      2005 Pavel Machek <pavel@suse.cz>
> +
> +You can get cogito at http://www.kernel.org/pub/software/scm/cogito/
> +. Compile it, and place it somewhere in $PATH. Then you can get kernel
> +by running
> +
> +mkdir clean-cg; cd clean-cg
> +cg-init rsync://rsync.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
> +
> +... Do cg-update origin to pickup latest changes from Linus. You can
> +do cg-diff to see what changes you done in your local tree. cg-cancel
> +will kill any such changes, and cg-commit will make them permanent.
> +
> +To get diff between your working tree and "next tree up", do cg-diff
> +-r origin: . If you want to get the same diff but separated
> +patch-by-patch, do cg-mkpatch origin: . If you want to pull changes
> +from the "up" tree to your working tree, do cg-update origin.
> +
> +
> +How to set up your trees so that you can cooperate with Linus
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +What I did:
> +
> +Created clean-cg. Initialized straight from Linus (as above). Then I
> +created "nice" tree, good for Linus to pull from 
> +
> +mkdir /data/l/linux-good; cd /data/l/linux-good
> +cg-init /data/l/clean-cg
> +
> +and then my working tree, based on linux-good
> +
> +mkdir /data/l/linux-cg; cd /data/l/linux-cg
> +cg-init /data/l/linux-good
> +
> +. I do my work in linux-cg. If someone sends me nice patch I should
> +pass up, I apply it to linux-good with nice message and do
> +
> +cd /data/l/linux-cg; cg-update origin
> 
> -- 
> Boycott Kodak -- for their patent abuse against Java.

Re: [patch] add simple git documentation

[David Greaves]

Andrew Morton wrote:

>Pavel Machek <pavel@ucw.cz> wrote:
>  
>
>>This adds short intro to git aimed at kernel hackers.
>>
>>    
>>
>
>OK, but I'm hoping that shortly we'll have something more complete than
>this, and your patch might not be a suitable starting point for that. 
>(Large hint-dropping sounds).
>  
>
What are you looking for.

For man-page-a-like, have you seen Documentation/core-git.txt in Linus'
repository?

I'll be working more on that this weekend.

David

-- 

Re: [patch] add simple git documentation

[Petr Baudis]

Dear diary, on Sat, May 07, 2005 at 10:37:12AM CEST, I got a letter
where David Greaves <david@dgreaves.com> told me that...
> Andrew Morton wrote:
> 
> >Pavel Machek <pavel@ucw.cz> wrote:
> >  
> >
> >>This adds short intro to git aimed at kernel hackers.
> >>
> >>    
> >>
> >
> >OK, but I'm hoping that shortly we'll have something more complete than
> >this, and your patch might not be a suitable starting point for that. 
> >(Large hint-dropping sounds).
> >  
> >
> What are you looking for.
> 
> For man-page-a-like, have you seen Documentation/core-git.txt in Linus'
> repository?
> 
> I'll be working more on that this weekend.

Are you planning to split it to individual files at some point?

(That's what I'd like to do with Documentation/cogito/, speaking of
manpageness...)

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
C++: an octopus made by nailing extra legs onto a dog. -- Steve Taylor

Re: [patch] add simple git documentation

[David Greaves]

Petr Baudis wrote:

>Dear diary, on Sat, May 07, 2005 at 10:37:12AM CEST, I got a letter
>where David Greaves <david@dgreaves.com> told me that...
>  
>
>>Andrew Morton wrote:
>>    
>>
>>>Pavel Machek <pavel@ucw.cz> wrote:
>>>      
>>>
>>>>This adds short intro to git aimed at kernel hackers.
>>>>        
>>>>
>>>OK, but I'm hoping that shortly we'll have something more complete than
>>>this, and your patch might not be a suitable starting point for that. 
>>>(Large hint-dropping sounds).
>>>      
>>>
>>What are you looking for.
>>
>>For man-page-a-like, have you seen Documentation/core-git.txt in Linus'
>>repository?
>>
>>I'll be working more on that this weekend.
>>    
>>
>Are you planning to split it to individual files at some point?
>  
>
Yes. I'll see how using asciidoc affects that.
And with Linus vacationing it looks like there'll be time this week.

>(That's what I'd like to do with Documentation/cogito/, speaking of
>manpageness...)
>  
>
OK
BTW, whatever happened to perlification - the initial stab I sent you
used the perl/pod approach.
The reason I ask is that that means the docs should/could be initially
written as here-documents within the scripts rather than external manpages.

David

Re: [patch] add simple git documentation

[Pavel Machek]

Hi!

> > This adds short intro to git aimed at kernel hackers.
> > 
> 
> OK, but I'm hoping that shortly we'll have something more complete than
> this, and your patch might not be a suitable starting point for that. 
> (Large hint-dropping sounds).

Okay.. Should I add Documentation/git, and put this as intro.txt into
it?

								Pavel

-- 
Boycott Kodak -- for their patent abuse against Java.