git submodule

添加子模块

git submodule add <url> <path>
  • url 子模块的路径
  • path 子模块存储的目录路径

执行成功后,git status 会看到项目中修改了 .gitmodules,并增加了一个新文件(为刚刚添加的路径)

git diff --cached 查看修改内容可以看到增加了子模块,并且新文件下为子模块的提交 hash 摘要

git commit 提交即完成子模块的添加

子模块的使用

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

方式一

git submodule init
git submodule update

方式二

git submodule update --init --recursive

方式三

采用递归的方式clone整个项目

git clone git@github.com:jjz/pod-project.git --recursive

执行后,子模块目录下就有了源码,再执行相应的 makefile 即可

子模块更新

方式一

在父项目的目录下直接运行

git submodule foreach git pull

方式二

在 submodule 的目录下面更新

cd pod-library
git pull

删除子模块

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

删除子模块较复杂,步骤如下:

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

执行完成后,再执行添加子模块命令即可,如果仍然报错,执行如下:

git rm --cached 子模块名称

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