Code

Merge branch 'js/ls-files-x-doc'
authorJunio C Hamano <gitster@pobox.com>
Sat, 18 Sep 2010 21:46:44 +0000 (14:46 -0700)
committerJunio C Hamano <gitster@pobox.com>
Sat, 18 Sep 2010 21:46:44 +0000 (14:46 -0700)
* js/ls-files-x-doc:
  ls-files documentation: reword for consistency
  git-ls-files.txt: clarify -x/--exclude option

Conflicts:
Documentation/git-ls-files.txt

1  2 
Documentation/git-ls-files.txt

index 15aee2f9532e66e46c83e4cef908c0a4f87fadd9,44b6480c0f7f71fcbb5adc2ccc9c319ca440b533..347f4479865419d010b874bc8b26f5f1b40a6f61
@@@ -10,14 -10,14 +10,14 @@@ SYNOPSI
  --------
  [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
  -----------
@@@ -44,7 -44,7 +44,7 @@@ OPTION
  
  -o::
  --others::
 -      Show other files in the output
 +      Show other (i.e. untracked) files in the output
  
  -i::
  --ignored::
  
  -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::
        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
        R::     removed/deleted
        C::     modified/changed
        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.
  
  
  Output
  ------
 -show files just outputs the filename unless '--stage' is specified in
 +'git ls-files' just outputs the filenames unless '--stage' is specified in
  which case it outputs:
  
          [<tag> ]<mode> <object> <stage> <file>
  
 -'git-ls-files --unmerged' and 'git-ls-files --stage' can be used to examine
 +'git ls-files --unmerged' and 'git ls-files --stage' can be used to examine
  detailed information on unmerged paths.
  
  For an unmerged path, instead of recording a single mode/SHA1 pair,
@@@ -177,7 -163,7 +178,7 @@@ respectively
  Exclude Patterns
  ----------------
  
 -'git-ls-files' can use a list of "exclude patterns" when
 +'git ls-files' can use a list of "exclude patterns" when
  traversing the directory tree and finding files to show when the
  flags --others or --ignored are specified.  linkgit:gitignore[5]
  specifies the format of exclude patterns.
@@@ -192,8 -178,8 +193,8 @@@ These exclude patterns come from these 
       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'
 +     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
       same order they appear in the files.