简体中文 ▾ 主题 ▾ 最新版本 ▾ git-show-ref 最后更新于 2.46.0

名称

git-show-ref - 列出本地仓库中的引用

概要

git show-ref [--head] [-d | --dereference]
	     [-s | --hash[=<n>]] [--abbrev[=<n>]] [--branches] [--tags]
	     [--] [<pattern>…​]
git show-ref --verify [-q | --quiet] [-d | --dereference]
	     [-s | --hash[=<n>]] [--abbrev[=<n>]]
	     [--] [<ref>…​]
git show-ref --exclude-existing[=<pattern>]
git show-ref --exists <ref>

描述

显示本地仓库中可用的引用以及关联的提交 ID。可以使用模式对结果进行过滤,并且可以将标签解引用为对象 ID。此外,它还可以用于测试特定引用是否存在。

默认情况下,显示标签、分支头(heads)和远程引用。

--exclude-existing 形式是一个执行相反操作的过滤器。它从标准输入读取引用(每行一个),并显示那些在本地仓库中不存在的引用。

--exists 形式可用于检查单个引用是否存在。此形式不验证该引用是否解析为实际对象。

鼓励使用此工具,而不是直接访问 .git 目录下的文件。

选项

--head

显示 HEAD 引用,即使它通常会被过滤掉。

--branches
--tags

分别限制为本地分支和本地标签。这些选项不是互斥的;当两者都给定时,将显示存储在 "refs/heads" 和 "refs/tags" 中的引用。注意,--heads--branches 的过时同义词,将来可能会被移除。

-d
--dereference

同时将标签解引用为对象 ID。它们将在显示时追加 ^{}

-s
--hash[=<n>]

仅显示对象 ID(OID),不显示引用名称。当与 --dereference 结合使用时,解引用后的标签仍会显示在 OID 之后。

--verify

通过要求精确的引用路径来启用更严格的引用检查。除了返回错误代码 1 之外,如果未指定 --quiet,它还会打印错误消息。

--exists

检查给定的引用是否存在。如果存在则返回退出代码 0,如果缺失则返回 2,如果查找引用失败(且错误原因不是引用缺失)则返回 1。

--abbrev[=<n>]

缩写对象名称。使用 --hash 时,不需要写成 --hash --abbrev;使用 --hash=n 即可。

-q
--quiet

不向标准输出打印任何结果。可以与 --verify 配合使用,以静默方式检查引用是否存在。

--exclude-existing[=<pattern>]

使 git show-ref 充当过滤器,从标准输入读取格式为 ^(?:<anything>\s)?<refname>(?:\^{})?$ 的引用,并对每个引用执行以下操作:(1) 去除行尾的 ^{}(如果有);(2) 如果提供了模式且未与 refname 头部匹配,则忽略;(3) 如果 refname 格式不正确,则发出警告并跳过;(4) 如果 refname 是本地仓库中存在的引用,则忽略;(5) 否则输出该行。

<pattern>…​

显示匹配一个或多个模式的引用。模式从全名的末尾开始匹配,并且仅匹配完整部分,例如 master 匹配 refs/heads/masterrefs/remotes/origin/masterrefs/tags/jedi/master,但不匹配 refs/heads/mymasterrefs/remotes/master/jedi

输出

输出格式为

<oid> SP <ref> LF

例如,

$ git show-ref --head --dereference
832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD
832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master
832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin
3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99.9c
6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99.9c^{}
055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4
423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{}
...

当使用 --hash(且不使用 --dereference)时,输出格式为

<oid> LF

例如,

$ git show-ref --branches --hash
2e3ba0114a1f52b47df29743d6915d056be13278
185008ae97960c8d551adcd9e23565194651b5d1
03adf42c988195b50e1a1935ba5fcbc39b2b029b
...

示例

要显示所有名为 "master" 的引用(无论是标签、分支头还是其他任何内容,也不管它们在引用命名层级中的深度),请使用

	git show-ref master

如果存在此类引用,这将显示 "refs/heads/master",但也会显示 "refs/remote/other-repo/master"。

当使用 --verify 标志时,该命令需要一个精确路径

	git show-ref --verify refs/heads/master

将仅匹配名为 "master" 的精确分支。

如果没有匹配项,git show-ref 将返回错误代码 1,并且在进行验证的情况下,它将显示一条错误消息。

对于脚本编写,你可以使用 --quiet 标志要求其静默,这允许你执行类似以下的操作

	git show-ref --quiet --verify -- "refs/heads/$headname" ||
		echo "$headname is not a valid branch"

来检查特定分支是否存在(注意我们实际上并不想显示任何结果,并且我们希望使用完整的引用名称,以免触发模糊部分匹配的问题)。

要仅显示标签或仅显示正式的分支头,请分别使用 --tags 和/或 --branches(同时使用两者意味着显示标签和分支,但不显示 refs/ 子目录下的其他随机引用)。

要执行自动标签对象解引用,请使用 -d--dereference 标志,这样你就可以执行

	git show-ref --tags --dereference

来获取所有标签及其解引用目标的列表。

文件

.git/refs/*, .git/packed-refs

GIT

Git[1] 套件的一部分