【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/ 目录下子模块相关内容还有残余,可自行删除:

更多内容

相关推荐
lingchen190615 分钟前
版本控制 Git源代码项目管理
git
虫无涯24 分钟前
Coverity 如何结合 GJB8114-2013使用?
git·单元测试·嵌入式测试·coverity·静态扫描
喵本喵叁肆4 小时前
Git 深度解读:从对象模型到分支指针,把版本控制的内核讲透
git
阿钱真强道1 天前
课时00 嵌入式技术应用设计实训 | 开发环境搭建与开发板认识
git·hal库·keil·vs code·开发环境搭建·stm32f103·st-link
老李IT笔记2 天前
激活锁状态怎么检测:三个入口,四种返回值,一份排查顺序
git·智能手机·github
Joecien2 天前
【2026实测】百炼 CLI 托管 Agent 教程:bl managed-agent 配置校验、版本回滚与变更预演(附完整命令)
人工智能·git·阿里云·知识图谱·agi
行者-全栈开发2 天前
【码动四季·秋】从 commit 到发版全自动:Conventional Commits + semantic-release 发布流水线实战
git·ci/cd·自动化发布·atomgit·semantic-releas·语义化版本自动化·git 提交规范落地
Flynt3 天前
Claude Code 103 秒删掉 4.8 万个文件之后,我把自己的仓库"删"了一遍:git 能救的比你想的少
git·ai编程·claude
csdn2015_3 天前
git 可以修改已经push上去的commit说明吗
git