git 应用总结与提高

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

#-------设置全局邮箱地址和用户名-------
git config --global user.email "o2o@qq.com"  #【重置】全局邮箱地址（--global 表示设置全局参数。当不加此选项时，表示对象是当前所在仓库参数）
git config --global user.name "o2ospring"    #【重置】全局用户名　（--global 表示设置全局参数。当不加此选项时，表示对象是当前所在仓库参数）

#git config --global user.email              #【查看】全局邮箱地址（--global 表示设置全局参数。当不加此选项时，表示对象是当前所在仓库参数）
#git config --global user.name               #【查看】全局用户名　（--global 表示设置全局参数。当不加此选项时，表示对象是当前所在仓库参数）
#git config --global -l                      #【查看】全局配置参数（--global 表示设置全局参数。当不加此选项时，表示对象是当前所在仓库参数）
#git config --global --edit                  #【编辑】全局配置参数（--global 表示设置全局参数。当不加此选项时，表示对象是当前所在仓库参数）
#git config --global credential.helper cache #【缓存】用户名和密码（当频繁通过 HTTPS 操作远程仓库，可避免每次重复输入凭证，除非凭证过期或终端关闭）
#git config --global credential.helper 'cache --timeout=1800'
                                             #【修改】缓存有效期为 30 分钟（默认缓存 15 分钟）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

#-------克隆所有分支-------
                                  #【方式一】克隆远程仓库所有分支（SSH 方式）（注意：使用 SSH 克隆之前先要添加 SSH key，具体操作后面再介绍，所以暂不推荐这种方式）
git clone git@github.com:espressif/esp-idf.git
                                  #【方式二】克隆远程仓库所有分支（http方式）（如果忘记拉取子模块，则可以使用 git submodule update --init --recursive 命令补救）
git clone https://github.com/espressif/esp-idf.git
                                  #〖情形二〗当远程仓库有嵌套仓库时，克隆所有分支的同时，同步拉取嵌套仓库
git clone --recursive https://github.com/espressif/esp-idf.git
                                  #〖情形三〗同上，并且将本地工作区自动切换到`release/v5.1`分支（备注：`release/v5.1`是分支名称，`/`仅作为名称字符的一部分）
git clone --recursive -b release/v5.1 https://github.com/espressif/esp-idf.git

#git checkout -b aaaa origin/aaaa # 基于【远程跟踪分支】创建并切换到新的本地分支，同时建立跟踪关系（注：不会从远程仓库拉取数据）（貌似 git checkout aaaa 也会自动处理）
                                  #【远程跟踪分支】：是已从远程仓库同步到本地的分支。例如：克隆整个远程仓库，除当前分支外，其它分支还处于隐藏状态，需要通过上行命令检出

1
2
3
4
5

#-------克隆单个分支-------
                                  #〖情形一〗仅克隆远程仓库中指定的`release/v5.1`分支，不会下载其他任何分支（备注：`release/v5.1`是分支名称，`/`仅作为名称字符的一部分）
git clone --single-branch -b release/v5.1 https://github.com/espressif/esp-idf.git
                                  #〖情形二〗同上，当远程仓库有嵌套仓库时，克隆指定分支的同时，同步拉取嵌套仓库
git clone --recursive --single-branch -b release/v5.1 https://github.com/espressif/esp-idf.git

1
2
3

#-------设置当前仓库的邮箱地址和用户名-------
git config user.email "xxx@qq.com"#【设置】当前仓库的邮箱地址（备注：当不单独设置时，将默认使用全局配置的邮箱地址和用户名）
git config user.name "xiaoming"   #【设置】当前仓库的用户名　（备注：当不单独设置时，将默认使用全局配置的邮箱地址和用户名）

1
2
3
4
5
6
7

