Merge branch 'ew/abbrev' into next
[gitweb.git] / Documentation / git-ls-files.txt
index 2f308ecda9d039224d2714e4cfd209422605430f..59f6adc494ded75e9fa4dceb57b4db65dfa229a5 100644 (file)
@@ -8,12 +8,15 @@ 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>]
+               [--error-unmatch]
+               [--full-name] [--abbrev] [--] [<file>]\*
 
 DESCRIPTION
 -----------
@@ -45,6 +48,10 @@ 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)
 
@@ -67,15 +74,34 @@ OPTIONS
        read additional exclude patterns that apply only to the
        directory and its subdirectories in <file>.
 
+--error-unmatch::
+       If any <file> does not appear in the index, treat this as an
+       error (return 1).
+
 -t::
        Identify the file status with the following tags (followed by
        a space) at the start of each line:
        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.
+
+--abbrev[=<n>]::
+       Instead of showing the full 40-byte hexadecimal object
+       lines, show only handful hexdigits prefix.
+       Non default number of digits can be specified with --abbrev=<n>.
 
 --::
        Do not interpret any more arguments as options.