git submodule 基本用法

简 述：　记录几个 git submodule 常用的基本命令。

本文初发于 “偕臧的小站”，同步转载于此。

抉择

​ 最近在个人项目中引入第三方库，通常会使用到 git submodule 或 git treemodule 命令，各有优略，不存在谁是当前流行的趋势。适合自己使用的，才是最好的。git submodule 的类似 “链接引用”，而 git treemodule 则更接近 “拷贝复制” 下来使用。对本人而言，更喜欢前者形式。

git submodule

添加子模块

# 引入第三方库到本地指定路径
git submodule add [-b master] [remote_repo] [dest_dir]
eg:
git submodule add https://github.com/gabime/spdlog.git ./3rdparty/spdlog
git submodule add https://github.com/Skycoder42/QHotkey.git ./3rdparty/QHotkey

clone repositories

两种方式均会 会自动初始化并更新每一个子模块仓库代码

# 方式一
git clone --recursive https://github.com/XMuli/PicShot.git   // 初始化并更新所有子模块

# 方式二
git clone https://github.com/XMuli/PicShot.git
git submodule init
git submodule update

删除子模块

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

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

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

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

git rm --cached 子模块名称