Re: [PATCH] Document clarification: gitmodules, gitattributes

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 31, 2008, 16:38 UTC
Message-ID: <7vwshx2l7z.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <1220198427-13017-1-git-send-email-hendeby@isy.liu.se>

Gustaf Hendeby <hendeby@isy.liu.se> writes:

Show 10 quoted lines

> The SYNOPSIS section of gitattibutes and gitmodule fail to clearly
> specify the name of the in tree files used.  This patch brings in the
> initial `.' and the fact that the `.gitmodules' file should reside at
> the top-level of the working tree.
>
> Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se>
> ---
>
> If this patch isn't accepted, the reverse changes should be made to
> the gitignore documentation.

The sole reason they lacked the initial "." was because AsciiDOC mishandled ".gitmodules" that began the line; we used to have the dot but removed it as a workaround because we couldn't find a good solution by tweaking the mark-up.

By prefixing "$GIT_FOOBAR/" in front of them, your patch makes the issue go away while conveying the fact that it has to be at the toplevel of the work tree, not anywhere in the tree. Very nice.