Re: git tutorial

From: Johannes Schindelin <johannes.schindelin@gmx.de>
Date: May 22, 2008, 09:35 UTC
Message-ID: <alpine.DEB.1.00.0805221030380.30431@racer>
In-Reply-To: <dc5b80bf0805210942l388c4439g84b8a6b02346ebe8@mail.gmail.com>

Hi,

On Wed, 21 May 2008, Ian Katz wrote:

Show 21 quoted lines

> I have a suggestion/request for the git documentation (tutorial),
> currently accessible from:
> http://www.kernel.org/pub/software/scm/git/docs/tutorial.html
> 
> It would be much easier to understand the "Using git for
> collaboration" section if you put the username (bob or alice) as a
> prefix to each of the example command prompts, as is common in most
> linux distributions.  This would make it easier to see at a glance who
> is doing what.
> 
> In other words, it would change from this:
> $ git clone /home/alice/project myrepo
> $ git pull /home/bob/myrepo master
> 
> to this:
> bob$ git clone /home/alice/project myrepo
> alice$ git pull /home/bob/myrepo master
> 
> In the tutorial's current form, I spent so much time looking back into
> the paragraph text to find out who was typing each command that I
> eventually printed it out so I could scribble their names on each one.

This is a good change, yes.

> I hope this change isn't a big deal.

Hey, why don't you give it a try?

Just

Ian$ git clone git://git.kernel.org/pub/scm/git/git.git
Ian$ cd git
Ian$ $EDITOR Documentation/tutorial.txt
	# make the suggested changes

Ian$ git config user.name "Ian Katz"
Ian$ git config user.email ifreecarve@gmail.com
Ian$ git commit -s Documentation/tutorial.txt
	# write a nice oneline description, such as
	#    tutorial: prefix the prompts with the names "alice" or "bob"
	# then an empty line and then a paragraph as to why you like this
	# change

Ian$ git format-patch -1
	# then send the file 0001-*.patch, but inline, please

Hmm?

Ciao, Dscho