#-------本地新建仓库-------
git init --initial-branch=main    #【新建】一个空的全新的本地仓库。（git init 不指定名称时，可能是 master，因其有种族歧视性，所以很多厂家改用 main）
git config user.email "xxx@qq.com"#【设置】当前仓库的邮箱地址（备注：当不单独设置时，将默认使用全局配置的邮箱地址和用户名）
git config user.name "xiaoming"   #【设置】当前仓库的用户名　（备注：当不单独设置时，将默认使用全局配置的邮箱地址和用户名）
touch README.md                   #【添加】一个读我文件（一般情况下仓库都应有一个<README.md>文件作为工程的介绍）
git add .                         #【添加】工作区文件到【暂存区】。（可以重复添加多次，也可以添加一个或多个指定文件，如：git add test.c 添加指定文件）
git commit -m "first commit"      #【提交】暂存区文件到【本地库】。（first commit 是提交的文字说明）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

#-------添加过滤规则-------
touch .gitignore                  #【创建】一个忽略规则文件
                                  # 使用文本编辑工作添加需要忽略的文件(夹)，例如：
                                  # *.o               #忽略 *.o 文件。即 git 不管理当前目录及其下面所有层级的 *.o 文件
                                  # output2/          #忽略 output2 目录。即 git 不管理 output2 这个文件夹，意味着其里面所有内容也被忽略，同时表明它下面文件(夹)不能使用`!`来指定某些文件(夹)解除忽略
                                  # output/*          #忽略 output 目录下的所有文件和目录 -----------\
                                  # !output/abc/      #但是，不要忽略 output/abc/ 这个目录 ----------|--> 配合使用
                                  # !output/abc/**/*  #并且，不要忽略 output/abc/ 目录下的所有内容 --/
                                  #                   #其中，** 表示递归所有子目录，例如包括孙目录。
                                  # 如果不使用文本编辑工具，可以使用命令初始添加忽略规则内容，例如：
#echo -e "*/build/*\n*JLinkLog.txt\n*.o\n*.d\n*.a\n*.i\n*.map\n*.elf\n*.bin\n*.hex\n*.axf\n*.crf\n*.bak\n*.dep\n*.rar\n*.zip\n*.7z" >> .gitignore

1
2
3
4
5
6

#=======【方式一】关联子仓库〖版本链接〗=======
                                  #【添加】子模块【指定分支】到【指定目录】src/cjson/（会自动创建目录）
git submodule add -b master https://github.com/DaveGamble/cJSON.git src/cjson    #【备注】紧接着可以进入子模块目录执行 git checkout <指定版本>，如 v1.7.16 或 commit ID
git commit -m "add submodule"     #【提交】父仓库的子模块引用变更（必须及时提交，中途不能做其它操作）
#cat .gitmodules                  #〖查看〗子模块列表　　　　　　（用于验证是否成功添加）
#cat .git/config                  #〖查看〗父仓库配置及子模块列表（用于验证是否成功添加）

1
2
3
4

#=======【方式二】整合子仓库〖版本代码〗=======
                                  #【添加】子树【指定分支】到【指定目录】src/cjson/（会自动创建目录）（--prefix= 本地路径，简写"-P "；--squash 压缩成一个提交）
git subtree add --prefix=src/cjson https://github.com/DaveGamble/cJSON.git master --squash  #本命令会自动整合并提交
                                  #【如何】指定子树版本？将 "分支名"（如 master）直接替换为 "标签"（Tag，如 v1.7.18）或 "提交哈希"（SHA，如 a1b2c3d）即可

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

#-------关联远程仓库-------
                                  #【关联】远程仓库（实际是为网址起个别名，即 origin（系统默认别名）代表 https://github.com/espressif/esp-idf.git 这个网址）
git remote add origin https://github.com/espressif/esp-idf.git
#git remote add gitee https://gitee.com/espressif/esp-idf.git  #可以关联多个远程仓库，别名叫 gitee

