summaryrefslogtreecommitdiff
path: root/Documentation/git-add.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2005-11-04 08:04:17 (GMT)
committerJunio C Hamano <junkio@cox.net>2005-11-04 08:04:17 (GMT)
commit810bf1f9448c1db7f52cfa43c077c677fb080fce (patch)
tree1efb9b35dc2f2b8afc5c8fcf384e4e76b1ae7a80 /Documentation/git-add.txt
parenta10aad6a9a37fbafcda590a00ddaf7b2bfda940e (diff)
downloadgit-810bf1f9448c1db7f52cfa43c077c677fb080fce.zip
git-810bf1f9448c1db7f52cfa43c077c677fb080fce.tar.gz
git-810bf1f9448c1db7f52cfa43c077c677fb080fce.tar.bz2
Documentation: git-add -- do not say "cache", add examples.
Its use of git-ls-files --others is very nice, but sometimes gives surprising results, so we'd better talk about it. Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-add.txt')
-rw-r--r--Documentation/git-add.txt43
1 files changed, 39 insertions, 4 deletions
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 3230029..4cae412 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -3,7 +3,7 @@ git-add(1)
NAME
----
-git-add - Add files to the cache.
+git-add - Add files to the index file.
SYNOPSIS
--------
@@ -11,13 +11,14 @@ SYNOPSIS
DESCRIPTION
-----------
-A simple wrapper for git-update-index to add files to the cache for people used
-to do "cvs add".
+A simple wrapper for git-update-index to add files to the index,
+for people used to do "cvs add".
+
OPTIONS
-------
<file>...::
- Files to add to the cache.
+ Files to add to the index.
-n::
Don't actually add the file(s), just show if they exist.
@@ -26,6 +27,40 @@ OPTIONS
Be verbose.
+DISCUSSION
+----------
+
+The list of <file> given to the command is fed to `git-ls-files`
+command to list files that are not registerd in the index and
+are not ignored/excluded by `$GIT_DIR/info/exclude` file or
+`.gitignore` file in each directory. This means two things:
+
+. You can put the name of a directory on the command line, and
+ the command will add all files in it and its subdirectories;
+
+. Giving the name of a file that is already in index does not
+ run `git-update-index` on that path.
+
+
+EXAMPLES
+--------
+git-add Documentation/\\*.txt::
+
+ Adds all `\*.txt` files that are not in the index under
+ `Documentation` directory and its subdirectories.
++
+Note that the asterisk `\*` is quoted from the shell in this
+example; this lets the command to include the files from
+subdirectories of `Documentation/` directory.
+
+git-add git-*.sh::
+
+ Adds all git-*.sh scripts that are not in the index.
+ Because this example lets shell expand the asterisk
+ (i.e. you are listing the files explicitly), it does not
+ add `subdir/git-foo.sh` to the index.
+
+
Author
------
Written by Linus Torvalds <torvalds@osdl.org>