Git Notes

• Workspace：工作区
• Index / Stage：暂存区
• Repository：仓库区（或本地仓库）
• Remote：远程仓库

1 Git 简介

Git 是一个开源的分布式版本控制系统，用于敏捷高效地处理任何或小或大的项目。
Git 是 Linus Torvalds 为了帮助管理 Linux 内核开发而开发的一个开放源码的版本控制软件。
Git 与常用的版本控制工具 CVS，Subversion 等不同，它采用了分布式版本库的方式，不必服务器端软件支持。

Git 与 SVN 区别点：

• Git 是分布式的，而SVN 不是：这是 Git 和其它非分布式的版本控制系统，例如 SVN，CVS 等，最核心的区别。
• Git 把内容按元数据方式存储，而 SVN 是按文件：所有的资源控制系统都是把文件的元信息隐藏在一个类似 .svn、.cvs、.git 等的文件夹里。
• Git 分支和 SVN 的分支不同：分支在 SVN 中一点都不特别，其实它就是版本库中的另外一个目录。
• Git 没有一个全局的版本号，而 SVN 有：目前为止这是跟 SVN 相比 Git 缺少的最大的一个特征。
• Git 的内容完整性要优于 SVN：Git 的内容存储使用的是 SHA-1 哈希算法。这能确保代码内容的完整性，确保在遇到磁盘故障和网络问题时降低对版本库的破坏。

2 Git 基础操作

2.1 Git 安装

Git 目前支持 Linux/Unix、Solaris、Mac和 Windows 平台上运行。
Git 各平台安装包下载地址为：https://git-scm.com/downloads。

2.2 Git 配置

Git的设置文件为 .gitconfig，它可以在用户主目录下（全局配置），也可以在项目目录下（项目配置）。

# 显示当前的 Git 配置
git config --list

# 编辑 Git 配置文件
git config -e [--global]

# 设置提交代码时的用户信息
git config [--global] user.name "[name]"
git config [--global] user.email "[email address]"

2.3 Git 工作流程

一般工作流程如下：

• 克隆 Git 资源作为工作目录。
• 在本地的资源上添加或修改文件。
• 如果其他人修改了，你可以更新资源。
• 在提交前查看修改。
• 提交修改。
• 在修改完成后，如果发现错误，可以撤回提交并再次修改并提交。

下图展示了 Git 的工作流程：

2.4 Git 文件的三种状态

我们先来理解下 Git 工作区、暂存区和版本库概念

• 工作区：就是你在电脑里能看到的目录。
• 暂存区：英文叫 stage，一般存放在 .git 下的 index 文件（.git/index）中，所以我们把暂存区有时也叫作索引（index）。
• 版本库：工作区有一个隐藏目录 .git，这个不算工作区，而是 Git 的版本库。

下面这个图展示了工作区、版本库中的暂存区和版本库之间的关系：

图中左侧为工作区，右侧为版本库。在版本库中标记为 index 的区域是暂存区，标记为 master 的是 master 分支所代表的目录树。

图中我们可以看出此时 HEAD 实际是指向 master 分支的一个“游标”。所以图示的命令中出现 HEAD 的地方可以用 master 来替换。

图中的 objects 标识的区域为 Git 的对象库，实际位于 .git/objects 目录下，里面包含了创建的各种对象及内容。

当对工作区修改（或新增）的文件执行 git add 命令时，暂存区的目录树被更新，同时工作区修改（或新增）的文件内容被写入到对象库中的一个新的对象中，而该对象的ID被记录在暂存区的文件索引中。

当执行提交操作 git commit 命令时，暂存区的目录树写到版本库（对象库）中，master 分支会做相应的更新。即 master 指向的目录树就是提交时暂存区的目录树。

当执行 git reset HEAD 命令时，暂存区的目录树会被重写，被 master 分支指向的目录树所替换，但是工作区不受影响。

当执行 git rm --cached <file> 命令时，会直接从暂存区删除文件，工作区则不做出改变。

当执行 git checkout . 或者 git checkout -- <file> 命令时，会用暂存区全部或指定的文件替换工作区的文件。这个操作很危险，会清除工作区中未添加到暂存区的改动。

