Git Submodule的使用

是什么?

submodule子模块,简单来讲就是Git仓库中的子仓库。

想一想是不是遇到过这样的情况,有一个模块是通用的,需要被使用到多个项目;或者你的项目中要使用github上的一个开源模块。这样的模块要怎么在你的项目中保持同步更新甚至是提交呢?答案就是submodule。

怎么用?

1. 新增submodule

git submodule add $giturl $foldername

其中$giturl表示git仓库地址,$foldername表示submodule的目录名,例如:

git submodule add git://github.com/xx/A.git A

注:下面示例全部以 A 当做submodule所在目录

完成后,将文件变化提交即可。

2. clone有submodule的git仓库

git clone $giturl
git submodule init
git submodule update

3. submodule A作者有更新,如何同步到我的项目?

  1. 更新submodule A

     cd A
     git pull
    
  2. 回到主git仓库,查看状态,并提交

     cd ..
     git status
    
     //输出结果有这样的内容,意思是submodule A有修改。add并提交即可
     modified:   A (new commits)
    
     git add .
     git commit -m 'update submodule'
     git push
    
  3. 你的同事或者协作的开发者,如何更新?

     git pull
     git submodule update
    

这个些操作和status的内容一开始可能很难理解,这里要讲一下关于submodule的设计理念:

  • 主git仓库中存在.gitmodules文件,它记录了submodule的基本信息。例如remote地址。
  • 同时在某处记录了主git仓库所用的submodule的commit号。
  • 主git仓库并不同步submodule中的所有代码,而是同步其remote地址和commit号,每个clone都是根据这两个信息自行到remote地址获取到该commit版本的内容。

所以,如果你要更新submodule必须做上面的操作步骤。而你操作完成后,你的git仓库中submodule的commit号得到更新。这样,与你协作的开发者,就可以直接git pull得到最新的submodule commit号,git submodule update获取submodule该commit的代码。

4. 我是主git仓库的开发者,同时也是submodule A的作者,如何在主git仓库修改A并同步?

如果你理解了上面说的设计理念,那么这个操作非常简单。

  1. 修改A目录中的内容

  2. 提交并同步A

     cd A
     git add .
     git commit
     git push
    
  3. 此时,你就处于3.2的状态,按照3.2操作即可。

5. 几个submodule都想更到最新

有个简便操作

    git submodule foreach git pull

这样所有submodule都更到最新了,add commit即可。

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

推荐阅读更多精彩内容