#-------后续维护：常规操作-------
#git remote -v                    #【查看】所有远程仓库别名与网址
#git remote rm origin             #【移除】远程仓库（移除 origin 对应的网址）
#git remote add origin https://gitee.com/espressif/esp-idf.git 
                                  #【关联】远程仓库（前面先移除，后面新关联，即是实现更改远程仓库关联。当然也可用下面 set-url 更改）
#git git remote set-url origin https://gitee.com/espressif/esp-idf.git 
                                  #【更改】远程仓库（更改 origin 对应的网址）（也可使用 git config -e 直接更改里面的URL）
#git remote add origin git@gitee.com:espressif/esp-idf.git 
                                  #【关联】远程仓库（使用 SSH 协议方式）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

#-------查看提交历史-------
git log                           #【查看】提交历史（如果很多信息时，按 f/b 键表示向前/向后翻页， 按 j/k 键表示向前/向后翻行，按 q 键后退出查看）
#git log --oneline                #【查看】提交历史，并且以“一个版本一行”的精简方式显示。
#git log origin/main              #【查看】远程跟踪分支的提交信息
#git log develop..origin/develop  #【查看】远程跟踪分支比当前指定分支多出的提交信息（待合并的变更）
git reflog                        #【查看】操作历史（例如：分支改名、提交代码等）, 核心用途分析一些人为误操作。（默认保留 90 天，过期后会被清理）
#git reflog --date=iso            #【查看】操作历史，并且显示时间戳（当紧接在 reflog 后面加 show master 表示查看指定分支 master）
git status                        #【查看】当前分支的【暂存区+工作区】的文件(夹)状态（与本地仓库（HEAD 指针指向的提交）的状态差异比较）
                                  # staged  (已暂存) <- 暂存区的文件状态
                                  # untrack (未跟踪) <- 工作区的文件状态
                                  # modified(已修改) <- 工作区的文件状态

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

#-------当远程仓库为刚新建时-------
git push -u origin main           #【推送】本地仓库到【远程仓库】（-u 选项仅在首次向新创建的远程仓库或新分支推送代码时才添加，-u 是 --set-upstream 简写）
                                  # 如果推送所有分支，则 main 改为 --all 即可。如果还有标签，则 git push -u origin --tags 推送所有标签
#-------当本地进行修改代码时-------
git add .                         #【添加】工作区文件到【暂存区】（. 表示当前目录及其下级所有文件(夹)，当然也可以添加指定文件，例如：git add README.md）
git commit "fixed bug"            #【提交】暂存区文件到【本地库】（fixed bug 是提交的文字说明）
git pull origin main              #【拉取+合并】自远程仓库最新代码（合并远程仓库和本地仓库两者的最新代码，为推送到远程仓库准备）
git push origin main              #【推送】到远程仓库（推送 main 分支）

#-------临时缓存用户名和密码-------
git config --global credential.helper cache  #【缓存】用户名和密码（当频繁通过 HTTPS 操作远程仓库，可避免每次重复输入凭证，除非凭证过期或终端关闭）
#git config --global credential.helper 'cache --timeout=1800' #【修改】缓存有效期为 30 分钟（默认缓存 15 分钟）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

#-------当发现提交内容有误时-------
git commit --amend                #〖情形一〗当你刚提交就发现描述内容有误，此时可运行本命令修改描述内容（备注：版本号将重新生成并覆盖原有ID）

git add .                         #〖情形二〗当你刚提交就发现代码内容有误，修改后即可重新添加并提交代码（备注：版本号将重新生成并覆盖原有ID）
git commit --amend --no-edit

sudo gedit .gitignore             #〖情形三〗当你发现一些文件(夹)漏了忽略，则先用文本编辑工具增加忽略规则，再执行下面命令移除追踪并提交新版本记录
git rm --cached *.o               # 从 git 的数据库中删除对于【该类文件】的追踪记录
git rm --cached -r output/        # 从 git 的数据库中删除对于【该文件夹】的追踪记录
git add --all                     # 添加修改（git add --all 表示整个仓库，git add . 表示当前目录及其下级所有文件(夹)）
git commit -m "new ignore rule"   # 提交修改

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

