All of lore.kernel.org
 help / color / mirror / Atom feed
From: David Howells <dhowells@redhat.com>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: dhowells@redhat.com, torvalds@osdl.org, git@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Miklos Vajna <vmiklos@frugalware.org>
Subject: Re: [PATCH] Simplified GIT usage guide
Date: Fri, 12 Dec 2008 19:12:13 +0000	[thread overview]
Message-ID: <29095.1229109133@redhat.com> (raw)
In-Reply-To: <alpine.DEB.1.00.0812121952320.5873@eeepc-johanness>

Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:

> > +I don't really know what I'm doing with GIT either.
> 
> Strike the "either".

The whole point of the introduction is that this is aimed at someone who
doesn't know what they're doing, so IMO the "either" is quite correct here.

> > +===============
> > +OVERVIEW OF GIT
> > +===============
> 
> Your overview seems to be what "Git from the bottom up" is all about (see 
> the Git Wiki for more information where to find it).

The problem is I need to describe some terminology, and the best way to do
that is with some pictures.  I was wondering if I should break this out into a
separate document and simplify what I keep.

In my opinion, it's much easier to deal with if you can visualise how it
works, even if that visualisation isn't a true representation of reality,
which references Miklos's points.

> From my experience with new users, this is exactly the wrong way to go 
> about it.  You don't introduce object types of the Git database before 
> telling the users what the heck they are good for.  And most users do not 
> need to bother with tree objects either, anyway.  So maybe you just tell 
> them what the heck the object types are good for, without even teaching 
> them the object types at all.

Perhaps.  The main thing I want to introduce is the idea of a tree with three
levels, as it were: commits, directories, files.

> So I think that your document might do a good job scaring people away from 
> Git.  But I do not believe that your document, especially in the tone it 
> is written, does a good job of helping Git newbies.

Hmmm.  So what would you suggest is a good way to write for GIT newbies?  Is
it just that the overview should be canned or drastically simplified?

David

  parent reply	other threads:[~2008-12-12 19:12 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-12-12 18:28 [PATCH] Simplified GIT usage guide David Howells
2008-12-12 18:53 ` Miklos Vajna
2008-12-12 18:57 ` Johannes Schindelin
2008-12-19  0:02   ` Paul E. McKenney
2008-12-19  0:28     ` Junio C Hamano
2008-12-19  1:27       ` Paul E. McKenney
2008-12-24  4:35         ` Valdis.Kletnieks
2008-12-19  2:38     ` Johannes Schindelin
2008-12-19  5:25       ` Paul E. McKenney
2008-12-12 19:02 ` David Howells
2008-12-12 19:09   ` Miklos Vajna
2008-12-13  1:12   ` David Howells
2008-12-13  3:34     ` Miklos Vajna
2008-12-12 19:12 ` David Howells [this message]
2008-12-12 19:24   ` Sverre Rabbelier
2008-12-12 19:40     ` Aidan Van Dyk
2008-12-13 23:05   ` Nick Andrew
2008-12-14  1:45     ` Ping Yin
2008-12-12 19:39 ` Jakub Narebski
2008-12-12 19:47 ` J. Bruce Fields
2008-12-13  1:03   ` J. Bruce Fields
2008-12-13  1:14   ` David Howells
2008-12-12 20:00 ` Jeff Garzik
2008-12-12 21:34   ` Chris Friesen
2008-12-13  5:59   ` Junio C Hamano
2008-12-13 23:12   ` Nick Andrew
2008-12-12 20:07 ` Nicolas Pitre
2008-12-13  0:30 ` David Howells
2008-12-13  1:04 ` David Howells
2008-12-13  1:16   ` Sverre Rabbelier
2008-12-19  6:33     ` Willy Tarreau
2008-12-13  1:22   ` Nicolas Pitre
2008-12-13  3:35 ` Junio C Hamano
2008-12-14 10:33 ` Matthieu Moy
2008-12-14 17:33 ` Marcin Slusarz
2008-12-19  0:47 ` C. Scott Ananian
2008-12-19  9:26   ` Michael J Gruber
2008-12-19 17:08     ` C. Scott Ananian

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=29095.1229109133@redhat.com \
    --to=dhowells@redhat.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=torvalds@osdl.org \
    --cc=vmiklos@frugalware.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.