git如何引用子模块

如何创建子模块

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

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

步骤

  1. 在repository根目录下面执行
$ git submodule add <depend-module-url>/<depend-module-name>.git

如果需要执行branch或者tag:

$ git submodule add -b <branch-name> <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>一样,也可以不一样;但通常用一样,便于阅读。
  1. 结果是什么
  • 根目录下生成一个.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查看到这两个文件的状态。

  1. 后续如果迁出代码
  • 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

最后,如何删除一个模块的使用:

  1. 删除.gitmodules文件里对应的模块内容
    如果.gitmodules只有一个模块,则把整个文件删除即可。
  2. 删除.git/config文件里对应的模块内容
  3. git rm --cached <path-to-submodule>
  4. rm -rf .git/modules/<path-to-submodule>
  5. rm -rf <path-to-submodule> # 删除模块文件内容

最后把所有的改动commit就行啦。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,036评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,046评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,411评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,622评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,661评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,521评论 1 304
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,288评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,200评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,644评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,673评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,281评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2 355