[PATCH] documentation about exclude/ignore files

[PATCH] documentation about exclude/ignore files

[Matthias Lederhofer]

---
Use .git/info/exclude in the example in git-ls-files.txt as .gitignore
is used there and update the list of commands looking at
.git/info/exclude in repository-layout.txt.

---
 Documentation/git-ls-files.txt      |    4 ++--
 Documentation/repository-layout.txt |    8 +++++---
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 4d8a2ad..8520b97 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -207,7 +207,7 @@ An exclude pattern is of the following f
 An example:
 
 --------------------------------------------------------------
-    $ cat .git/ignore
+    $ cat .git/info/exclude
     # ignore objects and archives, anywhere in the tree.
     *.[oa]
     $ cat Documentation/.gitignore
@@ -217,7 +217,7 @@ An example:
     !foo.html
     $ git-ls-files --ignored \
         --exclude='Documentation/*.[0-9]' \
-        --exclude-from=.git/ignore \
+        --exclude-from=.git/info/exclude \
         --exclude-per-directory=.gitignore
 --------------------------------------------------------------
 
diff --git a/Documentation/repository-layout.txt b/Documentation/repository-layout.txt
index b52dfdc..275d18b 100644
--- a/Documentation/repository-layout.txt
+++ b/Documentation/repository-layout.txt
@@ -120,9 +120,11 @@ info/grafts::
 
 info/exclude::
 	This file, by convention among Porcelains, stores the
-	exclude pattern list.  `git status` looks at it, but
-	otherwise it is not looked at by any of the core git
-	commands.
+	exclude pattern list. `.gitignore` is the per-directory
+	ignore file.  `git status`, `git add`, `git rm` and `git
+	clean` look at it but the core git commands do not look
+	at it.  See also: gitlink:git-ls-files[1] `--exclude-from`
+	and `--exclude-per-directory`.
 
 remotes::
 	Stores shorthands to be used to give URL and default
-- 
1.4.1.gb16f

Re: [PATCH] documentation about exclude/ignore files

[Junio C Hamano]

Matthias Lederhofer <matled@gmx.net> writes:

> ---
> Use .git/info/exclude in the example in git-ls-files.txt as .gitignore
> is used there and update the list of commands looking at
> .git/info/exclude in repository-layout.txt.
>
> ---
>  Documentation/git-ls-files.txt      |    4 ++--
>  Documentation/repository-layout.txt |    8 +++++---
>  2 files changed, 7 insertions(+), 5 deletions(-)

Why do you start the message with three dashes that says "the
below will _not_ go to the commit log message"?

The changes look good.  Please sign your patches.

Re: [PATCH] documentation about exclude/ignore files

[Matthias Lederhofer]

Junio C Hamano <junkio@cox.net> wrote:
> Why do you start the message with three dashes that says "the
> below will _not_ go to the commit log message"?
I was not sure if this comment should really go into the commit
message.

> The changes look good.  Please sign your patches.
Argh, I just keep forgetting this, sorry.