简体中文 ▾ 主题 ▾ 最新版本 ▾ git-submodule 最后更新于 2.52.0

名称

git-submodule - 初始化、更新或检查子模块

概要

git submodule [--quiet] [--cached]
git submodule [--quiet] add [<options>] [--] <repository> [<path>]
git submodule [--quiet] status [--cached] [--recursive] [--] [<path>…​]
git submodule [--quiet] init [--] [<path>…​]
git submodule [--quiet] deinit [-f|--force] (--all|[--] <path>…​)
git submodule [--quiet] update [<options>] [--] [<path>…​]
git submodule [--quiet] set-branch [<options>] [--] <path>
git submodule [--quiet] set-url [--] <path> <newurl>
git submodule [--quiet] summary [<options>] [--] [<path>…​]
git submodule [--quiet] foreach [--recursive] <command>
git submodule [--quiet] sync [--recursive] [--] [<path>…​]
git submodule [--quiet] absorbgitdirs [--] [<path>…​]

描述

检查、更新和管理子模块。

有关子模块的更多信息，请参阅 gitsubmodules[7]。

命令

不带参数时，显示现有子模块的状态。有几个子命令可用于对子模块执行操作。

add [-b <分支>] [-f|--force] [--name <名称>] [--reference <仓库>] [--ref-format <格式>] [--depth <深度>] [--] <仓库> [<路径>]

将给定的仓库添加为当前项目旁的更改集中的子模块，该更改集将用于下一个提交：当前项目称为“超级项目”。

<仓库> 是新子模块的源仓库的 URL。它可以是绝对 URL，也可以（如果以 ./ 或 ../ 开头）是相对于超级项目的默认远程仓库的位置（请注意，要指定一个与超级项目 foo.git 紧邻的仓库 bar.git，您必须使用 ../foo.git 而不是 ./foo.git - 正如遵循相对 URL 规则时可能期望的那样 - 因为 Git 中相对 URL 的解析与相对目录的解析相同）。

默认远程是当前分支的远程跟踪分支的远程。如果不存在这样的远程跟踪分支或 HEAD 已分离，则假定“origin”是默认远程。如果超级项目没有配置默认远程，则超级项目是其自身权威的上游，并使用当前工作目录代替。

可选参数 <路径> 是在超级项目中克隆的子模块存在的相对位置。如果未给出 <路径>，则使用源仓库的规范部分（“repo”用于“/path/to/repo.git”，而“foo”用于“host.xz:foo/.git”）。如果 <路径> 存在且已经是有效的 Git 仓库，则它将被暂存提交，而无需克隆。<路径> 也用作子模块配置条目中的逻辑名称，除非使用 --name 指定了逻辑名称。

给定的 URL 将被记录在 .gitmodules 文件中，供后续克隆超级项目的用户使用。如果 URL 是相对于超级项目仓库给出的，则假定超级项目和子模块仓库将保持相同的相对位置，并且只需要提供超级项目的 URL。git-submodule 将使用 .gitmodules 中的相对 URL 正确地定位子模块。

如果指定了 --ref-format <格式>，新克隆的子模块的 ref 存储格式将相应设置。

status [--cached] [--recursive] [--] [<path>…​]

显示子模块的状态。这将打印每个子模块当前签出的提交的 SHA-1，以及子模块路径和 git describe 命令对 SHA-1 的输出。每个 SHA-1 可能被前缀 -（如果子模块未初始化），+（如果当前签出的子模块提交与包含仓库的索引中的 SHA-1 不匹配），以及 U（如果子模块有合并冲突）。

如果指定了 --cached，此命令将改为打印在超级项目为每个子模块记录的 SHA-1。

如果指定了 --recursive，此命令将递归到嵌套的子模块中，并显示它们的状态。

如果您只对当前已初始化的子模块相对于索引或 HEAD 提交的更改感兴趣，git-status[1] 和 git-diff[1] 也会提供这些信息（并且还可以报告对子模块工作树的更改）。

init [--] [<path>…​]

初始化索引中记录的子模块（这些子模块已在其他地方添加和提交），方法是使用 .gitmodules 中的相同设置作为模板，在 .git/config 中设置 submodule.$name.url。如果 URL 是相对的，它将使用默认远程进行解析。如果没有默认远程，则当前仓库将被假定为上游。

可选的 <path> 参数限制了将初始化哪些子模块。如果未指定路径且已配置 submodule.active，则将初始化配置为活动的子模块，否则将初始化所有子模块。

