Merge branch 'ph/parseopt-sh'
[gitweb.git] / Documentation / git-add.txt
index 37077b523e04c1e468bc17dce8f2a44c9fa98a1c..63829d93cc827255355aa07a7db061b1a3a9e4d9 100644 (file)
@@ -7,7 +7,9 @@ git-add - Add file contents to the index
 
 SYNOPSIS
 --------
-'git-add' [-n] [-v] [-f] [--interactive | -i] [-u] [--] <file>...
+[verse]
+'git-add' [-n] [-v] [-f] [--interactive | -i] [-u] [--refresh]
+          [--] <filepattern>...
 
 DESCRIPTION
 -----------
@@ -28,10 +30,12 @@ you must run 'git add' again to add the new content to the index.
 The 'git status' command can be used to obtain a summary of which
 files have changes that are staged for the next commit.
 
-The 'add' command can be used to add ignored files with `-f` (force)
-option, but they have to be explicitly and exactly specified from the
-command line.  File globbing and recursive behaviour do not add ignored
-files.
+The 'git add' command will not add ignored files by default.  If any
+ignored files were explicitly specified on the command line, 'git add'
+will fail with a list of ignored files.  Ignored files reached by
+directory recursion or filename globbing performed by Git (quote your
+globs before the shell) will be silently ignored.  The 'add' command can
+be used to add ignored files with the `-f` (force) option.
 
 Please see gitlink:git-commit[1] for alternative ways to add content to a
 commit.
@@ -39,17 +43,17 @@ commit.
 
 OPTIONS
 -------
-<file>...::
+<filepattern>...::
        Files to add content from.  Fileglobs (e.g. `*.c`) can
        be given to add all matching files.  Also a
        leading directory name (e.g. `dir` to add `dir/file1`
        and `dir/file2`) can be given to add all files in the
        directory, recursively.
 
--n::
+-n, \--dry-run::
         Don't actually add the file(s), just show if they exist.
 
--v::
+-v, \--verbose::
         Be verbose.
 
 -f::
@@ -66,6 +70,10 @@ OPTIONS
        command line. If no paths are specified, all tracked files are
        updated.
 
+\--refresh::
+       Don't add the file(s), but only refresh their stat()
+       information in the index.
+
 \--::
        This option can be used to separate command-line options from
        the list of files, (useful when filenames might be mistaken
@@ -216,6 +224,7 @@ See Also
 --------
 gitlink:git-status[1]
 gitlink:git-rm[1]
+gitlink:git-reset[1]
 gitlink:git-mv[1]
 gitlink:git-commit[1]
 gitlink:git-update-index[1]
@@ -231,4 +240,3 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 GIT
 ---
 Part of the gitlink:git[7] suite
-