#-------【回滚】到指定的某个版本-------
git revert 7dcbadaaa6ad25c       #【回滚】到指定某个旧版本（其之后的新版本会保留下来），然后在弹出窗口编辑提交注释。（7dcbadaaa6ad25c 是版本id，在确保唯一的前提下输入前面7-8位即可）
#git revert HEAD^^               #【回滚】到当前上上一个旧版本（其之后的新版本会保留下来），然后在弹出窗口编辑提交注释。
#git revert -n HEAD~3            #【回滚】到当前倒数第3个旧版本（其之后的新版本会保留下来），但不自动提交到本地仓库，需要手动提交一次。
                                 # -n 表示不自动提交到本地仓库，需要手动 git commit -m "文字说明" 提交一次。

#-------【回退】到指定的某个版本-------
git reset --hard f69c801587af44f #【回退】到指定某个旧版本（其之后的新版本被永久删除），数据无价操作必须要谨慎！（f69c801587af44f 是版本id，在确保唯一的前提下输入前面7-8位即可）
#git reset --hard                #【回退】到最后旧版本（主要目的是为清除【暂存区】和【工作区】没提交的内容。如果清除不彻底，可接着运行 git clean -dfx 删除未跟踪目录和文件（并含 .gitignore 忽略的内容））
#git reset --hard HEAD^          #【回退】到当前上一个旧版本（其之后的新版本被永久删除）。
#git reset --hard HEAD^^         #【回退】到当前上上一个旧版本（其之后的新版本被永久删除）。
#git reset --hard HEAD~20        #【回退】到当前倒数第20个旧版本（其之后的新版本被永久删除）。
#git reset HEAD                  #【清除】当前【暂存区】add 的内容。
#git reset HEAD -- test.c        #【清除】当前【暂存区】add 的某个文件。
                                 # --soft  修改 HEAD 指针指向，【缓存区】内容【不变】，【工作区】内容【不变】；
                                 # --mixed 修改 HEAD 指针指向，【暂存区】内容【丢失】，【工作区】内容【不变】； <- 默认选项,可不写出来
                                 # --hard  修改 HEAD 指针指向，【暂存区】内容【丢失】，【工作区】内容【恢复】；
#git push -f origin main         #【回退】操作后需要【推送】到远程仓库时，必须加 -f 强制推送，否则会被拒绝（备注：同时托管网站有一个配置开关--是否允许强制推送，例如[gitlab]托管网站解除保护[Setting → Protected Branches → Unprotect]）
                                 #【如果】你仅仅是用旧版本代码进行测试，正确做法是先创建并切换到临时分支，再回退到旧版本！

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

#-------分支的【查看-改名】操作-------
git branch                       #【查看】所处分支（列表中带"*"表示当前所处分支）
git branch -a                    #【查看】全部分支（包括当前分支和【远程跟踪分支】，例如：隐藏的【远程跟踪分支】 origin/abc，显示为红色的 remotes/origin/abc）
git branch -v                    #【查看】所处分支（较细节信息）
git branch -vv                   #【查看】所处分支（更细节信息）
git branch -m bbbb cccc          #【修改】分支名称（将名称 bbbb 改为 cccc）
git branch -m cccc               #【修改】分支名称（将当前分支改名为 cccc）

#-------分支的【创建-删除】操作-------
git branch aaaa                  #【创建】新的分支（名称为 aaaa）（注：只支持一级分支，但名称可以用"/"字符，例如：release/v5.1)
git branch -d aaaa               #【删除】指定分支（如果 -D 表示强制删除）
git push origin -d aaaa          #【删除】远程分支（注意是【远程分支】）
#git checkout -b bbbb            #【创建并跳到】新的分支（名称为 bbbb）