它还会将 .gitmodules 文件中存在的 submodule.$name.update 的值复制到 .git/config，但 (1) 此命令不会更改 .git/config 中现有信息，并且 (2) 出于安全原因，设置为自定义命令的 submodule.$name.update 不会被复制。

您可以自定义 .git/config 中的子模块克隆 URL 以适应您的本地设置，然后继续执行 git submodule update；如果您不打算自定义任何子模块位置，也可以直接使用 git submodule update --init，而无需显式的 init 步骤。

请参阅 add 子命令以了解默认远程的定义。

deinit [-f|--force] (--all|[--] <path>…​)

注销给定的子模块，即从 .git/config 中删除整个 submodule.$name 部分及其工作目录。后续对 git submodule update、git submodule foreach 和 git submodule sync 的调用将跳过任何未注销的子模块，直到它们被再次初始化，因此如果您不再想在工作树中拥有子模块的本地检出，请使用此命令。

当命令不带路径规范运行时，它会报错，而不是注销所有内容，以防止错误。

如果指定了 --force，即使子模块的工作目录包含本地修改，也会将其删除。

如果您确实想从仓库中删除子模块并提交，请改用 git-rm[1]。有关删除选项，请参阅 gitsubmodules[7]。

update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference <仓库>] [--ref-format <格式>] [--depth <深度>] [--recursive] [--jobs <n>] [--[no-]single-branch] [--filter <filter-spec>] [--] [<path>…​]

通过克隆缺失的子模块、获取子模块中缺失的提交并更新子模块的工作树来更新已注册的子模块以匹配超级项目的期望。“更新”可以有多种方式，具体取决于命令行选项和 submodule.<name>.update 配置变量的值。命令行选项优先于配置变量。如果两者都未给出，则执行 checkout。（注意：.gitmodules 文件中的内容在此阶段无关紧要；有关 .gitmodules 的使用方法，请参阅上面的 git submodule init）。命令行和 submodule.<name>.update 配置支持的 update 过程包括：

checkout

将在子模块中检出超级项目记录的提交，处于分离 HEAD 状态。

如果指定了 --force，即使包含仓库索引中指定的提交已与子模块中已检出的提交匹配，子模块也将被强制检出（使用 git checkout --force）。

rebase

将子模块的当前分支变基到超级项目中记录的提交之上。

merge

将超级项目中记录的提交合并到子模块的当前分支中。

以下更新过程有额外限制

custom command

用于运行任意命令并将提交 ID 作为参数的机制。具体来说，如果 submodule.<name>.update 配置变量设置为 !custom command，则超级项目为子模块记录的提交的对象名称将追加到 custom command 字符串并执行。请注意，此机制不适用于 .gitmodules 文件或命令行。

none

子模块不会被更新。此更新过程不允许在命令行中使用。

如果子模块尚未初始化，并且您只想使用 .gitmodules 中存储的设置，则可以使用 --init 选项自动初始化子模块。

如果指定了 --recursive，此命令将递归到已注册的子模块中，并更新其中的任何嵌套子模块。

如果指定了 --ref-format <格式>，新克隆的子模块的 ref 存储格式将相应设置。

如果指定了 --filter <filter-spec>，则会将给定的部分克隆过滤器应用于子模块。有关过滤器规范的详细信息，请参阅 git-rev-list[1]。

set-branch (-b|--branch) <分支> [--] <path>
set-branch (-d|--default) [--] <path>

设置子模块的默认远程跟踪分支。--branch 选项允许指定远程分支。--default 选项删除 submodule.<name>.branch 配置键，这会导致跟踪分支默认为远程 HEAD。

set-url [--] <path> <newurl>

将指定子模块的 URL 设置为 <newurl>。然后，它将自动同步子模块的新远程 URL 配置。

summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>…​]

显示给定提交（默认为 HEAD）与工作树/索引之间的提交摘要。对于有问题的子模块，将显示在给定超级项目提交和索引或工作树（由 --cached 切换）之间的子模块中的一系列提交。如果提供了 --files 选项，则显示超级项目的索引与子模块的工作树之间的子模块提交系列（此选项不允许使用 --cached 选项或提供显式提交）。

将 --submodule=log 选项与 git-diff[1] 一起使用也将提供此信息。

foreach [--recursive] <command>

