为什么 git 子模块不会在 git checkout 上自动更新？

Question

当使用 git checkout 切换分支时，我会假设大多数时候你会想要更新你的子模块。

• 在什么情况下您不想在切换后更新子模块？
• 如果这由 git checkout 自动完成，会出现什么问题？

更新示例：

• 分支 A 在 3852f1 有子模块 S
• B 分支在 fd72d7 有子模块 S

在分支 A 上，git checkout B 将生成分支 B 的工作副本，其中子模块 S 位于 3852f1（带有修改的 S）。 git submodule update 将在 fd72d7 签出 S。

Answer 1

git checkout --recurse-submodules 已添加到 git 2.13

发行说明中提到了这一点：https://github.com/git/git/commit/e1104a5ee539408b81566066aaa6963cb87d5cd6#diff-c24776ff22455a30fbb78e378b7df0b0R139

submodule.recurse 选项已添加到 git 2.14

设置为：

git config --global submodule.recurse true

man git-config 说：

指定命令是否默认递归到子模块中。这适用于所有具有--recurse-submodules 选项的命令。默认为 false。

我觉得默认不更新模块是一个糟糕的 Git 默认行为，它违背了大多数用户的期望并限制了子模块的采用，我真的希望开发人员能够改变它。

Answer 2

我相信不自动更新的子模块符合 Git 的开发目标。 Git 旨在以分布式模式工作，并且不假定您甚至可以连接到非本地存储库，除非您明确告诉它这样做。考虑到这种情况，Git 不自动刷新子模块将是预期的行为。

话虽如此，如果你知道你总是希望这些子模块被拉入，并且你知道你永远不会将这些子模块分支到另一个本地存储库，那么如果你自动地它不应该破坏任何东西结帐后刷新它们。

Answer 3

使用 Git 2.27（2020 年第二季度），“--recurse-submodules”选项得到了更好的记录。

参见Damien Robert (damiens-robert)@commit acbfae3、commit 4da9e99、commit d09bc51、commit b3cec57、commit dd0cb7d（2020 年 4 月 6 日）。
^{（由Junio C Hamano -- gitster -- 合并到commit cc908db， 2020 年 4 月 28 日）}

doc: --recurse-submodules 主要适用于 active 子模块

^{签字人：Damien Robert
协助人：Philippe Blain}

文档提到“初始化”或“填充”子模块，以解释哪些子模块受“--recurse-submodules”影响，但这里的真正术语是“active”子模块。相应地更新文档。

一些术语：

• Active is defined in gitsubmodules(7)，只涉及配置变量'submodule.active'、'submodule.<name>.active'和'submodule.<name>.url'。
  submodule.c::is_submodule_active 函数检查子模块是否处于活动状态。
• Populated 表示子模块的工作树存在（并且 gitfile 正确指向子模块存储库），即超级项目使用--recurse-submodules 克隆，或者用户运行git submodule update --init，或@987654333 @ 和 git submodule update [<path>] 分别填充了子模块工作树。
  这不涉及上面的 3 个配置变量。
• Initialized（至少在本补丁所涉及的手册页的上下文中）表示上面定义的“填充”和“活动”，即[git submodule更新 --init](https://git-scm.com/docs/git-submodule) 会。

--recurse-submodules 选项主要影响活动子模块。

一个例外是git fetch，该选项会影响填充的子模块。
因此，在git pull --recurse-submodules 中，fetch 会影响填充的子模块，但生成的工作树更新只会影响活动的子模块。

在git-pull的文档中，让我们区分影响填充子模块的获取部分和仅影响活动子模块的工作树更新。

---

使用 Git 2.33（2021 年第三季度），submodule.recurse 的文档更加清晰：

参见Philippe Blain (phil-blain) 的commit 878b399（2021 年 7 月 16 日）。
^{（由 Junio C Hamano -- gitster -- 合并于 commit c018818，2021 年 8 月 2 日）}

doc：澄清“submodule.recurse”的描述

^{签字人：Philippe Blain}

“submodule.recurse”的文档以“指定命令是否默认递归到子模块”开头。
并非所有具有“--recurse-submodules”选项的命令都是如此。
例如，'git pull --recurse-submodules'^(man) 不在每个子模块中运行 'git pull'^(man)，而是运行 '@987654344 @'^(man) 以便拉取后的子模块工作树与超级项目中记录的提交匹配。

通过说它启用“--recurse-submodules”来澄清这一点。

请注意，此设置与“fetch.recurseSubmodules”和“push.recurseSubmodules”交互的方式，它们可以具有除真或假以外的其他值，自4da9e99（“doc：在(fetch|push).recurseSubmodules", 2020-04-06, Git v2.27.0-rc0 -- merge 列在batch #4)。

git config 现在包含在其man page 中：

一个布尔值，指示命令是否应默认启用--recurse-submodules 选项。 适用于支持此选项的所有命令。