git子模块的使用

1. 在项目中添加子模块

命令： git submodule add <url>

例子： git submodule add https://github.com/chaconinc/DbConnector

此命令在当前工作目录添加了一个名为"DbConnector"的子模块，且子模块地址为：https://github.com/chaconinc/DbConnector，另外这条命令会在当前工作文件夹添加两个文件.gitmodules和DbConnector。

然后你可以将本次的添加子模块的动作提交并推送到仓库：

$ git commit -m 'added DbConnector module'
$ git push origin master

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

命令：

$ git clone https://github.com/chaconinc/MainProject
$ git submodule init
$ git submodule update

第一条命令会将主项目的内容克隆下来，但是子模块DbConnector的内容不会被克隆。第二条命令是用来初始化本地配置文件，而第三条命令才是抓取子模块对应远程仓库的内容。

可以将上述三条命令合并成一条：

$ git clone --recurse-submodules https://github.com/chaconinc/MainProject

也可以将三条命令合并成两条：

$ git clone https://github.com/chaconinc/MainProject
$ git submodule update --init

3. 在包含子模块的项目上工作

经过上面的clone，在本地已经有了一个包含子模块的项目的副本，如何同时在主项目和子模块项目上与队员协作？

3.1 从子模块的远端拉取上游修改

命令：

• 手动拉取并合并(子模块目录下)

  $ git fetch
  $ git merge origin/master
  

  此时提交，子模块就会锁定为其他人更新时的新代码。

• 自动拉取合并(主项目目录下)

  $ git submodule update --remote
  

  此命令会默认拉取子模块仓库的master分支，也可以设置为想要的其他分支。

  此时，在主项目目录下运行git status，Git会显示子模块有“新提交”。

3.2 从主项目远端拉取上游更改

命令:

$ git pull
$ git submodule update --init --recursive

第一条命令会递归地抓取子模块的更改，但是不会更新子模块。此时运行git status，Git会显示子模块“已修改”且“有新的提交”，其实这些更改和提交已经在MainProject中有了记录，只是没有在本地的子模块中记录而已，所以需要更新子模块，因此需要使用第二条命令，此时再运行git status则不会再有上述的提示。

上述命令也可以合并为一条：

$ git pull --recurse-submodules

此命令会自动完成子模块的更新工作。

3.3 在子模块上工作

命令：

1. $ cd DbConnector
2. $ git checkout stable
3. $ cd ..
4. $ git submodule update --remote --merge
5. $ cd DbConnector/
6. $ vim src/db.c
7. $ git commit -am 'unicode support'
8. $ cd ..
9. $ git submodule update --remote --rebase

第1行：进入到子模块目录
第2行：切换到子模块中的stable分支
第3行：主目录
第4行：拉取子模块上游更改并合并到本地
第5行：进入到子模块目录
第6行：创建db.c
第7行：提交本地更改
第8行：进入主目录
第9行：再次拉取上游更新并合并到本地

第9行中如果忘记了添加--rebase/--merge，GIt会将子模块更新为服务器上的状态。此时需要回到子模块目录中再次检出你的分支，然后手动合并或变基。

如果没有及时提交本地修改，即没有执行第7行，直接进行了8，9，那也不要紧，此时Git会只抓取更改而并不会覆盖子模块目录中没有保存的工作。

如果运行第9行时出现冲突，像往常一样解决冲突即可。

3.4 发布子模块改动

现在子模块目录中有一些改动（一些是通过更新从上游引入的，另一些是本地生成的）。如果我们在主项目中提交并推送但并不推送子模块上的改动，其他尝试检出我们修改的人就会遇到麻烦，他们无法得到依赖的子模块的改动。

命令(主目录下)：

$ git push --recurse-submodule=check
$ git push --recurse-submodule=on-demand 

第一条命令会在推送主项目之前检查所有子模块是否已经推送，如果有任何提交的子模块没有推送，那么推送就会失败。

第二条命令会在推送主项目之前检查所有子模块是否已经推送，如果有任何子模块没有推送，那么推送之，直至所有子模块推送完毕，再推送主项目。再此期间，任何子项目推送失败都会导致主项目推送失败。