Re: [PATCH] Document the fact that commit -a is the way to go for simple operations

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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

-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]