Git中 子模块的添加与删除

发表于 分类于 ， 本文字数： 1.2k 阅读时长 ≈ 1 分钟

在使用 hexo 搭建博客时，往往需要添加主题来美化博客。这个时候，通常在自己的主仓库中使用子模块来进行维护。

使用子模块，既能够保持主仓库与主题的联结，又不会增加主仓库的体积，需要更新时，只需要在子模块中更新一下就可以了。

添加子模块

添加子模块主要有以下步骤：

添加子模块

使用如下命令添加子模块：

1
git submodule add <url> <path>
  • url: 为子模块的 git 地址
  • path: 该子模块相对于主仓库的路径，以 ./ 开头

验证结果

添加完成后，使用如下命令可以查看子模块是否添加成功：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
git diff --cached

# 输出以下内容，说明添加成功了：
diff --git a/.gitmodules b/.gitmodules
index 8b13789..61f1572 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1 +1,4 @@

+[submodule "themes/next"]
+       path = themes/next
+       url = https://github.com/next-theme/hexo-theme-next.git
diff --git a/themes/next b/themes/next
new file mode 160000
index 0000000..2e5757e
--- /dev/null

提交结果

使用 git commit <message> 来提交添加结果

使用子模块

克隆项目后，默认子模块目录下无任何内容。需要在项目根目录执行如下命令完成子模块的下载：

1
2
git submodule init
git submodule update

或：

1
git submodule update --init --recursive

执行后，子模块目录下就有了源码。

更新子模块

子模块的维护者提交了更新后，使用子模块的项目必须手动更新才能包含最新的提交。

在项目中，进入到子模块目录下，执行 git pull更新，查看git log查看相应提交。

完成后返回到项目目录，可以看到子模块有待提交的更新，使用git add，提交即可。

删除子模块

时子模块的项目维护地址发生了变化，或者需要替换子模块，就需要删除原有的子模块。

删除子模块较复杂，步骤如下：

  1. rm -rf 子模块目录 删除子模块目录及源码
  2. vi .gitmodules 删除项目目录下.gitmodules文件中子模块相关条目
  3. vi .git/config 删除配置项中子模块相关条目
  4. rm .git/module/* 删除模块下的子模块目录，每个子模块对应一个目录，注意只删除对应的子模块目录即可

注意：删除完成后，先要 git commit 提交一下，然后才可以再添加同名的子模块。

如果仍然报错，执行如下：

1
git rm --cached 子模块名称

完成删除后，提交到仓库即可。