git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Ian Katz" <ifreecarve@gmail.com>
To: git@vger.kernel.org
Subject: git tutorial
Date: Wed, 21 May 2008 12:42:33 -0400	[thread overview]
Message-ID: <dc5b80bf0805210942l388c4439g84b8a6b02346ebe8@mail.gmail.com> (raw)

Hi Guys-

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.

I hope this change isn't a big deal.

Thanks,
-Ian

             reply	other threads:[~2008-05-21 16:43 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-05-21 16:42 Ian Katz [this message]
2008-05-22  9:35 ` git tutorial Johannes Schindelin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=dc5b80bf0805210942l388c4439g84b8a6b02346ebe8@mail.gmail.com \
    --to=ifreecarve@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).