简体中文 ▾ 主题 ▾ 最新版本 ▾ git-ls-tree 最后更新于 2.42.0

名称

git-ls-tree - 列出树对象的内容

概要

git ls-tree [-d] [-r] [-t] [-l] [-z]
	    [--name-only] [--name-status] [--object-only] [--full-name] [--full-tree] [--abbrev[=<n>]] [--format=<format>]
	    <tree-ish> [<path>…​]

描述

列出给定树对象的内容，类似于在当前工作目录中执行 "/bin/ls -a"。请注意：

  • 其行为与 "/bin/ls" 略有不同，因为 <path> 仅表示要匹配的模式列表，例如：指定目录名称（不带 -r）的表现会有所不同，且参数的顺序无关紧要。

  • 其行为与 "/bin/ls" 相似之处在于 <path> 被视为相对于当前工作目录的路径。例如，当你位于包含 dir 目录的 sub 目录中时，可以运行 git ls-tree -r HEAD dir 来列出该树的内容（即 HEAD 中的 sub/dir）。在这种情况下，你不应提供非根级别的树（例如 git ls-tree -r HEAD:sub dir），因为这将导致请求 HEAD 提交中的 sub/sub/dir。但是，可以通过传递 --full-tree 选项来忽略当前工作目录。

选项

<tree-ish>

树对象（tree-ish）的 ID。

-d

仅显示命名的树条目本身，而不显示其子项。

-r

递归进入子树。

-t

在递归时也显示树条目。如果未传递 -r 则无效果。-d 隐含了 -t。

-l
--long

显示数据对象（blob/文件）条目的对象大小。

-z

输出以 \0 字符终止行，且不对文件名加引号。更多信息请参见下文的“输出格式”。

--name-only
--name-status

仅列出文件名（而不是“长”输出），每行一个。不能与 --object-only 混用。

--object-only

仅列出对象名称，每行一个。不能与 --name-only 或 --name-status 混用。这等同于指定 --format='%(objectname)，但对于此选项和该精确格式，命令会采用手动优化的代码路径，而不是通过通用的格式化机制。

--abbrev[=<n>]

不显示完整的 40 字节十六进制对象行，而是显示至少 <n> 位十六进制数字长且能唯一引用该对象的最短前缀。可以使用 --abbrev=<n> 指定非默认的数字位数。

--full-name

不显示相对于当前工作目录的路径名，而是显示完整路径名。

--full-tree

不将列表限制在当前工作目录。隐含 --full-name。

--format=<格式>

一个字符串，从显示结果中插值 %(fieldname)。它还会将 %% 插值为 %，将 %xNN（其中 NN 是十六进制数字）插值为具有十六进制代码 NN 的字符；例如 %x00 插值为 \0 (NUL)，%x09 插值为 \t (TAB)，%x0a 插值为 \n (LF)。指定时，--format 不能与其他更改格式的选项（包括 --long、--name-only 和 --object-only）混用。

[<路径>…​]

如果提供了路径，则显示它们（注意这实际上不是原始路径名，而是要匹配的模式列表）。否则，默认将树的根级别作为唯一的路径参数。

输出格式

ls-tree 的输出格式由 --format 选项或其他更改格式的选项（如 --name-only 等）决定（参见上文的 --format）。

使用某些 --format 指令等同于使用那些选项，但调用完整的格式化机制可能比使用相应的格式化选项慢。

如果 --format 精确映射到现有选项，ls-tree 将使用相应的快速路径。因此，默认格式等同于：

%(objectmode) %(objecttype) %(objectname)%x09%(path)

此输出格式与 git update-index 的 --index-info --stdin 所期望的格式兼容。

当使用 -l 选项时，格式变为：

%(objectmode) %(objecttype) %(objectname) %(objectsize:padded)%x09%(path)

由 <objectname> 标识的对象大小以字节为单位给出，并右对齐，最小宽度为 7 个字符。对象大小仅针对 blob（文件）条目给出；对于其他条目，使用 - 字符代替大小。

如果不使用 -z 选项，则具有“特殊”字符的路径名将像 core.quotePath 配置变量（参见 git-config[1]）中解释的那样被引用。使用 -z 时，文件名将按原样输出，行以 NUL 字节结束。

自定义格式

可以通过使用 --format 选项以自定义格式打印，该选项能够使用 %(fieldname) 符号插值不同的字段。例如，如果你只关心 "objectname" 和 "path" 字段，可以使用特定的 "--format" 执行，如：

git ls-tree --format='%(objectname) %(path)' <tree-ish>

字段名称

结构化字段中的各种值可用于插值到结果输出中。对于每个输出行，可以使用以下名称：

objectmode

对象的模式。

objecttype

对象的类型（commit、blob 或 tree）。

objectname

对象的名称。

objectsize[:padded]

blob 对象的大小（如果是 commit 或 tree 则为 "-"）。它还支持通过 "%(objectsize:padded)" 进行填充格式化。

path

对象的路径名。

GIT

Git[1] 套件的一部分