#-------分支的【切换-合并】操作-------
#git clean -dfx                  #【删除】未跟踪目录和文件（并含 .gitignore 忽略的内容），为彻底切换分支准备。（注意：删除的数据不可恢复，必须谨慎操作!）
git checkout develop             #【切换】到指定仓库（名称为 develop）（因某些操作引起 checkout 也未必完全检出全部代码，此时可以使用 git reset --hard 重置代码）
#git checkout f9f86bdd3aafd      #【切换】到指定版本（git checkout 可以切换到指定【分支】【标签】【版本】）
git merge aaaa                   #【合并】指分支到当前分支（将 aaaa 合并到 develop）（merge 后面可加 --no-ff 和 -m "自定义描述说明"，其中 --no-ff 表示禁用 Fast forward）
#git merge --squash aaaa         #【合并】指分支到当前分支，并整合提交信息

#-------分支的【拉取-合并】操作-------
git fetch origin develop         #【获取】远程分支代码和历史
#git log origin/main             #【查看】远程跟踪分支的提交信息
#git log develop..origin/develop #【查看】远程跟踪分支比当前指定分支多出的提交信息（待合并的变更）
#git diff origin/develop         #【比较】远程跟踪分支与当前分支差别（先人工解决冲突，为合并顺利进行准备）（建议使用【小乌龟】可视界面比较）
git merge origin/develop         #【合并】远程跟踪分支到当前分支（origin/develop 合并到 develop）
#git pull origin develop         #【拉取+合并】远程分支到当前分支（git pull 相当于 git fetch + git merge 的默认操作）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

#-------标签的【查看-改名】操作-------
git ls-remote --tags origin            #【列出】远程所有标签
git tag                                #【列出】当前仓库的所有标签
git tag -n                             #【列出】当前仓库的所有标签及说明
git tag -l v1.0.*                      #【列出】当前仓库的相关标签（支持指定标签、支持通配符*过滤）
git show v1.0.1                        #【查看】指定标签信息（可查到commit的版本id，可用于回退操作）
git checkout v1.0.0                    #【切换】到指定标签的代码（只能用于查看代码），提示当前处于 “detached HEAD" 状态，因 tag 相当于一个快照，是不能更改的！
git checkout -b fix-v1.0.0-bug v1.0.0  #【基于】指定标签创建分支（可用于修复老版本）（基于 v1.0.0 标签创建一个 fix-v1.0.0-bug 分支）

#-------标签的【创建-删除】操作-------
git tag -a v1.0.1 -m "测试版"          #【创建】标签：标签名为"v1.0.1"，描述为"测试版"
#git tag v1.0.1                        #【创建】标签：标签名为"v1.0.1"
git tag -a v1.1.0 -m "正式版" 1a2b3c4  #【创建】标签：基于"1a2b3c4"版本创建，标签名为"v1.0.1"，描述为"正式版"
#git tag v1.1.0-beta 1a2b3c4           #【创建】标签：基于"1a2b3c4"版本创建，标签名为"v1.0.1"
git tag -d v1.0.0-beta                 #【删除】本地标签（需先删本地，再推送到远程）─┐
git push origin -d v1.0.0-beta         #【删除】远程标签（需先删本地，再推送到远程）←┘

#-------标签的【推送-拉取】操作-------
git push origin v1.0.0                 #【推送】指定标签到远程仓库（推送 v1.0.0 标签到远程仓库）
#git push origin --tags                #【推送】所有本地标签到远程仓库
git fetch origin v1.0.0                #【获取】指定远程标签（从远程仓库获取 v1.0.0 标签）
#git fetch origin --tags               #【获取】远程所有标签（同时拉取分支更新）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

#-------新增操作：关联子模块〖版本链接〗-------
                                  #【添加】子模块【指定分支】到【指定目录】src/cjson/（会自动创建目录）
