Describe the bug in handling filenames with funny characters in 'git add -i'

[git.git] / Documentation / git-add.txt

diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index e74f83b47ad7453ea3fda994f067de81f04baa9d..35e67a06e4248182c05c98b4b9b421bb3e02940a 100644 (file)
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -8,7 +8,7 @@ git-add - Add file contents to the index
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git-add' [-n] [-v] [-f] [--interactive | -i] [-u] [--refresh]
+'git-add' [-n] [-v] [-f] [--interactive | -i] [--patch | -p] [-u] [--refresh]

           [--] <filepattern>...
 
 DESCRIPTION
           [--] <filepattern>...
 
 DESCRIPTION


@@ -37,7 +37,7 @@ 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.
 
 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
+Please see linkgit:git-commit[1] for alternative ways to add content to a

 commit.
 
 
 commit.
 
 


@@ -65,7 +65,7 @@ OPTIONS
        operation to a subset of the working tree. See ``Interactive
        mode'' for details.
 
        operation to a subset of the working tree. See ``Interactive
        mode'' for details.
 

--p, \--patch:
+-p, \--patch::

        Similar to Interactive mode but the initial command loop is
        bypassed and the 'patch' subcommand is invoked using each of
        the specified filepatterns before exiting.
        Similar to Interactive mode but the initial command loop is
        bypassed and the 'patch' subcommand is invoked using each of
        the specified filepatterns before exiting.


@@ -74,8 +74,8 @@ OPTIONS
        Update only files that git already knows about. This is similar
        to what "git commit -a" does in preparation for making a commit,
        except that the update is limited to paths specified on the
        Update only files that git already knows about. This is similar
        to what "git commit -a" does in preparation for making a commit,
        except that the update is limited to paths specified on the

-       command line. If no paths are specified, all tracked files are
-       updated.
+       command line. If no paths are specified, all tracked files in the
+       current directory and its subdirectories are updated.

 
 \--refresh::
        Don't add the file(s), but only refresh their stat()
 
 \--refresh::
        Don't add the file(s), but only refresh their stat()


@@ -207,16 +207,14 @@ patch::
   and the working tree file and asks you if you want to stage
   the change of each hunk.  You can say:
 
   and the working tree file and asks you if you want to stage
   the change of each hunk.  You can say:
 

-       y - add the change from that hunk to index
-       n - do not add the change from that hunk to index
-       a - add the change from that hunk and all the rest to index
-       d - do not the change from that hunk nor any of the rest to index
-       j - do not decide on this hunk now, and view the next
-           undecided hunk
-       J - do not decide on this hunk now, and view the next hunk
-       k - do not decide on this hunk now, and view the previous
-           undecided hunk
-       K - do not decide on this hunk now, and view the previous hunk
+       y - stage this hunk
+       n - do not stage this hunk
+       a - stage this and all the remaining hunks in the file
+       d - do not stage this hunk nor any of the remaining hunks in the file
+       j - leave this hunk undecided, see next undecided hunk
+       J - leave this hunk undecided, see next hunk
+       k - leave this hunk undecided, see previous undecided hunk
+       K - leave this hunk undecided, see previous hunk

        s - split the current hunk into smaller hunks
        ? - print help
 +
        s - split the current hunk into smaller hunks
        ? - print help
 +


@@ -228,15 +226,21 @@ diff::
   This lets you review what will be committed (i.e. between
   HEAD and index).
 
   This lets you review what will be committed (i.e. between
   HEAD and index).
 

+Bugs
+----
+The interactive mode does not work with files whose names contain
+characters that need C-quoting.  `core.quotepath` configuration can be
+used to work this limitation around to some degree, but backslash,
+double-quote and control characters will still have problems.

 
 See Also
 --------
 
 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]
+linkgit:git-status[1]
+linkgit:git-rm[1]
+linkgit:git-reset[1]
+linkgit:git-mv[1]
+linkgit:git-commit[1]
+linkgit:git-update-index[1]

 
 Author
 ------
 
 Author
 ------


@@ -248,4 +252,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
 
 GIT
 ---

-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite