git如何引用子模块

如何创建子模块

使用场景：
在一个repository里面如何引入另一个repository的代码？

1. 一种方法是，手动clone出来；比如在build的时候，一次clone出两个repository，按目录组织好就行。
2. 另一种方法是，直接在一个repository里面指定需要依赖的repository；这就是本文介绍的子模块概念。

步骤

1. 在repository根目录下面执行

$ git submodule add <depend-module-url>/<depend-module-name>.git

那么就会在当前目录下面创建一个子目录<depend-module-name>
如果需要放不同的目录下面，即非根目录，而是其他比如子目录，则：

$ git submodule add <depend-module-url>/<depend-module-name>.git <sub-directory>/<new-module-name>

• 目录<sub-directory>，和<sub-directory>/<new-module-name>不需要事先存在，git submodule add会创建。
• 名称<new-module-name>可以和<depend-module-name>一样，也可以不一样；但通常用一样，便于阅读。

2. 结果是什么

• 根目录下生成一个.gitmodules文件，包含如下内容：

[submodule "<sub-directory>/<new-module-name>"]
    path = <sub-directory>/<new-module-name>
    url = <depend-module-url>/<depend-module-name>.git

• 创建了目录: <sub-directory>/<new-module-name>
• repository <depend-module-url>/<depend-module-name>.git的代码被clone出来在目录<sub-directory>/<new-module-name>下

注意：
文件.gitmodules和空目录<sub-directory>/<new-module-name>(不含下面的repository内容)会被作为一个commit需要提交，这样以后clone出来的时候才会保留。此时可以通过git status查看到这两个文件的状态。

3. 后续如果迁出代码

• git clone <parent-module-url>/<parent-module-name>.git
  则<sub-directory>/<new-module-name>会迁出一个空目录，没有内容

• git clone --recursive <parent-module-url>/<parent-module-name>.git
  则<sub-directory>/<new-module-name>会同步迁出一个<depend-module-url>/<depend-module-name>.git的完整代码。

需要注意的是：

1. git submodule add 是基于子模块的最新的commit的。
   也就是说parent repository将会一直指向在执行git submodule add 时刻submodule分支上的最新commit；此后在submodule上提交的commit不会被parent repository使用git clone --recursive更新下来(必须手动更新)，即将永远指向给定的commit。
2. 那么如何更新submodule呢

cd [submodule directory]
git checkout master
git pull

# commit the change in main repo
# to use the latest commit in master of the submodule
cd ..
git add [submodule directory]
git commit -m "move submodule to latest commit in master"

# share your changes
git push