Git

Git#

配置仓库#

典型工作流程#

工作目录 (Working Directory)：你正在编辑的文件。
暂存区 (Staging Area / Index)：通过 git add 添加的文件，准备下次提交。
版本库 (Repository / HEAD)：通过 git commit 提交后的历史记录。

# 列出所有已配置的远程仓库及其对应的 URL
git remote -v

# 显示所有远程跟踪分支
git branch -r

# 更新指定远程仓库的 URL 地址
git remote set-url <remote> <url>

# 显示工作目录和暂存区的状态 (变更文件列表)
git status

# 显示工作目录与暂存区之间的差异
git diff

# 显示两次特定提交之间的差异对比
git diff HEAD~1 HEAD~2

# 修改最近一次提交的提交信息 (不会创建新的提交)
git commit --amend -m "<message>"

# 基于当前提交创建新分支
git branch <branch>

# 重命名本地分支
git branch -m <old-name> <new-name>

# 安全删除已合并的本地分支
git branch -d <branch>

# 删除远程分支
git push origin --delete <branch>

# 显示当前分支的提交历史 (按时间倒序)
git log

# 逐行显示文件的修改历史 (作者、时间、提交信息)
git blame <filename>

# 将指定提交的更改应用到当前分支
git cherry-pick <commit>

# 将连续多个提交应用到当前分支 (包含首尾提交)
git cherry-pick <first-commit>^..<last-commit>

# 将指定提交合并到当前分支
git merge <commit>

# 将指定分支的所有更改合并到当前分支
git merge <branch>

# 将当前分支的提交在目标分支上重新应用 (变基操作)
git rebase <branch>

# 在当前提交上创建一个新标签
git tag <tag>

# 删除本地标签
git tag -d <tag>

# 将标签推送到远程仓库
git push <remote> <tag>

submodule#

代码提交规范#

类型	说明
`feat`	新功能
`fix`	修复漏洞
`docs`	文档
`style`	格式（不影响代码运行的变动）
`refactor`	重构（不改变功能的代码变动）
`perf`	优化相关，比如提升性能、体验
`test`	增加测试
`chore`	构建过程或辅助工具的变动
`revert`	回滚到上一个版本
`merge`	代码合并
`sync`	同步主线或分支的变动
`typo`	更改一些拼写错误

分支命名规范#

分支类型	命名	说明
主分支	`master` / `main`	对外发布的正式版本，始终保持稳定可发布状态
开发分支	`dev` / `develop`	集成最新功能的开发主线，功能分支的合并目标
功能分支	`feature/<feature-name>`	从 `dev` 切出，用于开发新功能，完成后合并回 `dev` 并删除
发布分支	`release/<version>`	从 `dev` 切出，用于发布前的测试与版本冻结，例如 `release/v1.2.0`
修复分支	`fix/<bug-name>`	从 `dev` 切出，用于修复测试阶段发现的普通 BUG
紧急修复分支	`hotfix/<bug-name>`	从 `master` 切出，用于修复线上紧急 BUG，完成后需合并回 `master` 和 `dev`

标签命名规范#

标签命名遵循 主版本号.次版本号.修订号 的规则，例如 v1.2.3 是版本 1.2 的第 4 次修订。以下是版本号的升级规则：

优化已经存在的功能，或者修复 BUG：修订号 +1；
新增功能：次版本号 +1；
架构变化，接口变更：主版本号 +1。

gitignore#

# 忽略特定文件
ModelIndex.xml
ExportedFiles.xml

# [] 匹配包含在 [] 范围内的任意字符
[Mm]odel/[Dd]eployment

# 使用 \ 加空格匹配包含空格的文件或文件夹
Program\ Files

# 忽略名为 hello 的目录和该目录下的所有文件，但是不会匹配名为 hello 的文件
hello/

# 忽略名为 hello 的文件
hello

# 忽略名为 b 的文件，该文件在文件夹 a 下，且该文件的路径为 a/b 或 a/任意路径/b
a/**/b

