git如何设置子模块

目录

---

Git子模块是一个独立的Git仓库，它嵌入到另一个Git仓库中，作为子目录存在。这让你可以在不同的项目中使用同一个库，而不需要在每个项目中都保存一份副本。

设置子模块的步骤如下：

1. 在主仓库中添加子模块

   git submodule add <子模块仓库的URL> <子模块目录>
   

   例如，如果你想将名为"example-submodule"的仓库作为子模块添加到名为"libs"的目录中，你可以这样做：

   git submodule add https://github.com/username/example-submodule.git libs/example-submodule
   

   之后，记得将子模块目录添加到.gitignore文件中，以避免每次提交主仓库时将子模块的更改包含进去。

2. 查看子模块的状态
   添加子模块后，Git会将子模块的仓库克隆到父仓库中，并自动建立一个指向子模块仓库的引用。你可以通过以下命令查看子模块的状态：

   git submodule status
   

3. .gitmodules文件
   子模块的文件将会存储在父仓库的.gitmodules文件中。如果你希望将.gitmodules文件添加到版本控制中，可以执行以下命令：

   git add .gitmodules
   

   .gitmodules格式如下

   [submodule "XWatcher"]
   	path = XWatcher
   	url = git@github.com:QuantFabric/XWatcher.git
   [submodule "XTrader"]
   	path = XTrader
   	url = git@github.com:QuantFabric/XTrader.git
   [submodule "XServer"]
   	path = XServer
   	url = git@github.com:QuantFabric/XServer.git
   

4. 提交更改

   git commit -m “Add submodule”
   

5. 初始化子模块

   git submodule init
   

6. 更新子模块

   git submodule update 
   

   或者你可以用一条命令完成初始化和更新：

   git submodule update --init
   

7. 克隆带有子模块的仓库

   当克隆包含子模块的仓库时，需要使用以下命令来递归地克隆子模块：

   git clone --recurse-submodules <repository-url>
   或者
   git clone --recursive <repository-url>
   

8. 更新子模块

   在已经克隆的仓库中，可以使用以下命令来更新子模块：

   git submodule update --init --recursive
   

9. 如果已经克隆了父仓库，但是没有包括子模块，可以通过以下命令来初始化子模块

   git submodule init
   git submodule update
   

   第一条命令会初始化父仓库中的子模块，第二条命令会将子模块的内容检出到父仓库中。