# [PATCH] Document clarification: gitmodules, gitattributes 2 messages from 2008-08-31 to 2008-08-31. Participants: Gustaf Hendeby, Junio C Hamano. Thread: https://gitlist.dev/t/15302 ## Gustaf Hendeby, 2008-08-31 16:00 Subject: [PATCH] Document clarification: gitmodules, gitattributes Message-ID: <1220198427-13017-1-git-send-email-hendeby@isy.liu.se> URL: https://gitlist.dev/e/1220198427-13017-1-git-send-email-hendeby%40isy.liu.se ``` 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 --- If this patch isn't accepted, the reverse changes should be made to the gitignore documentation. /Gustaf Documentation/gitattributes.txt | 2 +- Documentation/gitmodules.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index 1f23d27..5fb5007 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -7,7 +7,7 @@ gitattributes - defining attributes per path SYNOPSIS -------- -$GIT_DIR/info/attributes, gitattributes +$GIT_DIR/info/attributes, .gitattributes DESCRIPTION diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt index f8d122a..d1a17e2 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -7,7 +7,7 @@ gitmodules - defining submodule properties SYNOPSIS -------- -gitmodules +$GIT_WORK_DIR/.gitmodules DESCRIPTION -- 1.6.0.1.258.g6c63a ``` ## Junio C Hamano, 2008-08-31 16:38 Subject: Re: [PATCH] Document clarification: gitmodules, gitattributes Message-ID: <7vwshx2l7z.fsf@gitster.siamese.dyndns.org> URL: https://gitlist.dev/e/7vwshx2l7z.fsf%40gitster.siamese.dyndns.org In-Reply-To: <1220198427-13017-1-git-send-email-hendeby@isy.liu.se> ``` Gustaf Hendeby writes: > 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 > --- > > 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. ```