Re: [PATCH] Replace "git-" with "git " in *.[ch] comments and notifications

[Christian Couder <chriscool@tuxfamily.org>]

Le samedi 30 août 2008, Junio C Hamano a écrit :
> One thing you might be able to do would be to separate user visible
> strings and in-comment strings.  Frankly, when a comment talks about a
> git subprogram, blindly replacing s/-/ / makes it _far worse_ and the
> resulting text is harder to read for git hackers (who are primary
> audiences of comments).  E.g. taking one random example from your patch:
>
> diff --git a/builtin-init-db.c b/builtin-init-db.c
> index baf0d09..81aa822 100644
> --- a/builtin-init-db.c
> +++ b/builtin-init-db.c
> @@ -37,7 +37,7 @@ static void copy_templates_1(char *path, int baselen,
>
>  	/* Note: if ".git/hooks" file exists in the repository being
>  	 * re-initialized, /etc/core-git/templates/hooks/update would
> -	 * cause git-init to fail here.  I think this is sane but
> +	 * cause git init to fail here.  I think this is sane but
>  	 * it means that the set of templates we ship by default, along
>  	 * with the way the namespace under .git/ is organized, should
>  	 * be really carefully chosen.
>
> I do not think this is an improvement.  We are talking about a single
> subprogram, not what the user types from the command line.  Either of
> these two would be easier to read:
>
> 	... would cause git-init to fail here...
>         ... would cause "init" to fail here...

I think "git init" is even better, as "init" could be ambiguous.

> than:
>
>         ... would cause git init to fail here...
>
> Among these three, I think the second one is the most readable.  Perhaps
> dropping "git-" prefix when we are talking about a git subprogram, and
> quoting the word to make it stand out, could be a good approach , than
> replacing it with "git " prefix.

Regards,
Christian.