【Git】一文教你学会 submodule 的增、查、改、删

添加子模块

bash 复制代码
$ git submodule add <url> <path>
  • url 为想要添加的子模块路径
  • path 为子模块存放的本地路径

示例,添加 r-tinymaix 为子模块到主仓库 ./sdk/packages/online-packages/r-tinymaix 路径下,命令如下所示:

bash 复制代码
$ git submodule add https://github.com/RiceChen0/r-tinymaix.git ./sdk/packages/online-packages/r-tinymaix

等命令执行完毕后,在本地路径就可以看到子模块内容了:

此时报了一个警告:

bash 复制代码
warning: in the working copy of '.gitmodules', LF will be replaced by CRLF the next time Git touches it

这是因为在文本处理中,Windows平台中使用 CR/LF(回车/换行)作为换行符,Linux平台中仅使用 LF(换行)作为换行符,这个问题可以通过以下方式解决:

bash 复制代码
$ git config --global core.autocrlf true

查看子模块

bash 复制代码
$ git submodule

可以看到子模块信息:

bash 复制代码
c5029b773b0511d32cca78275b7c8f1fb5eb34a8 sdk/packages/online-packages/r-tinymaix (heads/main)

修改子模块

子模块独立于主仓库,当子模块需要修改时,需要进入子模块文件夹,按照子模块版本控制体系修改提交代码。

更新子模块

bash 复制代码
$ git submodule update

提交子模块

查看仓库状态:

bash 复制代码
$ git status

可以看到有新文件添加进来:

这里我自己添加了一个 Sconscript 文件,将它也添加进来,执行命令:

bash 复制代码
$ git add .

提交到仓库、推送到远端:

bash 复制代码
$ git commit -m "add r-tinymaix" 
$ git push origin HEAD:master

博主仓库没有远端,就不 push 了~

删除子模块

简单粗暴式

  • 删除 .gitmodules 文件中子模块相关条目:
  • 删除 .git/config 配置项中子模块相关条目:
  • 删除 .git/module/ 目录下子模块相关内容:
  • 删除子模块目录及源码:

官方优雅式

  • 根据官方文档,使用卸载子模块命令:
bash 复制代码
$ git submodule deinit sdk/packages/online-packages/r-tinymaix

如果添加上参数 -f,则子模块工作区内即使有本地的修改,也会被移除:

此操作是在 .git/config 配置项中删除了子模块相关条目:

  • 执行 rm 命令:
bash 复制代码
git rm  sdk/packages/online-packages/r-tinymaix

此操作为移除 sdk/packages/online-packages/r-tinymaix 文件夹,并自动在 .gitmodules 中删除了 r-tinymaix 子模块相关内容:

但是此时 .git/module/ 目录下子模块相关内容还有残余,可自行删除:

更多内容

相关推荐
qcx2320 小时前
【AI Engineering · Harness 系列】02 确定性外壳 × 非确定性内核——git push 红线的故事
人工智能·git·prompt·agent·engineering·harness
水云桐程序员20 小时前
10 分钟 Git 上手教程
git
Dontla20 小时前
Git三个主要区域介绍(工作区Working Directory、暂存区Index/Staging Area、仓库区Repository)
git
她说可以呀21 小时前
git在Ubuntu的下载和配置用户
git·ubuntu
隔窗听雨眠21 小时前
Git二分法精准定位Bug
git·bug·git bisect
weixin_704266051 天前
IDEA 整合 Git 并上传代码到 CSDN GitCode 超详细教程
git·intellij-idea·gitcode
芝士就是力量啊 ೄ೨1 天前
Git使用教程(如何使用VSCode+Git+Gitee对项目进行版本控制)
git·vscode·gitee
OYangxf1 天前
Git工作流用法
git
___波子 Pro Max.1 天前
Git Remote 仓库地址变更
git
ModestCoder_2 天前
Git 忽略所有 `.xlsx`,但保留指定 Excel 文件的方法
git·excel