[PATCH] Document that "git add" only adds non-ignored files.

[PATCH] Document that "git add" only adds non-ignored files.

[Santi]

Signed-off-by: Santi Béjar <sbejar@gmail.com>


---

 Documentation/git-add.txt |    9 ++++++---
 1 files changed, 6 insertions(+), 3 deletions(-)

9c057bcba388450963085eb5c751b734c04ff045
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 5e31129..1b6a22a 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -7,18 +7,20 @@ git-add - Add files to the index file

 SYNOPSIS
 --------
-'git-add' [-n] [-v] [--] <file>...
+'git-add' [-n] [-v] [--] <filepattern>...

 DESCRIPTION
 -----------
 A simple wrapper for git-update-index to add files to the index,
 for people used to do "cvs add".

+It only adds non-ignored files, to add ignored files use
+"git update-index --add".

 OPTIONS
 -------
-<file>...::
-       Files to add to the index.
+<filepattern>...::
+       Files to add to the index, see gitlink:git-ls-files[1].

 -n::
         Don't actually add the file(s), just show if they exist.
@@ -68,6 +70,7 @@ git-add git-*.sh::
 See Also
 --------
 gitlink:git-rm[1]
+gitlink:git-ls-files[1]

 Author
 ------
--
1.3.3.g97ee3

Re: [PATCH] Document that "git add" only adds non-ignored files.

[Junio C Hamano]

Thanks for the reminder, but I wonder if it is good to update
the description of this command, and ls-files to use the
same wording for consistency.  We seem to use <pathspec> to mean
"this is not necessarily a filename -- we glob", so that may be
a good candidate (we do not have <pathspec> in glossary yet --
we would need to add).

Please don't touch description for diff-* family -- right now,
they say <path>, because they do not glob.  If we decide that it
is a good idea to glob (which I suspect we don't for the
low-level stuff, but we probably do for the "git-diff" wrapper),
we would update the code and the description at the same time.

Re: [PATCH] Document that "git add" only adds non-ignored files.

[Santi]

2006/5/19, Junio C Hamano <junkio@cox.net>:
> Thanks for the reminder, but I wonder if it is good to update
> the description of this command, and ls-files to use the
> same wording for consistency.  We seem to use <pathspec> to mean
> "this is not necessarily a filename -- we glob", so that may be
> a good candidate (we do not have <pathspec> in glossary yet --
> we would need to add).

I changed it to match with the new usage string in the buildin-add.c.

>
> Please don't touch description for diff-* family -- right now,
> they say <path>, because they do not glob.  If we decide that it
> is a good idea to glob (which I suspect we don't for the
> low-level stuff, but we probably do for the "git-diff" wrapper),
> we would update the code and the description at the same time.
>

OK.

Santi