在每个已检出的子模块中评估任意 shell 命令。该命令可以访问变量 $name、$sm_path、$displaypath、$sha1 和 $toplevel：$name 是 .gitmodules 中相关子模块部分的名称，$sm_path 是立即超级项目中记录的子模块的路径，$displaypath 包含从当前工作目录到子模块根目录的相对路径，$sha1 是立即超级项目中记录的提交，$toplevel 是立即超级项目顶级的绝对路径。请注意，为避免与 Windows 上的 $PATH 冲突，$path 变量现在是 $sm_path 变量的已弃用同义词。超级项目中定义的但未检出的任何子模块都会被此命令忽略。除非提供了 --quiet，否则 foreach 在评估命令之前会打印每个子模块的名称。如果提供了 --recursive，则子模块将被递归遍历（即，给定的 shell 命令也会在嵌套的子模块中进行评估）。任何子模块中命令的非零返回都会导致处理终止。这可以通过在命令末尾添加 || : 来覆盖。

例如，以下命令将显示每个子模块的路径和当前已检出的提交。

git submodule foreach 'echo $sm_path `git rev-parse HEAD`'
sync [--recursive] [--] [<path>…​]

将子模块的远程 URL 配置设置同步到 .gitmodules 中指定的值。它只会影响那些已在 .git/config 中具有 URL 条目的子模块（当它们被初始化或刚添加时就是这种情况）。当子模块 URL 在上游发生更改，并且您需要相应地更新本地存储库时，此操作很有用。

git submodule sync 同步所有子模块，而 git submodule sync -- A 只同步子模块“A”。

如果指定了 --recursive，此命令将递归到已注册的子模块中，并同步其中的任何嵌套子模块。

absorbgitdirs

如果子模块内的 git 目录存在于子模块中，则将子模块的 git 目录移动到其超级项目的 $GIT_DIR/modules 路径下，然后通过设置 core.worktree 并添加一个指向嵌入在超级项目 git 目录中的 git 目录的 .git 文件来连接 git 目录及其工作目录。

独立克隆后又被添加为子模块的仓库或旧的设置将子模块的 git 目录放在子模块内部，而不是嵌入到超级项目的 git 目录中。

此命令默认是递归的。

选项

-q
--quiet

仅打印错误消息。

--progress

此选项仅对 add 和 update 命令有效。默认情况下，当标准错误流连接到终端时，会报告进度状态，除非指定了 -q。此标志会强制显示进度状态，即使标准错误流未定向到终端。

--all

此选项仅对 deinit 命令有效。注销工作树中的所有子模块。

-b <分支>
--branch <分支>

要添加为子模块的仓库的分支。分支名称将作为 submodule.<name>.branch 记录在 .gitmodules 文件中，供 update --remote 使用。特殊值 . 用于指示子模块中的分支名称应与当前存储库中的当前分支名称相同。如果未指定该选项，则默认为远程 HEAD。

-f
--force

此选项仅对 add、deinit 和 update 命令有效。运行时，允许添加一个通常被忽略的子模块路径。此选项还用于绕过子模块名称未被使用的检查。默认情况下，如果拟议的名称（从路径派生）已在仓库中为另一个子模块注册，git submodule add 将失败。使用 --force 允许命令继续，自动生成唯一的名称，方法是在冲突名称后附加一个数字（例如，如果存在一个名为 child 的子模块，它将尝试 child1，依此类推）。运行 deinit 时，即使子模块工作树包含本地更改，也会将其删除。运行 update（仅在 checkout 过程有效）时，切换到不同提交时将丢弃子模块中的本地更改；并始终在子模块中执行 checkout 操作，即使包含仓库的索引中列出的提交与子模块中已检出的提交匹配。

--cached

此选项仅对 status 和 summary 命令有效。这些命令通常使用子模块 HEAD 中找到的提交，但使用此选项时，将改用索引中存储的提交。

--files

此选项仅对 summary 命令有效。此命令在使用了此选项时，比较索引中的提交与子模块 HEAD 中的提交。

-n
--summary-limit

此选项仅对 summary 命令有效。限制摘要大小（显示的总提交数）。提供 0 将禁用摘要；负数表示无限制（默认）。此限制仅适用于已修改的子模块。对于已添加/已删除/类型已更改的子模块，大小始终限制为 1。

--remote

此选项仅对 update 命令有效。而不是使用超级项目记录的 SHA-1 来更新子模块，而是使用子模块的远程跟踪分支的状态。使用的远程是分支的远程（branch.<name>.remote），默认为 origin。使用的远程分支默认为远程 HEAD，但可以通过在 .gitmodules 或 .git/config 中设置 submodule.<name>.branch 选项来覆盖分支名称（.git/config 具有优先权）。