git submodule add -b master https://github.com/DaveGamble/cJSON.git src/cjson    #【备注】紧接着可以进入子模块目录执行 git checkout <指定版本>，如 v1.7.16 或 commit ID
git commit -m "add submodule"     #【提交】父仓库的子模块引用变更（必须及时提交，中途不能做其它操作）
#cat .gitmodules                  #〖查看〗子模块列表　　　　　　（用于验证是否成功添加）
#cat .git/config                  #〖查看〗父仓库配置及子模块列表（用于验证是否成功添加）

#-------后续维护：更新子模块-------
cd src/cjson                      #【进入】子模块目录
git pull origin master            #【拉取】子模块远程最新代码（假设子模块分支是 master）（当然也可以 git checkout <指定版本>，如 v1.7.16 或 commit ID）
cd ../..                          #【回到】父仓库根目录（git submodule update --recursive 更新所有子模块，还包括孙模块等，但实际工程子模块不一定都需要最新版本）
git add .                         #【添加】更新代码（. 表示当前目录及其下级所有文件(夹)）
git commit -m "update submodule"  #【提交】父仓库的子模块引用变更（必须及时提交，中途不能做其它操作）
git push origin main              #【推送】到远程父仓库　　　　　（必须及时推送，中途不能做其它操作）

#-------后续维护：删除子模块-------
git submodule deinit src/cjson    #【删除】子模块相关配置信息（当然也可以直接删除 .gitmodules 和 .git/config 里面子模块相关内容）
rm -rf src/cjson                  #【删除】【工作区】子模块文件夹（注意：删除后不可恢复）
rm -rf .git/modules/src/cjson     #【删除】【仓库区】子模块文件夹（注意：删除后不可恢复）（此步可选，当不执行时数据仍可留在父仓库中）
git rm --cached src/cjson         #【删除】仓库对于该文件夹的追踪记录
git add .                         #【添加】更新代码（. 表示当前目录及其下级所有文件(夹)）
git commit -m "remove submodule"  #【提交】父仓库的子模块引用变更（必须及时提交，中途不能做其它操作）
git push origin main              #【推送】到远程父仓库　　　　　（必须及时推送，中途不能做其它操作）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

#-------新增操作：整合子树〖版本代码〗-------
                                  #【添加】子树【指定分支】到【指定目录】src/cjson/（会自动创建目录）（--prefix= 本地路径，简写"-P "；--squash 压缩成一个提交）
git subtree add --prefix=src/cjson https://github.com/DaveGamble/cJSON.git master --squash  #本命令会自动整合并提交
                                  #【如何】指定子树版本？将 "分支名"（如 master）直接替换为 "标签"（Tag，如 v1.7.18）或 "提交哈希"（SHA，如 a1b2c3d）即可
#-------后续维护：更新子树-------
git subtree pull --prefix=src/cjson https://github.com/DaveGamble/cJSON.git master --squash        # ←────────────────────────────┐
git push origin main              #【更新】子树到最新版本（如果因一些特别原因无法更新，建议先〖删除子树〗再重新〖添加子树〗即可） ─┘
                                  #【推送】到远程父仓库　（必须及时推送，中途不能做其它操作）
#-------后续维护：查看子树-------
git subtree split --prefix=src/cjson --branch=cjson #【基于】子树创建分支
git checkout cjson                #【切换】到新建分支　　（基于子树创建的分支）
git log                           #【查看】此分支提交记录（查看子树的提交记录）
git checkout main                 #【切换】回到主分支
git branch -D cjson               #【删除】刚才新建的分支（查看完后删除即可）（-D 表强制删除）

#-------后续维护：删除子树-------
rm -rf src/cjson                  #【删除】此模块
git add .                         #【添加】更新代码（. 表示当前目录及其下级所有文件(夹)）
git commit -m "remove subtree"    #【提交】父仓库的子树引用变更（必须及时提交，中途不能做其它操作）
git push origin main              #【推送】到远程父仓库　　　　（必须及时推送，中途不能做其它操作）