Make git-update-ref a builtin
[gitweb.git] / Documentation / git-add.txt
index 4cae41267a903d21e6745b3fb45963b6da4dad04..6342ea33e4a34f19ca04c79157d80cb230c15f5c 100644 (file)
@@ -3,22 +3,24 @@ git-add(1)
 
 NAME
 ----
-git-add - Add files to the index file.
+git-add - Add files to the index file
 
 SYNOPSIS
 --------
-'git-add' [-n] [-v] <file>...
+'git-add' [-n] [-v] [--] <file>...
 
 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.
+       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.
@@ -26,12 +28,17 @@ OPTIONS
 -v::
         Be verbose.
 
+\--::
+       This option can be used to separate command-line options from
+       the list of files, (useful when filenames might be mistaken
+       for command-line options).
+
 
 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
+command to list files that are not registered in the index and
 are not ignored/excluded by `$GIT_DIR/info/exclude` file or
 `.gitignore` file in each directory.  This means two things:
 
@@ -60,6 +67,10 @@ git-add git-*.sh::
        (i.e. you are listing the files explicitly), it does not
        add `subdir/git-foo.sh` to the index.
 
+See Also
+--------
+gitlink:git-rm[1]
+gitlink:git-ls-files[1]
 
 Author
 ------