当执行 git checkout HEAD . 或者 git checkout HEAD <file> 命令时，会用 HEAD 指向的 master 分支中的全部或者部分文件替换暂存区和以及工作区中的文件。这个命令也是极具危险性的，因为不但会清除工作区中未提交的改动，也会清除暂存区中未提交的改动。

2.5 新建仓库

有两种新建 Git 项目仓库的方法。 第一种是在现有项目或目录下导入所有文件到 Git 中； 第二种是从一个服务器克隆一个现有的 Git 仓库。

1. 在现有目录中初始化仓库

# 初始化仓库
git init

2. 克隆现有的仓库

# 使用 SSH 克隆
git clone git@gitee.com:Auto_SK/Git-Notes.git
 
# 使用 HTTPS 克隆
git clone https://gitee.com/Auto_SK/Git-Notes.git

2.6 添加 / 删除文件

# 添加指定文件到暂存区
git add file1 file2 ...

# 添加指定目录到暂存区，包括子目录
git add dir

# 添加当前目录的所有文件到暂存区
git add .

# 添加每个变化前，都会要求确认
# 对于同一个文件的多处变化，可以实现分次提交
git add -p

# 删除工作区文件，并且将这次删除放入暂存区
git rm file1 file2 ...

# 停止追踪指定文件，但该文件会保留在工作区
git rm --cached file

# 改名文件，并且将这个改名放入暂存区
git mv file-original file-renamed

2.7 代码提交

# 提交暂存区到仓库区
git commit -m "message"

# 提交暂存区的指定文件到仓库区
git commit file1 file2 ... -m "message"

# 提交工作区自上次 commit 之后的变化，直接到仓库区
git commit -a

# add 和 commit 的合并，便捷写法（针对已追踪文件）
git commit -am "message"

# 提交时显示所有 diff 信息
git commit -v

# 使用一次新的 commit，替代上一次提交
# 如果代码没有任何新变化，则用来改写上一次 commit 的提交信息
git commit --amend -m "message"

# 重做上一次 commit，并包括指定文件的新变化
git commit --amend file1 file2 ...

# 查看工作区和暂存区的状态
git status

2.8 代码版本 / 提交切换

1. 查看过去版本/提交

# 提交详情
git log

# 提交简介
git log --pretty=oneline

# 图形化提交
gitk

2. 回退版本/提交

# 回退到当前最新提交
git reset --hard HEAD

# 回退到上次提交
git reset --hard HEAD^

# 回退到上 n 次提交
git reset --hard HEAD~n

# 回退到某次提交
git reset --hard commit_id

3. 重返未来版本

# 查看历史提交以及被回退的提交，注意：该记录有时限，且只在本地
git reflog

# 回到未来版本
git reset --hard commit_id

4. 撤销修改

# 工作区文件撤销 没有提交到暂存区即没有 git add
# 撤销修改
git checkout file

# 暂存区文件撤销
# 将暂存区文件撤销到工作区
git reset HEAD file

# 撤销修改
git checkout file

3 Git 分支管理

1. 新建分支

# 创建分支
git branch branchname

# 创建分支并立即切换到该分支下
git checkout -b branchname

2. 切换分支

# 切换到 branchname 分支
git checkout branchname

3. 删除分支

# 删除 branchname 分支
git branch -d branchname

4. 分支合并

# 合并分支
git merge [branchname]

4 Git 标签

# 添加标签并注释
git tag -a version -m "version_message"

5 远程仓库

1. 生成 SSH Key

在 Terminal 中生成 SSH Key

# 在命令行中生成 SSH Key
ssh-keygen -t rsa -C "youremail@example.com"

后面的 your_email@youremail.com 改为你 Gitee 账户的的邮箱，之后会要求确认路径和输入密码，我们这使用默认的一路回车就行。打开 ~/.ssh 下的 id_rsa.pub，复制里面的 key。

或使用 Git Gui 生成 SSH Key

进入 Gitee 的设置界面

左选 SSH 公钥选项，在公钥位置粘贴复制的 key，然后点击确定。

2. 添加远程仓库

# 添加远程仓库
git remote add origin git@gitee.com:Auto_SK/Git-Notes.git

3. 远程仓库管理

