Merge branch 'master'

[git.git] / Documentation / git-ls-files.txt

diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 940285f..fe8ac1b 100644 (file)
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -3,17 +3,19 @@ git-ls-files(1)
 
 NAME
 ----
-git-ls-files - Information about files in the cache/working directory
+git-ls-files - Information about files in the index/working directory
 
 
 SYNOPSIS
 --------
-'git-ls-files' [-z] [-t]
+[verse]
+'git-ls-files' [-z] [-t] [-v]
                (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])\*
                (-[c|d|o|i|s|u|k|m])\*
                [-x <pattern>|--exclude=<pattern>]
                [-X <file>|--exclude-from=<file>]
-               [--exclude-per-directory=<file>] [--] [<file>]\*
+               [--exclude-per-directory=<file>] 
+               [--full-name] [--] [<file>]\*
 
 DESCRIPTION
 -----------
@@ -45,16 +47,20 @@ OPTIONS
 -s|--stage::
        Show stage files in the output
 
+--directory::
+       If a whole directory is classified as "other", show just its
+       name (with a trailing slash) and not its whole contents.
+
 -u|--unmerged::
        Show unmerged files in the output (forces --stage)
 
 -k|--killed::
        Show files on the filesystem that need to be removed due
-       to file/directory conflicts for checkout-cache to
+       to file/directory conflicts for checkout-index to
        succeed.
 
 -z::
-       \0 line termination on output
+       \0 line termination on output.
 
 -x|--exclude=<pattern>::
        Skips files matching pattern.
@@ -73,9 +79,19 @@ OPTIONS
        H::     cached
        M::     unmerged
        R::     removed/deleted
-       C::     modifed/changed
+       C::     modified/changed
        K::     to be killed
-       ?       other
+       ?::     other
+
+-v::
+       Similar to `-t`, but use lowercase letters for files
+       that are marked as 'always matching index'.
+
+--full-name::
+       When run from a subdirectory, the command usually
+       outputs paths relative to the current directory.  This
+       option forces paths to be output relative to the project
+       top directory.
 
 --::
        Do not interpret any more arguments as options.
@@ -100,6 +116,10 @@ the dircache records up to three such pairs; one from tree O in stage
 the user (or the porcelain) to see what should eventually be recorded at the
 path. (see git-read-tree for more information on state)
 
+When `-z` option is not used, TAB, LF, and backslash characters
+in pathnames are represented as `\t`, `\n`, and `\\`,
+respectively.
+
 
 Exclude Patterns
 ----------------