Git
英语 ▾ 主题 ▾ 最新版本 ▾ git-check-ref-format 最后更新于 2.43.0

名称

git-check-ref-format - 确保引用名称格式正确

概要

git check-ref-format [--normalize]
       [--[no-]allow-onelevel] [--refspec-pattern]
       <refname>
git check-ref-format --branch <branchname-shorthand>

描述

检查给定的 refname 是否可接受，如果不可接受则以非零状态退出。

引用在 Git 中用于指定分支和标签。分支头存储在 refs/heads 层次结构中，而标签存储在 ref 命名空间的 refs/tags 层次结构中（通常在 $GIT_DIR/refs/heads 和 $GIT_DIR/refs/tags 目录中，或者作为文件 $GIT_DIR/packed-refs 中的条目，如果引用被 git gc 打包）。

Git 对引用命名方式施加以下规则

  1. 它们可以包含斜杠 / 用于层次（目录）分组，但任何以斜杠分隔的组件都不能以点 . 开头，也不能以 .lock 结尾。

  2. 它们必须包含至少一个 /。这强制存在一个类别，例如 heads/、tags/ 等，但实际名称不受限制。如果使用 --allow-onelevel 选项，则此规则将被放弃。

  3. 它们不能在任何地方包含两个连续的点 ..。

  4. 它们不能包含任何地方的 ASCII 控制字符（即值小于 \040 的字节，或 \177 DEL）、空格、波浪号 ~、插入符 ^ 或冒号 :。

  5. 它们不能包含任何地方的问号 ?、星号 * 或左方括号 [。有关此规则的例外，请参见下面的 --refspec-pattern 选项。

  6. 它们不能以斜杠 / 开头或结尾，也不能包含多个连续的斜杠（有关此规则的例外，请参见下面的 --normalize 选项）。

  7. 它们不能以点 . 结尾。

  8. 它们不能包含 @{ 序列。

  9. 它们不能是单个字符 @。

  10. 它们不能包含 \。

这些规则使基于 shell 脚本的工具更容易解析引用名称，shell 在引用名称未加引号的情况下（错误地）使用引用名称时进行路径名扩展，并且还避免了某些引用名称表达式中的歧义（参见 gitrevisions[7]）。

  1. 双点 .. 通常用于 ref1..ref2 中，在这种情况下，此符号表示 ^ref1 ref2（即不在 ref1 中，而在 ref2 中）。

  2. 波浪号 ~ 和插入符 ^ 用于引入后缀 第 n 个父级 和 剥洋葱 操作。

  3. 冒号 : 用于 srcref:dstref 中，表示“使用 srcref 的值并将其存储在 dstref 中”，用于 fetch 和 push 操作。它还可用于选择特定对象，例如在 'git cat-file' 中：“git cat-file blob v1.3.3:refs.c”。

  4. at-open-brace @{ 作为一种符号用于访问 reflog 条目。

使用 --branch 选项时，该命令将接收一个名称并检查它是否可以用作有效的分支名称（例如，当创建新分支时）。但在使用可能引用分离的 HEAD 状态的先前签出语法时要谨慎。规则 git check-ref-format --branch $name 实现的可能比 git check-ref-format refs/heads/$name 严格（例如，连字符可能出现在 ref 组件的开头，但明确禁止出现在分支名称的开头）。当使用 --branch 选项在存储库中运行时，输入首先会被扩展为“先前签出语法” @{-n}。例如，@{-1} 是一种引用使用“git switch”或“git checkout”操作签出的最后内容的方式。此选项应由瓷器在需要分支名称的任何地方接受这种语法，以便它们可以像您键入分支名称一样进行操作。需要注意的是，“先前签出操作”可能导致提交对象名称，如果第 N 次签出的内容不是分支。

选项

--[no-]allow-onelevel

控制是否接受一级 refname（即，不包含多个以 / 分隔的组件的 refname）。默认值为 --no-allow-onelevel。

--refspec-pattern

将 <refname> 解释为 refspec 的引用名称模式（在远程存储库中使用）。如果启用此选项，则 <refname> 允许在 refspec 中包含一个 *（例如，foo/bar*/baz 或 foo/bar*baz/，但不包括 foo/bar*/baz*）。

--normalize

通过删除任何前导斜杠 (/) 字符并将名称组件之间相邻的斜杠运行折叠为单个斜杠来规范化 refname。如果规范化的 refname 有效，则将其打印到标准输出并以 0 的状态退出，否则以非零状态退出。（--print 是 --normalize 的过时写法）。

示例

  • 打印先前签出的内容的名称

    $ git check-ref-format --branch @{-1}

  • 确定用于新分支的引用名称

    $ ref=$(git check-ref-format --normalize "refs/heads/$newbranch")||
{ echo "we do not like '$newbranch' as a branch name." >&2 ; exit 1 ; }

Git

是 git[1] 套件的一部分

scroll-to-top