Re: Documentation Directions

From: Junio C Hamano <junkio@cox.net>
Date: Nov 6, 2005, 20:11 UTC
Message-ID: <7vek5ty1su.fsf@assigned-by-dhcp.cox.net>
In-Reply-To: <E1EYoQE-0002QX-VM@jdl.com>

Jon Loeliger <jdl@freescale.com> writes:

> Couple of questions regarding documentation direction:
>
> - Is the plan to update all docs to use $GIT_DIR instead of .git?

I personally feel we should use less (not more) $GIT_DIR in the documentation and casual mention of things under .git/ directory should say .git/ instead, with the understanding that the reader have already learned that there is a way to override it if the user chooses to do so.

> - Do we intend on adding explicit support for '--help' on most,
>   if not all, of the git commands?

I think that would be very helpful.

>     - Do you want to standardize on using a '$' prompt
>       for all the example command executions samples?

Ah, I see you recently added a couple of Csh style '%' prompt. Also I suspect that some examples in earlier tutorial do not even have any prompt.

You are right -- being consistent would be nice.