这篇文章主要介绍“git-github子模块仓库更新及git中submodule子模块的添加、使用和删除方法是什么”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“git-github子模块仓库更新及git中submodule子模块的添加、使用和删除方法是什么”文章能帮助大家解决问题。
git submodule背景
项目中经常使用别人维护的模块,在git中使用子模块的功能能够大大提高开发效率。
使用子模块后,不必负责子模块的维护,只需要在必要的时候同步更新子模块即可。
1. git将submodule有关的信息在哪?
git将submodule有关的信息保存在两个地方:
.gitmodules在仓库中,有版本控制,修改之后会同步到其他仓库,使用submodule相关命令的时候会自动更新
.git/config在本地,需要手动更新,或者执行git submodule sync将新的配置从.gitmodules拷贝到.git/config
git submodule sync会将submodule远程的 url 配置设置到.gitmodules,并且只会影响.git/config已经有 url 的条目,指定–recursive,将会递归更新注册的submodule
2. 子模块的添加
添加子模块非常简单,命令如下:
git submodule add
其中,url为子模块的路径,path为该子模块存储的目录路径。
执行成功后,git status会看到项目中修改了.gitmodules,并增加了一个新文件(为刚刚添加的路径)
git diff --cached查看修改内容可以看到增加了子模块,并且新文件下为子模块的提交hash摘要
git commit提交即完成子模块的添加
3. 子模块仓库更新
github 子模块多仓库代码更新。
git submodule sync
git submodule update --init
当使用git clone下来的工程中带有submodule时,初始的时候,submodule的内容并不会自动下载下来的,此时,只需执行如下命令:
git submodule init
git submodule update
或:
git submodule update --init --recursive
执行后,子模块目录下就有了源码,再执行相应的makefile即可。
子模块的更新
子模块的维护者提交了更新后,使用子模块的项目必须手动更新才能包含最新的提交。
在项目中,进入到子模块目录下,执行 git pull更新,查看git log查看相应提交。
完成后返回到项目目录,可以看到子模块有待提交的更新,使用git add,提交即可。
4. 删除子模块
有时子模块的项目维护地址发生了变化,或者需要替换子模块,就需要删除原有的子模块。
删除子模块较复杂,步骤如下:
rm -rf 子模块目录 删除子模块目录及源码
vi .gitmodules 删除项目目录下.gitmodules文件中子模块相关条目
vi .git/config 删除配置项中子模块相关条目
rm .git/module/* 删除模块下的子模块目录,每个子模块对应一个目录,注意只删除对应的子模块目录即可
执行:git submodule status
linux下执行:
git ls-files --stage | grep 160000
windows下执行:
git ls-files --stage | findstr 160000
执行完成后,再执行添加子模块命令即可,如果仍然报错,执行如下:
git rm --cached 子模块名称
完成删除后,提交到仓库即可。
过程中问题
fatal: Please stage your changes to .gitmodules or stash them to proceed
D:GoWorkssrcmylotus>git rm --cached extern/filecoin-ffi
fatal: Please stage your changes to .gitmodules or stash them to proceed
如果提示Please stage your changes to .gitmodules or stash them to proceed直接删掉.gitmodules文件即可
$ rm ./gitmodules