[PATCH] Document core.excludesfile for git-add

[PATCH] Document core.excludesfile for git-add

[Michael Hendricks]

During the discussion of core.excludesfile in the user-manual, I realized
that the configuration wasn't mentioned in the man pages.

Signed-off-by: Michael Hendricks <michael@ndrix.org>
---
 Documentation/git-add.txt |    9 +++++++++
 1 files changed, 9 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 27b9c0f..a0c9f68 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -69,6 +69,15 @@ OPTIONS
 	for command-line options).
 
 
+Configuration
+-------------
+
+The optional configuration variable 'core.excludesfile' indicates a path to a
+file containing patterns of file names to exclude from git-add, similar to
+$GIT_DIR/info/exclude.  Patterns in the exclude file are used in addition to
+those in info/exclude.  See link:repository-layout.html[repository layout].
+
+
 EXAMPLES
 --------
 git-add Documentation/\\*.txt::
-- 
1.5.2.rc3.39.gaf9b-dirty

Re: [PATCH] Document core.excludesfile for git-add

[Junio C Hamano]

Thanks, but wouldn't this belong to Documentation/config.txt
instead, I wonder?

Re: [PATCH] Document core.excludesfile for git-add

[Michael Hendricks]

On Wed, May 16, 2007 at 10:31:12PM -0700, Junio C Hamano wrote:
> Thanks, but wouldn't this belong to Documentation/config.txt
> instead, I wonder?

It appears to my untrained eye that core.excludesfiles only works for
git-add.  It seems to have no effect on git-status and the only code
that mentions core.excludesfile is builtin-add.c

-- 
Michael

Re: [PATCH] Document core.excludesfile for git-add

[Petr Baudis]

On Thu, May 17, 2007 at 04:35:44PM CEST, Michael Hendricks wrote:
> On Wed, May 16, 2007 at 10:31:12PM -0700, Junio C Hamano wrote:
> > Thanks, but wouldn't this belong to Documentation/config.txt
> > instead, I wonder?
> 
> It appears to my untrained eye that core.excludesfiles only works for
> git-add.  It seems to have no effect on git-status and the only code
> that mentions core.excludesfile is builtin-add.c

I believe the current policy should be that all config options are at
least briefly listed in config.txt and possibly are described in more
detail in the documentation of relevant command.

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
Ever try. Ever fail. No matter. // Try again. Fail again. Fail better.
		-- Samuel Beckett

Re: [PATCH] Document core.excludesfile for git-add

[Johan Herland]

On Thursday 17 May 2007, Michael Hendricks wrote:
> On Wed, May 16, 2007 at 10:31:12PM -0700, Junio C Hamano wrote:
> > Thanks, but wouldn't this belong to Documentation/config.txt
> > instead, I wonder?
> 
> It appears to my untrained eye that core.excludesfiles only works for
> git-add.  It seems to have no effect on git-status and the only code
> that mentions core.excludesfile is builtin-add.c

If so, we should probably fix that. The set of ignore files parsed by 
relevant git commands should be consistent. We don't want a situation 
where exclude patterns in a file are picked up by some git commands, but
not by others.

...Johan

-- 
Johan Herland, <johan@herland.net>
www.herland.net