Re: [PATCH] Documentation: A few minor fixes to Git User's Manual
- From
- J. Bruce Fields <bfields@fieldses.org>
- Date
- Apr 3, 2007, 17:21 UTC
- Message-ID
- <20070403172113.GB26201@fieldses.org>
- In-Reply-To
- <11756176481314-git-send-email-jnareb@gmail.com>
On Tue, Apr 03, 2007 at 06:27:28PM +0200, Jakub Narebski wrote:
> Mainly consistent usage of "git command" and not "git-command" syntax
Looks good, thanks!
> A few [shorthand] comments about Git User's Manual:
And thanks very much for the comments.
Show 6 quoted lines
> * inconsistent use of header levels > Level 0 (top level): ====================== > Level 1: ---------------------- > Level 2: ~~~~~~~~~~~~~~~~~~~~~~ > Level 3: ^^^^^^^^^^^^^^^^^^^^^^ > Level 4 (bottom level): ++++++++++++++++++++++
Have you found internal inconsistencies, or are you just referring to the fact that it's using different syntax from the default?
My original intention was to suck in other articles under Documentation/ as chapters. Shifting all the headers by one allows us to do that, at least initially, by just including the articles without modification. The glossary is the only thing we're currently using that way, though.
The "Git interals" chapter is obviously most taken from the README, which has gotten out of date in a few places.
My vague medium-term plan is to revise that chapter and then merge tutorial-2.txt into it, and maybe core-tutorial too, but I haven't had time to work on it recently. (Any help appreciated.)
I'd kinda like to remove all the tutorials some day and absorb them into the manual instead, but maybe that would be unpopular.
--b.