git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: Git manuals

From
JFJ. Bruce Fields <bfields@fieldses.org>
Date
Nov 19, 2006, 19:36 UTC
Message-ID
<20061119193609.GA21866@fieldses.org>
In-Reply-To
<20061119175952.GX7201@pasky.or.cz>
On Sun, Nov 19, 2006 at 06:59:52PM +0100, Petr Baudis wrote:
Show 19 quoted lines
> On Sun, Nov 19, 2006 at 06:50:40PM CET, J. Bruce Fields wrote:
> > In fact, I'm tempted to submit a patch that just assigns a chapter
> > number to everything under Documentation/, slaps a single table of
> > contents on the front, and calls the result "the git user's manual."
> > 
> > Of course, the moment people started trying to read the thing they'd
> > complain that it was a mess--some stuff referenced without being
> > introduced, other stuff introduced too many times.  But then over time
> > maybe that'd force us to mold it into some sort of logical sequence.
> 
> Sequencing isn't the only problem. A _manual_ is different from
> _reference documentation_ in that it does not usually describe command
> after command, but rather concept after concept. So instead of slamming
> git-*-pack commands together, you have a section "Handling Packs" where
> you try to coherently describe the commands together.
> 
> Your approach is fine for something you would call "Git Reference
> Manual", but it is something really different from "The Git Book" or
> "Git User's Manual".
Yeah, of course, but I wasn't actually thinking of the man pages so much
as:
	everyday.txt
	tutorial.txt
	tutorial-2.txt
	core-tutorial.txt
	howto/
	hooks.txt
	README
	glossary.txt
etc.
Previous: Robin RosenbergNext: J. Bruce Fields
Message 9 of 10 in “Re: [DRAFT] Branching and merging with git”
  1. J. Bruce FieldsNov 17, 2006
  2. linux@horizon.comNov 18, 2006
  3. Jakub NarebskiNov 18, 2006
  4. Junio C HamanoNov 18, 2006
  5. J. Bruce FieldsNov 19, 2006
  6. Git manualsPetr Baudis, Nov 19, 2006
  7. Jakub NarebskiNov 19, 2006
  8. Robin RosenbergNov 19, 2006
  9. J. Bruce FieldsNov 19, 2006
  10. Documentation: add a "git user's manual"J. Bruce Fields, Nov 26, 2006

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.