Documentation
¶
Overview ¶
Package lsfiles git-ls-files - Show information about files in the index and the working tree.
SYNOPSIS ¶
Reference: https://git-scm.com/docs/git-ls-files
git ls-files [-z] [-t] [-v] [-f] [-c|--cached] [-d|--deleted] [-o|--others] [-i|--ignored] [-s|--stage] [-u|--unmerged] [-k|--killed] [-m|--modified] [--directory [--no-empty-directory]] [--eol] [--deduplicate] [-x <pattern>|--exclude=<pattern>] [-X <file>|--exclude-from=<file>] [--exclude-per-directory=<file>] [--exclude-standard] [--error-unmatch] [--with-tree=<tree-ish>] [--full-name] [--recurse-submodules] [--abbrev[=<n>]] [--format=<format>] [--] [<file>...]
DESCRIPTION ¶
This merges the file listing in the index with the actual working directory list, and shows different combinations of the two. One or more of the options below may be used to determine the files shown:
Index ¶
- func Abbrev(n string) func(*types.Cmd)
- func Cached(g *types.Cmd)
- func Debug(g *types.Cmd)
- func Deduplicate(g *types.Cmd)
- func Deleted(g *types.Cmd)
- func Directory(g *types.Cmd)
- func Eol(g *types.Cmd)
- func ErrorUnmatch(g *types.Cmd)
- func Exclude(pattern string) func(*types.Cmd)
- func ExcludeFrom(file string) func(*types.Cmd)
- func ExcludePerDirectory(file string) func(*types.Cmd)
- func ExcludeStandard(g *types.Cmd)
- func F(g *types.Cmd)
- func Files(files ...string) func(*types.Cmd)
- func Format(value string) func(*types.Cmd)
- func FullName(g *types.Cmd)
- func HyphenHyphen(g *types.Cmd)
- func Ignored(g *types.Cmd)
- func Killed(g *types.Cmd)
- func Modified(g *types.Cmd)
- func NoEmptyDirectory(g *types.Cmd)
- func Others(g *types.Cmd)
- func RecurseSubmodules(g *types.Cmd)
- func Sparse(g *types.Cmd)
- func Stage(g *types.Cmd)
- func T(g *types.Cmd)
- func Unmerged(g *types.Cmd)
- func V(g *types.Cmd)
- func WithTree(treeIsh string) func(*types.Cmd)
- func Z(g *types.Cmd)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Abbrev ¶
Abbrev Instead of showing the full 40-byte hexadecimal object lines, show the shortest prefix that is at least <n> hexdigits long that uniquely refers the object. Non default number of digits can be specified with --abbrev=<n>. --abbrev[=<n>]
func Debug ¶
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. --debug
func Deduplicate ¶
Deduplicate When only filenames are shown, suppress duplicates that may come from having multiple stages during a merge, or giving --deleted and --modified option at the same time. When any of the -t, --unmerged, or --stage option is in use, this option has no effect. --deduplicate
func Directory ¶
Directory If a whole directory is classified as "other", show just its name (with a trailing slash) and not its whole contents. --directory
func Eol ¶
Eol Show <eolinfo> and <eolattr> of files. <eolinfo> is the file content identification used by Git when the "text" attribute is "auto" (or not set and core.autocrlf is not false). <eolinfo> is either "-text", "none", "lf", "crlf", "mixed" or "".\n"" means the file is not a regular file, it is not in the index or not accessible in the working tree. <eolattr> is the attribute that is used when checking out or committing, it is either "", "-text", "text", "text=auto", "text eol=lf", "text eol=crlf". Since Git 2.10 "text=auto eol=lf" and "text=auto eol=crlf" are supported. Both the <eolinfo> in the index ("i/<eolinfo>") and in the working tree ("w/<eolinfo>") are shown for regular files, followed by the ("attr/<eolattr>"). --eol
func ErrorUnmatch ¶
ErrorUnmatch If any <file> does not appear in the index, treat this as an error (return 1). --error-unmatch
func Exclude ¶
Exclude Skip untracked files matching pattern. Note that pattern is a shell wildcard pattern. See EXCLUDE PATTERNS below for more information. -x <pattern>, --exclude=<pattern>
func ExcludeFrom ¶
ExcludeFrom Read exclude patterns from <file>; 1 per line. -X <file>, --exclude-from=<file>
func ExcludePerDirectory ¶
ExcludePerDirectory Read additional exclude patterns that apply only to the directory and its subdirectories in <file>. --exclude-per-directory=<file>
func ExcludeStandard ¶
ExcludeStandard Add the standard Git exclusions: .git/info/exclude, .gitignore in each directory, and the user’s global exclusion file. --exclude-standard
func F ¶
F Similar to -t, but use lowercase letters for files that are marked as fsmonitor valid (see git-update-index(1)). -f
func Files ¶
Files [<file>...]. Files to show. If no files are given all files which match the other specified criteria are shown.
func Format ¶
Format A string that interpolates %(fieldname) from the result being shown. It also interpolates %% to %, and %xx where xx are hex digits interpolates to character with hex code xx; for example %00 interpolates to \0 (NUL), %09 to \t (TAB) and %0a to \n (LF). --format cannot be combined with -s, -o, -k, -t, --resolve-undo and --eol. --format=<format>
func FullName ¶
FullName 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. --full-name
func HyphenHyphen ¶
HyphenHyphen add `--`. Do not interpret any more arguments as options.
func Ignored ¶
Ignored Show only ignored files in the output. When showing files in the index, print only those matched by an exclude pattern. When showing "other" files, show only those matched by an exclude pattern. Standard ignore rules are not automatically activated, therefore at least one of the --exclude* options is required. -i, --ignored
func Killed ¶
Killed Show files on the filesystem that need to be removed due to file/directory conflicts for checkout-index to succeed. -k, --killed
func NoEmptyDirectory ¶
NoEmptyDirectory Do not list empty directories. Has no effect without --directory. --no-empty-directory
func RecurseSubmodules ¶
RecurseSubmodules Recursively calls ls-files on each active submodule in the repository. Currently there is only support for the --cached and --stage modes. --recurse-submodules
func Sparse ¶
Sparse If the index is sparse, show the sparse directories without expanding to the contained files. Sparse directories will be shown with a trailing slash, such as "x/" for a sparse directory •"x•". --sparse
func Stage ¶
Stage Show staged contents' mode bits, object name and stage number in the output. -s, --stage
func T ¶
T This feature is semi-deprecated. For scripting purpose, git-status(1) --porcelain and git-diff-files(1) --name-status are almost always superior alternatives, and users should look at git-status(1) --short or git-diff(1) --name-status for more user-friendly alternatives. -t
func V ¶
V Similar to -t, but use lowercase letters for files that are marked as assume unchanged (see git-update-index(1)). -v
func WithTree ¶
WithTree When using --error-unmatch to expand the user supplied <file> (i.e. path pattern) arguments to paths, pretend that paths which were removed in the index since the named <tree-ish> are still present. Using this option with -s or -u options does not make any sense. --with-tree=<tree-ish>
Types ¶
This section is empty.
Source Files