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

Re: [PATCH 3/3] Documentation: convert tutorials to man pages

From
Junio C Hamano <gitster@pobox.com>
Date
May 3, 2008, 17:44 UTC
Message-ID
<7vfxszuvs6.fsf@gitster.siamese.dyndns.org>
In-Reply-To
<200805030604.32123.chriscool@tuxfamily.org>
Christian Couder <chriscool@tuxfamily.org> writes:
> About man page sections, Perl is consistent because every thing is in 
> section 1.
I do not think it is a good example to follow, though.
> Now for git we already have git commands in section 1 and some 
> other documentation (gitattributes, gitignore, gitmodules) in section 5 
> and "git" in section 7. Do we want to keep "git" alone in section 7 and put 
> tutorials in section 1 ? Or put everything in section 1 ?

My preference is to move git(7) to git(1) because it is describing a command at the end-user level (distros are much better than us to come up with a way to deal with conflict resolution between us and the other git), keep file format description in section 5 (that's where they belong to).

Previous: Christian CouderNext: Christian Couder
Message 6 of 10 in “Documentation: convert tutorials to man pages”
  1. 3/3 Documentation: convert tutorials to man pagesChristian Couder, May 2, 2008
  2. Jakub NarebskiMay 2, 2008
  3. Jeff KingMay 2, 2008
  4. J. Bruce FieldsMay 2, 2008
  5. Christian CouderMay 3, 2008
  6. Junio C HamanoMay 3, 2008
  7. Documentation status (was Re: [PATCH 3/3] Documentation: convert tutorials to man pages)Christian Couder, May 5, 2008
  8. Junio C HamanoMay 5, 2008
  9. Jakub NarebskiMay 5, 2008
  10. Christian CouderMay 6, 2008

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.