git submodule小记

Git Submodule 允许您将一个 Git 仓库作为另一个 Git 仓库的子目录。这对于确保外部依赖性能保持更新以及重用其他项目的代码片段非常有用。

以下是如何在您的 Git 仓库中添加和更新子模块的基本步骤：

1. 添加子模块

要将另一个 Git 仓库作为子模块添加到项目中，请使用以下命令：

git submodule add <repository_url> <path_to_submodule>

例如，要将一个库添加到名为external_lib 的子目录中，请运行：

git submodule add https://github.com/username/repository_name.git external_lib

这将克隆子模块并将其添加到 .gitmodules 文件中。

2. 克隆包含子模块的项目

要克隆一个包含子模块的项目，请使用以下命令：

git clone --recurse-submodules <project_repository_url>

此命令将确保项目的子模块也被克隆。

3. 更新子模块

对于已克隆子模块的项目，要更新子模块的内容，先转到子模块所在目录，然后运行以下命令：

# 切换到子模块目录
cd external_lib

# 获取所有远程更新
git fetch

# 切换到最新分支
git checkout main

# 更新子模块
git pull

或简化为一条命令：

git submodule update --remote --merge

这将更新子模块内容并将它们与主存储库保持同步。

4. 删除子模块

要删除子模块，需要手动执行一些步骤，先从配置文件和本地文件中移除它们，再删除剩余缓存。

# 从 .gitmodules 文件中移除子模块条目
git config -f .gitmodules --remove-section submodule.external_lib

# 从 .git/config 文件中移除子模块
git config --remove-section submodule.external_lib

# 移除子模块文件和 submodule 处于挂起的状态
git rm --cached external_lib

# 删除外部库目录
rm -rf external_lib

# 提交更改
git add .gitmodules
git commit -m "Removed submodule external_lib"

这将彻底删除子模块。