这适用于所有支持的更新过程（--checkout、--rebase 等）。唯一的变化是目标 SHA-1 的来源。例如，submodule update --remote --merge 将把上游子模块更改合并到子模块中，而 submodule update --merge 将把超级项目的 gitlink 更改合并到子模块中。

为了确保跟踪分支的最新状态，update --remote 会在计算 SHA-1 之前获取子模块的远程仓库。如果您不想获取，应该使用 submodule update --remote --no-fetch。

使用此选项可将上游子项目的更改集成到子模块的当前 HEAD 中。或者，您可以从子模块运行 git pull，其功能等效，但远程分支名称不同：update --remote 使用默认的上游仓库和 submodule.<name>.branch，而 git pull 使用子模块的 branch.<name>.merge。如果您想与超级项目一起分发默认的上游分支，请优先使用 submodule.<name>.branch；如果您在处理子模块本身时想要更本地化的感觉，请优先使用 branch.<name>.merge。

-N
--no-fetch

此选项仅对 update 命令有效。不要从远程站点获取新对象。

--checkout

此选项仅对 update 命令有效。在子模块中以分离 HEAD 状态检出超级项目记录的提交。这是默认行为，此选项的主要用途是覆盖 submodule.$name.update，当其设置为除 checkout 之外的值时。如果 submodule.$name.update 键未显式设置或设置为 checkout，则此选项是隐含的。

--merge

此选项仅对 update 命令有效。将超级项目记录的提交合并到子模块的当前分支中。如果指定了此选项，则子模块的 HEAD 不会分离。如果合并失败阻碍了此过程，您将需要使用常规冲突解决工具在子模块内解决由此产生的冲突。如果 submodule.$name.update 键设置为 merge，则此选项是隐含的。

--rebase

此选项仅对 update 命令有效。将当前分支变基到超级项目中记录的提交之上。如果指定了此选项，则子模块的 HEAD 不会分离。如果合并失败阻碍了此过程，您将需要使用 git-rebase[1] 来解决这些失败。如果 submodule.$name.update 键设置为 rebase，则此选项是隐含的。

--init

此选项仅对 update 命令有效。在更新之前，初始化所有尚未调用“git submodule init”的子模块。

--name

此选项仅对 add 命令有效。它将子模块的名称设置为给定的字符串，而不是默认为其路径。名称必须是有效的目录名称，且不能以 / 结尾。

--reference <仓库>

此选项仅对 add 和 update 命令有效。这些命令有时需要克隆远程仓库。在这种情况下，此选项将传递给 git-clone[1] 命令。

注意：除非您仔细阅读了 git-clone[1] 的 --reference、--shared 和 --dissociate 选项的注意事项，否则请不要使用此选项。

--dissociate

此选项仅对 add 和 update 命令有效。这些命令有时需要克隆远程仓库。在这种情况下，此选项将传递给 git-clone[1] 命令。

注意：请参阅 --reference 选项的注意事项。

--recursive

此选项仅对 foreach、update、status 和 sync 命令有效。递归遍历子模块。操作不仅在当前仓库的子模块中执行，还在这些子模块内的任何嵌套子模块中执行（依此类推）。

--depth

此选项对 add 和 update 命令有效。创建一个浅层克隆，其历史记录截断为指定的修订次数。请参阅 git-clone[1]。

--recommend-shallow
--no-recommend-shallow

此选项仅对 update 命令有效。子模块的初始克隆将默认使用 .gitmodules 文件提供的推荐 submodule.<name>.shallow 设置。要忽略此建议，请使用 --no-recommend-shallow。

-j <n>
--jobs <n>

此选项仅对 update 命令有效。使用指定数量的作业并行克隆新子模块。默认为 submodule.fetchJobs 选项。

--single-branch
--no-single-branch

此选项仅对 update 命令有效。在更新期间只克隆一个分支：HEAD 或通过 --branch 指定的分支。

<path>…​

子模块的路径。指定时，此命令将仅限于对指定路径下的子模块进行操作。（添加命令需要此参数）。

文件

在初始化子模块时，将使用包含仓库的顶层目录中的 .gitmodules 文件来查找每个子模块的 url。此文件应与 $GIT_DIR/config 的格式相同。每个子模块 url 的键是 "submodule.$name.url"。有关详细信息，请参阅 gitmodules[5]。

另请参阅

gitsubmodules[7], gitmodules[5]。

GIT

Git[1] 套件的一部分