grep doc: add --break / --heading / -W to synopsis

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

diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 3521637b582687978c088dc463e8784817a92217..4b28292811ce019fc94259849f8c5ad6d514b686 100644 (file)
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -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
 -----------
@@ -79,15 +79,16 @@ OPTIONS
 
 -x <pattern>::
 --exclude=<pattern>::
-       Skips files matching pattern.
-       Note that pattern is a shell wildcard pattern.
+       Skip untracked files matching pattern.
+       Note that pattern is a shell wildcard pattern. See EXCLUDE PATTERNS
+       below for more information.
 
 -X <file>::
 --exclude-from=<file>::
-       exclude patterns are read from <file>; 1 per line.
+       Read exclude patterns from <file>; 1 per line.
 
 --exclude-per-directory=<file>::
-       read additional exclude patterns that apply only to the
+       Read additional exclude patterns that apply only to the
        directory and its subdirectories in <file>.
 
 --exclude-standard::
@@ -106,8 +107,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 +141,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.
 
@@ -178,7 +193,7 @@ These exclude patterns come from these places, in order:
      file containing a list of patterns.  Patterns are ordered
      in the same order they appear in the file.
 
-  3. command line flag --exclude-per-directory=<name> specifies
+  3. The command line flag --exclude-per-directory=<name> specifies
      a name of the file in each directory 'git ls-files'
      examines, normally `.gitignore`.  Files in deeper
      directories take precedence.  Patterns are ordered in the
@@ -194,15 +209,6 @@ SEE ALSO
 --------
 linkgit:git-read-tree[1], linkgit:gitignore[5]
 
-
-Author
-------
-Written by Linus Torvalds <torvalds@osdl.org>
-
-Documentation
---------------
-Documentation by David Greaves, Junio C Hamano, Josh Triplett, and the git-list <git@vger.kernel.org>.
-
 GIT
 ---
 Part of the linkgit:git[1] suite