# 将本地分支和远程分支进行关联
git push -u origin branchName

# 将本地仓库的文件推送到远程分支
git push

# 将本地仓库的的指定分支推送到远程仓库
git push orgin branchName

# 将远程分支的文件拉取到本地仓库
git pull

# 拉取指定远程的到指定的本地仓库分支
git pull origin branchName

6 Git 自定义

6.1 忽略特殊文件

在Git工作区的根目录下创建一个特殊的 .gitignore 文件，然后把要忽略的文件名填进去，Git就会自动忽略这些文件。Github 的 Git 忽略模板 https://github.com/github/gitignore。

# 忽略指定文件
HelloWrold.py

# 忽略指定文件夹
bin/
bin/gen/

# 忽略所有的 .pyc 文件
*.pyc

# 忽略名称中末尾为 ignore 的文件夹
*ignore/

# 忽略名称中间包含 ignore 的文件夹
*ignore*/

# 在已经忽略的文件类型中不忽略指定文件
!bin/solver.exe

6.2 配置别名

# 配置别名
git config --global alias.co checkout
git config --global alias.ss status
git config --global alias.cm commit
git config --global alias.br branch
git config --global alias.rg reflog

# 这里只是美化 log 的输出，实际使用时可以在 git lg 后面加命令参数，如：git lg -10 显示最近10条提交
git config --global alias.lg "log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit"

6.3 Git 代理设置

1. HTTP 代理

# 走 HTTP  代理
# PORT 改为代理工具代理的端口
git config --global http.proxy "http://127.0.0.1:PORT"
git config --global https.proxy "http://127.0.0.1:PORT"

# 走 SOCKS5 代理
# PORT 改为代理工具代理的端口
git config --global http.proxy "socks5://127.0.0.1:PORT"
git config --global https.proxy "socks5://127.0.0.1:PORT"

# 取消设置
git config --global --unset http.proxy
git config --global --unset https.proxy

2. SSH 代理

修改 ~/.ssh/config 文件（不存在则新建）：

# 这里的 -a none 是 NO-AUTH 模式，参见 https://bitbucket.org/gotoh/connect/wiki/Home 中的 More detail 一节
# PORT 改为代理工具代理的端口
ProxyCommand connect -S 127.0.0.1:PORT -a none %h %p

Host github.com
    # username 改为 GitHub 的邮箱地址
    User username
    Port 22
    Hostname github.com
    # 注意修改路径为你的路径
    # username 改为你的用户名
    IdentityFile "C:\Users\username\.ssh\id_rsa"
    TCPKeepAlive yes

Host ssh.github.com
    # username 改为 GitHub 的邮箱地址
    User username
    Port 443
    Hostname ssh.github.com
    # 注意修改路径为你的路径
    # username 改为你的用户名
    IdentityFile "C:\Users\username\.ssh\id_rsa"
    TCPKeepAlive yes

6.4 搭建 Git 服务器

使用 Gitea 搭建服务器，参考 用 Gitea 搭建自己的 Git 服务器。

6.5 Pycharm 的 Terminal 使用 Git Bash

# 将 Shell path 改为
"C:\Program Files\Git\bin\sh.exe" -li

# 将 Tab name 改为
Git Bash

6.6 修改 Git Bash 默认配置文件

在 Git Bash 默认配置文件 C:\Program Files\Git\ect\bash.bashrc 末尾添加：

# 让 ls 和 dir 命令显示中文和颜色 
alias ll='ls -al'
alias ls='ls --show-control-chars --color' 
alias dir='dir -N --color'

# 设置为中文环境，使提示成为中文 
export LANG="zh_CN.UTF-8"
export LC_ALL="zh_CN.UTF-8"

# 输出为中文编码 
export OUTPUT_CHARSET="utf-8"

# 可以输入中文 
set meta-flag on 
set output-meta on 
set convert-meta off 

# 激活默认的 Python 环境
source activate python37

相关参考

1. Pro Git
2. Git 参考手册
3. Git 思维导图
4. 廖雪峰的 Git 教程
5. 菜鸟教程 | Git 教程
6. 常用 Git 命令清单
7. A successful Git branching model
8. Git中的一些骚操作