Documentation: avoid stray backslashes in core tutorial
[gitweb.git] / Documentation / git-ls-files.txt
index 3521637b582687978c088dc463e8784817a92217..15aee2f9532e66e46c83e4cef908c0a4f87fadd9 100644 (file)
@@ -10,14 +10,14 @@ SYNOPSIS
 --------
 [verse]
 'git ls-files' [-z] [-t] [-v]
-               (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])\*
-               (-[c|d|o|i|s|u|k|m])\*
+               (--[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>]
                [--exclude-standard]
                [--error-unmatch] [--with-tree=<tree-ish>]
-               [--full-name] [--abbrev] [--] [<file>]\*
+               [--full-name] [--abbrev] [--] [<file>]*
 
 DESCRIPTION
 -----------
@@ -106,8 +106,16 @@ OPTIONS
        with `-s` or `-u` options does not make any sense.
 
 -t::
-       Identify the file status with the following tags (followed by
-       a space) at the start of each line:
+       This feature is semi-deprecated. For scripting purpose,
+       linkgit:git-status[1] `--porcelain` and
+       linkgit:git-diff-files[1] `--name-status` are almost always
+       superior alternatives, and users should look at
+       linkgit:git-status[1] `--short` or linkgit:git-diff[1]
+       `--name-status` for more user-friendly alternatives.
++
+This option identifies the file status with the following tags (followed by
+a space) at the start of each line:
+
        H::     cached
        S::     skip-worktree
        M::     unmerged
@@ -132,6 +140,12 @@ OPTIONS
        lines, show only a partial prefix.
        Non default number of digits can be specified with --abbrev=<n>.
 
+--debug::
+       After each line that describes a file, add more data about its
+       cache entry.  This is intended to show as much information as
+       possible for manual inspection; the exact format may change at
+       any time.
+
 \--::
        Do not interpret any more arguments as options.