# 强制包含指定文件夹，* 匹配除了 / 之外任意数量的任意字符串
!Model/Portal/*/SupportFiles/[Bb]in/

# 强制包含指定文件，? 匹配除了 / 之外的任意一个字符
!Model/Portal/PortalTemplates/?/SupportFiles/[Bb]in

在 shell 中显示 git 分支#

Linux

方法一：使用 romkatv/gitstatus 提供的服务：

git clone --depth=1 https://github.com/romkatv/gitstatus.git ~/gitstatus
echo 'source ~/gitstatus/gitstatus.prompt.sh' >> ~/.bashrc
source ~/.bashrc

方法二：打开 ~/.bashrc 做如下修改：

# display git branch on bash
git_branch() {
branch="`git branch 2>/dev/null | grep "^\*" | sed -e "s/^\*\ //"`"
if [ "${branch}" != "" ];then
    if [ "${branch}" = "(no branch)" ];then
        branch="(`git rev-parse --short HEAD`...)"
    fi
    echo -e ":\033[01;32m$branch\033[00m"
fi
}

PS1="${PS1}\$(git_branch) " # 补充到 PS1 变量上（赋值时等号两侧不能有空格）

Windows

Post Git 提供了显示 Git 分支的功能，安装 Posh Git，请执行以下步骤：

以管理员身份启动 PowerShell。
修改执行策略以允许脚本运行：
```
Set-ExecutionPolicy RemoteSigned
```
安装 Posh Git 模块，指定范围为当前用户并强制安装：
```
Install-Module posh-git -Scope CurrentUser -Force
```
导入 Posh Git 模块以便使用：
```
Import-Module posh-git
```
将 Posh Git 添加到 PowerShell 配置文件中，以便对所有会话有效：
```
Add-PoshGitToProfile -AllHosts
```

卸载 Posh Git，请执行以下步骤：

以管理员身份运行 PowerShell。
删除 Posh Git 模块：
```
Uninstall-Module posh-git
```
编辑 PowerShell 配置文件以移除 Posh Git 模块的导入命令。打开配置文件：
```
notepad $PROFILE
```
然后，删除文件中包含 Import-Module posh-git 的行。

macOS

brew install romkatv/gitstatus/gitstatus
echo "source $(brew --prefix)/opt/gitstatus/gitstatus.prompt.zsh" >>! ~/.zshrc

brew install powerlevel10k
echo "source $(brew --prefix)/share/powerlevel10k/powerlevel10k.zsh-theme" >>~/.zshrc

# 若 powerlevel10k 没有自动弹出安装字体的程序，需要手动安装字体
brew untap homebrew/cask-fonts
brew update
brew install --cask font-meslo-lg-nerd-font
brew install --cask font-meslo-for-powerlevel10k
sudo atsutil databases -remove
atsutil server -shutdown

# 重启 macOS，然后搜索字体是否成功安装，如果能搜到，说明安装成功了
system_profiler SPFontsDataType | grep -i "MesloLGS NF"

# UI 操作：设置 iTerm2 和 VS Code 的字体样式
iTerm2 -> Settings -> Profiles -> Text -> Font -> MesloLGS NF
Code -> 首选项 -> 设置 -> 搜索 -> Editor: Font Family -> MesloLGS NF, Menlo, Monaco, 'Courier New', monospace

自动补全#

Linux

# 下载 git-completion.bash
wget https://raw.githubusercontent.com/git/git/master/contrib/completion/git-completion.bash

# 将 git-completion.bash 放在服务器上
cp ~/git-completion.bash /etc/bash_completion.d/

# 使 git-completion.bash 生效
. /etc/bash_completion.d/git-completion.bash

# 编辑 /etc/profile 添加如下内容
if [ -f /etc/bash_completion.d/git-completion.bash ]; then
    . /etc/bash_completion.d/git-completion.bash
fi

# 使 /etc/profile 生效
source /etc/profile

Windows

Post Git 提供了自动补全的功能，安装 Posh Git，请执行以下步骤：

以管理员身份启动 PowerShell。
修改执行策略以允许脚本运行：
```
Set-ExecutionPolicy RemoteSigned
```
安装 Posh Git 模块，指定范围为当前用户并强制安装：
```
Install-Module posh-git -Scope CurrentUser -Force
```
导入 Posh Git 模块以便使用：
```
Import-Module posh-git
```
将 Posh Git 添加到 PowerShell 配置文件中，以便对所有会话有效：
```
Add-PoshGitToProfile -AllHosts
```

卸载 Posh Git，请执行以下步骤：

以管理员身份运行 PowerShell。
删除 Posh Git 模块：
```
Uninstall-Module posh-git
```
编辑 PowerShell 配置文件以移除 Posh Git 模块的导入命令。打开配置文件：
```
notepad $PROFILE
```
然后，删除文件中包含 Import-Module posh-git 的行。

制作补丁#

git format-patch 是 Git 推荐使用的补丁制作工具。与 diff 相比，它生成的补丁包含作者信息、提交时间、提交日志等元数据，更适合在协作开发中使用。

# （推荐）生成最近 n 次提交的补丁
git add <files>
git commit -m "Bump iperf3 from 3.20 to 3.21"
git format-patch -1                              # 最近 1 次提交
git format-patch -2                              # 最近 2 次提交

# （推荐）生成指定 commit 的补丁（仅包含该 single commit）
git format-patch -1 <commit_id>

# （推荐）生成两个 commit 之间的所有补丁
git format-patch <since_commit>..<until_commit>  # since～until 之间的提交
git format-patch <since_commit>..                # since 之后的所有提交

# （推荐）生成当前分支相对于 master 的独特提交
git format-patch master                          # 当前分支比 master 多的提交

# （可选）将所有补丁合并成一个文件（⚠️ 可能丢失邮件线索信息）
git format-patch master --stdout > all-changes.patch

# （补充）纯 diff 风格补丁（不推荐，仅作对比）
git diff > patch.diff                            # 对已 track 的文件制作补丁
git diff <old_file> <new_file> > patch.diff      # 对未 track 的文件制作补丁

Tip

git format-patch 生成的补丁文件默认命名格式为 0001-commit-subject.patch，文件名按提交顺序自动编号，便于批量应用。

应用补丁#

使用 git am（apply mailbox）应用 format-patch 生成的补丁，可以完整保留作者、提交时间、提交日志等信息。

# 应用单个补丁
git am 0001-fix-bug.patch

# 应用目录下所有补丁（按文件名顺序）
git am *.patch

# 应用时遇到冲突，解决后继续
git add . && git am --resolved

# 跳过当前有冲突的补丁
git am --skip

# 放弃本次应用操作
git am --abort

应用传统 diff 补丁（不推荐）

# （单文件打补丁）patch.diff 必须包含文件名，根据文件名应用补丁
patch < patch.diff

# （多文件打补丁）patch.diff 必须包含文件名，根据文件名应用补丁
cd <project_dir>
patch -p1 < patch.diff  # p1 表示忽略第 1 级目录，即 <project_dir>

# （多文件打补丁）patch.diff 必须包含文件名，根据文件名应用补丁
cd <project_dir>/..
patch -p0 < patch.diff

# 对指定文件应用补丁
patch path/to/file < patch.diff

# 对 input_file 应用补丁，但是将应用补丁后的结果写入 output_file
patch path/to/input_file -o path/to/output_file < patch.diff

# 反向应用补丁，即将打过补丁的文件还原
patch -R < patch.diff

Note

关于 -p<n> 参数的含义（忽略 n 级目录）

以 format-patch 生成的补丁头部为例：

--- a/src/module/test.c
+++ b/src/module/test.c

目录层级解析：

不同参数的行为：

patch -p0：使用完整路径 a/src/module/test.c
patch -p1：去掉 a/，在当前目录找 src/module/test.c
patch -p2：去掉 a/src/，在当前目录找 module/test.c

Tip

使用 git am 应用补丁时无需关心 -p 参数，系统会自动处理路径信息。

format-patch vs diff

特性	`git format-patch`	`git diff`
作者信息	包含	不包含
提交时间	包含	不包含
提交日志	包含	不包含
提交 SHA	包含	不包含
应用后生成独立提交	`git am` 自动生成	需手动 `git commit`
多补丁排序	自动编号	需手动管理
适用场景	开源协作、邮件审阅、代码合入	临时对比、本地快速同步

Tip

通用原则：

推荐：只要是传送给别人的补丁，优先使用 git format-patch + git am 流程
可选：仅自己临时记录改动，或补丁只用于单个文件同步时，可以考虑 git diff + patch

公私仓库分离#

私有仓库会合入自己的代码，但是仍然需要和公开仓库保持同步。

# 一次性配置
git remote set-url origin git@gitee.com:zhyantao/stm32mp157-m4.git
git remote add upstream https://gitee.com/weidongshan/stm32mp157-m4.git

# 拉取官方最新
git fetch upstream

# 切到你的工作分支
git checkout master

# 方式 A：合并（保留分叉历史，产生 merge commit）
git merge upstream/master

# 方式 B：变基（历史线性，但会重写你的提交 SHA）
# git rebase upstream/master

# 推送
git push origin master

Git

Contents