[PATCH] Document clarification: gitmodules, gitattributes

[PATCH] Document clarification: gitmodules, gitattributes

[Gustaf Hendeby]

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.

/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

Re: [PATCH] Document clarification: gitmodules, gitattributes

[Junio C Hamano]

Gustaf Hendeby <hendeby@isy.liu.se> 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 <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.