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

From: Olivier Marin <[email-masked]>
Date: Tue, 01 Jul 2008 15:09:32 +0200

Jonathan Nieder a écrit :
> [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 <[email-masked]>
> 
> 	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.