简体中文 ▾ 主题 ▾ 最新版本 ▾ gitmodules 最后更新于 2.42.0

名称

gitmodules - 定义子模块属性

概要

$GIT_WORK_TREE/.gitmodules

描述

位于 Git 工作树顶层目录中的 .gitmodules 文件是一个文本文件，其语法符合 git-config[1] 的要求。

该文件包含每个子模块一个子部分，子部分的名称是子模块的名称。名称设置为子模块添加到的路径，除非使用 git submodule add 的 --name 选项进行了自定义。每个子模块部分还包含以下必需的键

submodule.<name>.path

定义了子模块在 Git 工作树的顶层目录中应签出的路径。路径名称不能以 / 结尾。所有子模块路径在 .gitmodules 文件中必须是唯一的。

submodule.<name>.url

定义了可以用来克隆子模块仓库的 URL。这可以是直接传递给 git-clone[1] 的绝对 URL，或者（如果以 ./ 或 ../ 开头）相对于父项目源仓库的路径。

此外，还有一些可选的键

submodule.<name>.update

定义了命名子模块的默认更新过程，即在父项目中，git submodule update 命令如何更新子模块。这仅用于 git submodule init 来初始化同名配置变量。此处允许的值为 checkout、rebase、merge 或 none，但出于安全原因不允许 !command。有关更多详细信息，请参见 git-submodule[1] 中 update 命令的描述。

submodule.<name>.branch

用于跟踪上游子模块更新的远程分支名称。如果未指定该选项，则默认为远程 HEAD。特殊值 . 用于指示子模块中的分支名称应与当前仓库中当前分支的名称相同。有关详细信息，请参阅 git-submodule[1] 中 --remote 的文档。

submodule.<name>.fetchRecurseSubmodules

此选项可用于控制此子模块的递归获取。如果此选项也存在于父项目的 .git/config 中该子模块的条目中，则该处的设置将覆盖 .gitmodules 中的设置。这两个设置都可以通过在 git fetch 和 git pull 命令中使用 --[no-]recurse-submodules 选项在命令行中进行覆盖。

submodule.<name>.ignore

定义了 git status 和 diff 系列在何种情况下会将子模块显示为已修改。支持以下值

all

子模块将永远不会被视为已修改（但仍会在状态和提交输出中显示，当它已被暂存时）。

dirty

将忽略对子模块工作树的所有更改，只考虑子模块的 HEAD 与其在父项目中记录的状态之间的已提交差异。

untracked

将忽略子模块中未跟踪的文件。已跟踪文件的已提交差异和修改将显示出来。

none

不忽略子模块的任何修改，将显示所有已提交的差异以及已跟踪和未跟踪文件的修改。这是默认选项。

如果此选项也存在于父项目的 .git/config 中该子模块的条目中，则该处的设置将覆盖 .gitmodules 中的设置。

这两个设置都可以通过使用 --ignore-submodules 选项在命令行中进行覆盖。git submodule 命令不受此设置的影响。

submodule.<name>.shallow

设置为 true 时，将作为浅克隆（历史深度为 1）执行此子模块的克隆，除非用户明确要求非浅克隆。

注意事项

Git 不允许工作树中的 .gitmodules 文件是符号链接，并且会拒绝签出此类树条目。这使得在从索引或树访问文件与从文件系统访问文件时行为保持一致，并帮助 Git 可靠地强制执行文件内容的安全性检查。

示例

考虑以下 .gitmodules 文件

[submodule "libfoo"]
	path = include/foo
	url = git://foo.com/git/lib.git

[submodule "libbar"]
	path = include/bar
	url = git://bar.com/git/lib.git

这定义了两个子模块，libfoo 和 libbar。它们应在 include/foo 和 include/bar 路径下签出，并且为这两个子模块都指定了一个可用于克隆子模块的 URL。

另请参阅

git-submodule[1], gitsubmodules[7], git-config[1]

GIT

Git[1] 套件的一部分