git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Johannes Schindelin <Johannes.Schindelin@gmx.de>
To: Matthieu Moy <Matthieu.Moy@imag.fr>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Document the fact that commit -a is the way to go for simple operations
Date: Mon, 7 May 2007 13:22:36 +0200 (CEST)	[thread overview]
Message-ID: <Pine.LNX.4.64.0705071317580.4167@racer.site> (raw)
In-Reply-To: <vpqy7k1t56i.fsf@bauges.imag.fr>

Hi,

[BTW Matthieu, it seems you suffer the same problem as Jakub, since you do 
not Cc the original authors in your replies.]

On Mon, 7 May 2007, Matthieu Moy wrote:

> My proposal is not perfect, and I'm sure we can do better.
> 
> But the problem with most of git's manpages for beginners is that the
> documentation is mostly technical and factual. That is, it tells you
> what git will do if you provide such or such option, but not _why_ and
> _when_ you should use it.
> 
> Probably just a "gitlink:" to the place in the user manual which talks
> about the index would be OK here.

NAK. You should not even consider reading the man pages before reading the 
user manual. If you expect the man pages to give you a proper introduction 
into _anything_ that is your problem, not the doc's.

We have such a lovely user manual, full of examples, a nice read, and it 
even contains a section for the impatient. But the man pages are _meant_ 
to be technical. And I do not see a place in them for a back reference to 
the user manual.

Ciao,
Dscho

      reply	other threads:[~2007-05-07 11:22 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-05-06 21:11 [PATCH] Document the fact that commit -a is the way to go for simple operations Matthieu Moy
2007-05-06 21:11 ` [PATCH] Document git add -u introduced earlier Matthieu Moy
2007-05-06 21:11   ` [PATCH] Added a reference to git-add in the documentation for git-update-index Matthieu Moy
2007-05-06 21:11     ` [PATCH] Document "commit --only" Matthieu Moy
2007-05-06 23:13       ` Nicolas Pitre
2007-05-07  8:16         ` Matthieu Moy
2007-05-07 10:37           ` Matthieu Moy
2007-05-06 23:07 ` [PATCH] Document the fact that commit -a is the way to go for simple operations Nicolas Pitre
2007-05-07  8:21   ` Matthieu Moy
2007-05-07 11:22     ` Johannes Schindelin [this message]

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=Pine.LNX.4.64.0705071317580.4167@racer.site \
    --to=johannes.schindelin@gmx.de \
    --cc=Matthieu.Moy@imag.fr \
    --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).