git中submodule子模块的添加、使用和删除

2020-03-06 22:28:05

项目中经常使用别人维护的模块,在git中使用子模块的功能能够大大提高开发效率。


使用子模块后,不必负责子模块的维护,只需要在必要的时候同步更新子模块即可。


本文主要讲解子模块相关的基础命令,详细使用请参考man page。


子模块的添加

添加子模块非常简单,命令如下:


git submodule add <url> <path>


其中,url为子模块的路径,path为该子模块存储的目录路径。


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


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


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


子模块的使用

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


git submodule init

git submodule update

1

2

或:


git submodule update --init --recursive

1

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


子模块的更新

子模块的维护者提交了更新后,使用子模块的项目必须手动更新才能包含最新的提交。


在项目中,进入到子模块目录下,执行 git pull更新,查看git log查看相应提交。


完成后返回到项目目录,可以看到子模块有待提交的更新,使用git add,提交即可。


删除子模块

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


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


rm -rf 子模块目录 删除子模块目录及源码

vi .gitmodules 删除项目目录下.gitmodules文件中子模块相关条目

vi .git/config 删除配置项中子模块相关条目

rm .git/module/* 删除模块下的子模块目录,每个子模块对应一个目录,注意只删除对应的子模块目录即可

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


git rm --cached 子模块名称


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



  • 2017-01-11 08:23:07

    使用jquery.qrcode生成二维码

    二维码应用已经渗透到我们的生活工作当中,您只需要用手机对着二维码“扫一扫”即可获得所对应的信息,方便我们了解商家、购物、观影等等。本文将介绍一款基于jquery的二维码生成插件qrcode,在页面中调用该插件就能生成对应的二维码。

  • 2017-01-16 15:09:40

    Javascript模块化编程(一):模块的写法

    随着网站逐渐变成"互联网应用程序",嵌入网页的Javascript代码越来越庞大,越来越复杂。网页越来越像桌面程序,需要一个团队分工协作、进度管理、单元测试等等......开发者不得不使用软件工程的方法,管理网页的业务逻辑。

  • 2017-01-16 15:16:24

    Javascript模块化编程(二):AMD规范

    AMD是"Asynchronous Module Definition"的缩写,意思就是"异步模块定义"。它采用异步方式加载模块,模块的加载不影响它后面语句的运行。所有依赖这个模块的语句,都定义在一个回调函数中,等到加载完成之后,这个回调函数才会运行。

  • 2017-01-16 15:19:24

    RequireJS 入门指南

    如今最常用的JavaScript库之一是RequireJS。最近我参与的每个项目,都用到了RequireJS,或者是我向它们推荐了增加RequireJS。在这篇文章中,我将描述RequireJS是什么,以及它的一些基础场景。

  • 2017-01-16 15:22:30

    CommonJS规范

    CommonJS模块规范。 根据这个规范,每个文件就是一个模块,有自己的作用域。在一个文件里面定义的变量、函数、类,都是私有的,对其他文件不可见。