git submodule 完整用法整理

1.先來個官方的API

git submodule [--quiet] add [<options>] [--] <repository> [<path>]
git submodule [--quiet] status [--cached] [--recursive] [--] [<path>…​]
git submodule [--quiet] init [--] [<path>…​]
git submodule [--quiet] deinit [-f|--force] (--all|[--] <path>…​)
git submodule [--quiet] update [<options>] [--] [<path>…​]
git submodule [--quiet] summary [<options>] [--] [<path>…​]
git submodule [--quiet] foreach [--recursive] <command>
git submodule [--quiet] sync [--recursive] [--] [<path>…​]
git submodule [--quiet] absorbgitdirs [--] [<path>…​]

看完后其實也差不多明白了，比其他git命令多了個 submodule 關鍵字，先不看submodule命令，有submodule的倉庫在當前目錄會有個**.gitmodules**文件。記錄path和url，如下。這里表明你引用的多少個子模塊

[submodule "test"]
	path = test
	url = http://github.com/demo/test.git

還有一處改動在 vi .git/config查看，如下

[core]
        repositoryformatversion = 0
        filemode = false
        bare = false
        logallrefupdates = true
        symlinks = false
        ignorecase = true
        autocrlf=false
[remote "origin"]
        url = url....
        fetch = +refs/heads/*:refs/remotes/origin/*
[branch "master"]
        remote = origin
        merge = refs/heads/master
[submodule "ssl"]
        active = true
        url = url....

 

上面的所有的命令基本都基於此處兩個文件的配置來生效的。

2.解析git命令

常用命令如下

git clone <repository> --recursive  //遞歸的方式克隆整個項目
git submodule add <repository> <path> //添加子模塊
git submodule init //初始化子模塊
git submodule update //更新子模塊
git submodule foreach git pull  //拉取所有子模塊

2.1創建帶子模塊的版本庫

例如我們要創建如下結構的項目

project
  |--moduleA
  |--readme.txt

創建project版本庫，並提交readme.txt文件

git init --bare project.git
git clone project.git 
cd project1
echo "This is a project." > readme.txt
git add *
git commit -m "add readme.txt"
git push origin master
cd ..

創建moduleA版本庫，並提交a.txt文件

git init --bare moduleA.git
git clone moduleA.git 
cd moduleA1
echo "This is a submodule." > a.txt
git add *
git commit -m "add a.txt"
git push origin master

在project項目中引入子模塊moduleA，並提交子模塊信息

cd project1
git submodule add ../moduleA.git moduleA
git status
git diff
git add*
git commit -m "add submodule"
git push origin master

使用git status可以看到多了兩個需要提交的文件，其中.gitmodules指定submodule的主要信息，包括子模塊的路徑和地址信息，moduleA指定了子模塊的commit id，使用git diff可以看到這兩項的內容。這里需要指出父項目的git並不會記錄submodule的文件變動，它是按照commit id指定submodule的git header，所以.gitmodules和moduleA這兩項是需要提交到父項目的遠程倉庫的。

On branch master
Your branch is up-to-date with 'origin/master'.
Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)
    new file:   .gitmodules
    new file:   moduleA

###2.2 克隆帶子模塊的版本庫
方法一，先clone父項目，再初始化submodule，最后更新submodule，初始化只需要做一次，之后每次只需要直接update就可以了，需要注意submodule默認是不在任何分支上的，它指向父項目存儲的submodule commit id。

git clone project.git project2
cd project2
git submodule init
git submodule update

方法二，采用遞歸參數–recursive，需要注意同樣submodule默認是不在任何分支上的，它指向父項目存儲的submodule commit id。

git clone project.git project3 --recursive

2.3修改子模塊

修改子模塊之后只對子模塊的版本庫產生影響，對父項目的版本庫不會產生任何影響，如果父項目需要用到最新的子模塊代碼，我們需要更新父項目中submodule commit id，默認的我們使用git status就可以看到父項目中submodule commit id已經改變了，我們只需要再次提交就可以了。

cd project1/moduleA
git branch
echo "This is a submodule." > b.txt
git add *
git commit -m "add b.txt"
git push origin master
cd ..
git status
git diff
git add *
git commit -m "update submodule add b.txt"
git push origin master

2.4更新子模塊

更新子模塊的時候要注意子模塊的分支默認不是master。

方法一，先pull父項目，然后執行git submodule update，注意moduleA的分支始終不是master。

cd project2
git pull
git submodule update

方法二，先進入子模塊，然后切換到需要的分支，這里是master分支，然后對子模塊pull，這種方法會改變子模塊的分支。

cd project3/moduleA
git checkout master
cd ..
git submodule foreach git pull

5. 刪除子模塊
   網上有好多用的是下面這種方法

git rm --cached moduleA
rm -rf moduleA
rm .gitmodules
vim .git/config

刪除submodule相關的內容，例如下面的內容

[submodule "moduleA"]
      url = /Users/nick/dev/nick-doc/testGitSubmodule/moduleA.git

然后提交到遠程服務器

git add .
git commit -m "remove submodule"

但是我自己本地實驗的時候，發現用下面的方式也可以，服務器記錄的是.gitmodules和moduleA，本地只要用git的刪除命令刪除moduleA，再用git status查看狀態就會發現.gitmodules和moduleA這兩項都已經改變了，至於.git/config，仍會記錄submodule信息，但是本地使用也沒發現有什么影響，如果重新從服務器克隆則.git/config中不會有submodule信息。

git rm moduleA
git status
git commit -m "remove submodule"
git push origin master

3.問題

git submodule update出現此問題，是因為終端用的不是windows自帶的cmd，用自帶的cmd打開執行此命令即可

 

 

===========

/新建文件夾demo1 mkdir demo1 //進入將要創建的倉庫 cd demo1 //初始化倉庫 git init 

添加子倉庫

git submodule add url 

把url替換成你想添加的子倉庫；執行成功后，可以在demo1文件夾下看到.gitsubmodule文件

 

推送到遠程倉庫

在推送到遠程倉庫前，我們還要給本地倉庫添加一個遠程倉庫地址,可以到git.oschina 或github上創建

//添加遠程倉庫地址 git remote add origin https://....git //origin 是該遠程倉庫在本地的別名，可自定義。 //添加所有文件到緩存 git add . //提交到本地倉庫 git commit -m "first commit" //推送到遠程倉庫 git push origin master //master是分支名稱

子倉庫的常用操作。

//回到demo1的上級目錄 cd .. //克隆倉庫到demo2 git clone https://....git demo2 //demo2為指定的文件夾，也可以不指定。 

克隆帶子倉庫的倉庫

克隆主倉庫后，子倉庫是沒有代碼的，所以繼續

初始化子倉庫

git submodule init 

克隆子倉庫代碼。

git submodule update
此時可以看到在下載子倉庫代碼了