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

Re: [RFC/PATCH 7/7] Documentation formatting and cleanup

From
OMOlivier Marin <dkr+ml.git@free.fr>
Date
Jul 1, 2008, 13:09 UTC
Message-ID
<486A2C8C.5050204@free.fr>
In-Reply-To
<Pine.GSO.4.62.0806301730230.7190@harper.uchicago.edu>
Jonathan Nieder a écrit :
Show 15 quoted lines
> [184 KB patch online at
> <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>]
> 
> Following what appears to be the predominant style, format
> names of commands and commandlines both as `teletype text`.
> 
> While we're at it, add articles ("a" and "the") in some
> places, italicize the name of the command in the manual page
> synopsis line, and add a comma or two where it seems appropriate.
> 
> Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
> 
> 	1) I am using `teletype text` both for command names and
> 	   for command lines. Probably I should be using italics
> 	   for the command names.
You did a lot of:
> -replaced; you need to use a tool such as linkgit:git-diff[1] or the "pickaxe"
> +replaced; you need to use a tool such as `git-diff` or the "pickaxe"
Are those kind of changes really an improvement?
Also, in Documentation/gitdiffcore.txt, you did:
> -These are applied in sequence.  The set of filepairs git-diff-\*
> +These are applied in sequence.  The set of filepairs `git-diff-*`
but the file does not compile, now.
Olivier.
Previous: Jonathan NiederNext: Junio C Hamano
Message 18 of 40 in “Some superficial documentation changes”
  1. 0/7 Some superficial documentation changesJonathan Nieder, Jun 30, 2008
  2. 1/7 Documentation: fix links to tutorials and other new manual pagesJonathan Nieder, Jun 30, 2008
  3. Christian CouderJun 30, 2008
  4. 2/7 whitespace fix in Documentation/git-repack.txtJonathan Nieder, Jun 30, 2008
  5. 3/7 Documentation: complicate example of "man git-command"Jonathan Nieder, Jun 30, 2008
  6. Christian CouderJun 30, 2008
  7. J. Bruce FieldsJul 1, 2008
  8. Junio C HamanoJul 1, 2008
  9. J. Bruce FieldsJul 2, 2008
  10. Jonathan NiederJul 3, 2008
  11. J. Bruce FieldsJul 3, 2008
  12. Christian CouderJul 3, 2008
  13. Junio C HamanoJul 3, 2008
  14. 4/7 git-daemon(1): don't assume git-daemon is in /usr/binJonathan Nieder, Jun 30, 2008
  15. 5/7 Documentation: prepare to be consistent about "git-" versus "git "Jonathan Nieder, Jun 30, 2008
  16. 6/7 Documentation: be consistent about "git-" versus "git "Jonathan Nieder, Jun 30, 2008
  17. 7/7 Documentation formatting and cleanupJonathan Nieder, Jun 30, 2008
  18. Olivier MarinJul 1, 2008
  19. Junio C HamanoJul 1, 2008
  20. Jonathan NiederJul 3, 2008
  21. Jonathan NiederJul 3, 2008
  22. Junio C HamanoJul 1, 2008
  23. Jonathan NiederJul 3, 2008
  24. 01/15 git-format-patch(1): fix stray \ in outputJonathan Nieder, Jul 3, 2008
  25. 02/15 Documentation: fix gitlinksJonathan Nieder, Jul 3, 2008
  26. 03/15 manpages: fix bogus whitespaceJonathan Nieder, Jul 3, 2008
  27. Junio C HamanoJul 3, 2008
  28. Jonathan NiederJul 4, 2008
  29. 04/15 git(1): add commaJonathan Nieder, Jul 3, 2008
  30. 05/15 git-commit(1): depersonalize descriptionJonathan Nieder, Jul 3, 2008
  31. 06/15 Documentation: rewrap to prepare for "git-" vs "git " changeJonathan Nieder, Jul 3, 2008
  32. 07/15 Documentation: more "git-" versus "git " changesJonathan Nieder, Jul 3, 2008
  33. 08/15 gitdiffcore(7): fix awkward wordingJonathan Nieder, Jul 3, 2008
  34. 09/15 manpages: italicize command names in synopsesJonathan Nieder, Jul 3, 2008
  35. 10/15 manpages: italicize command namesJonathan Nieder, Jul 3, 2008
  36. 11/15 manpages: italicize git command names (which were in teletype font)Jonathan Nieder, Jul 3, 2008
  37. 12/15 manpages: italicize gitk's name (where it was in teletype font)Jonathan Nieder, Jul 3, 2008
  38. 13/15 manpages: italicize nongit command names (if they are in teletype font)Jonathan Nieder, Jul 3, 2008
  39. 14/15 manpages: italicize git subcommand names (which were in teletype font)Jonathan Nieder, Jul 3, 2008
  40. 15/15 manpages: use teletype font for sample command linesJonathan Nieder, Jul 3, 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.