X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-ls-files.txt;h=940285f8c8caf52f06ac2fb0008026a1425b24eb;hb=df8baa42fe4eeb5a021ac262caf601f44d2a5746;hp=d2072194059c65f92487c84c53b9f6b5da780d14;hpb=1df092d211868b3b74f5b3981fad9b195a0bedad;p=git.git diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index d2072194..940285f8 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -1,6 +1,5 @@ git-ls-files(1) =============== -v0.1, May 2005 NAME ---- @@ -10,11 +9,11 @@ git-ls-files - Information about files in the cache/working directory SYNOPSIS -------- 'git-ls-files' [-z] [-t] - (--[cached|deleted|others|ignored|stage|unmerged|killed])\* - (-[c|d|o|i|s|u|k])\* + (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])\* + (-[c|d|o|i|s|u|k|m])\* [-x |--exclude=] [-X |--exclude-from=] - [--exclude-per-directory=] + [--exclude-per-directory=] [--] []\* DESCRIPTION ----------- @@ -33,6 +32,9 @@ OPTIONS -d|--deleted:: Show deleted files in the output +-m|--modified:: + Show modified files in the output + -o|--others:: Show other files in the output @@ -68,12 +70,20 @@ OPTIONS -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 - K to be killed + H:: cached + M:: unmerged + R:: removed/deleted + C:: modifed/changed + K:: to be killed ? other +--:: + Do not interpret any more arguments as options. + +:: + Files to show. If no files are given all files which match the other + specified criteria are shown. + Output ------ show files just outputs the filename unless '--stage' is specified in @@ -87,8 +97,8 @@ detailed information on unmerged paths. For an unmerged path, instead of recording a single mode/SHA1 pair, the dircache records up to three such pairs; one from tree O in stage 1, A in stage 2, and B in stage 3. This information can be used by -the user (or Cogito) to see what should eventually be recorded at the -path. (see read-cache for more information on state) +the user (or the porcelain) to see what should eventually be recorded at the +path. (see git-read-tree for more information on state) Exclude Patterns @@ -100,13 +110,13 @@ flags --others or --ignored are specified. These exclude patterns come from these places: - (1) command line flag --exclude= specifies a single + 1. command line flag --exclude= specifies a single pattern. - (2) command line flag --exclude-from= specifies a list of + 2. command line flag --exclude-from= specifies a list of patterns stored in a file. - (3) command line flag --exclude-per-directory= specifies + 3. command line flag --exclude-per-directory= specifies a name of the file in each directory 'git-ls-files' examines, and if exists, its contents are used as an additional list of patterns. @@ -130,7 +140,7 @@ time. They are built and ordered in the following way: are popped off when leaving the directory. Each pattern in the pattern list specifies "a match pattern" and -optionally the fate;n either a file that matches the pattern is +optionally the fate; either a file that matches the pattern is considered excluded or included. A filename is matched against the patterns in the three lists; the --exclude-from list is checked first, then the --exclude-per-directory list, and then @@ -158,12 +168,13 @@ An exclude pattern is of the following format: - otherwise, it is a shell glob pattern, suitable for consumption by fnmatch(3) with FNM_PATHNAME flag. I.e. a slash in the pattern must match a slash in the pathname. - "Documentation/*.html" matches "Documentation/git.html" but + "Documentation/\*.html" matches "Documentation/git.html" but not "ppc/ppc.html". As a natural exception, "/*.c" matches "cat-file.c" but not "mozilla-sha1/sha1.c". An example: +-------------------------------------------------------------- $ cat .git/ignore # ignore objects and archives, anywhere in the tree. *.[oa] @@ -176,11 +187,12 @@ An example: --exclude='Documentation/*.[0-9]' \ --exclude-from=.git/ignore \ --exclude-per-directory=.gitignore +-------------------------------------------------------------- See Also -------- -link:read-cache.html[read-cache] +gitlink:git-read-tree[1] Author @@ -193,5 +205,5 @@ Documentation by David Greaves, Junio C Hamano and the git-list