X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-ls-files.txt;h=a29c633c8dfd15ee4bd3c8f4ae7aeceef91ea7fe;hb=9dc2164ab390a49b91f4866a85a076a5c5251986;hp=940285f8c8caf52f06ac2fb0008026a1425b24eb;hpb=df8baa42fe4eeb5a021ac262caf601f44d2a5746;p=git.git diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 940285f8..a29c633c 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -3,17 +3,20 @@ git-ls-files(1) NAME ---- -git-ls-files - Information about files in the cache/working directory +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 |--exclude=] [-X |--exclude-from=] - [--exclude-per-directory=] [--] []\* + [--exclude-per-directory=] + [--error-unmatch] + [--full-name] [--abbrev] [--] []\* DESCRIPTION ----------- @@ -45,16 +48,23 @@ 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. + +--no-empty-directory:: + Do not list empty directories. Has no effect without --directory. + -u|--unmerged:: Show unmerged files in the output (forces --stage) -k|--killed:: Show files on the filesystem that need to be removed due - to file/directory conflicts for checkout-cache to + to file/directory conflicts for checkout-index to succeed. -z:: - \0 line termination on output + \0 line termination on output. -x|--exclude=:: Skips files matching pattern. @@ -67,17 +77,36 @@ OPTIONS read additional exclude patterns that apply only to the directory and its subdirectories in . +--error-unmatch:: + If any 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[=]:: + 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=. + +\--:: Do not interpret any more arguments as options. :: @@ -100,6 +129,10 @@ the dircache records up to three such pairs; one from tree O in stage the user (or the porcelain) to see what should eventually be recorded at the path. (see git-read-tree for more information on state) +When `-z` option is not used, TAB, LF, and backslash characters +in pathnames are represented as `\t`, `\n`, and `\\`, +respectively. + Exclude Patterns ----------------