git

git使用手册

此文中多处链接为 维基百科 ,需要翻墙查看。


版本控制软件——为什么要使用git

自从高级语言Fortran被广泛使用,人类所开发的软件规模爆炸式地增长起来。随之而来的还有大型程序开发与维护中的许多严重问题,这些问题可能导致软件产品的寿命缩短,甚至夭折。这就是所谓的软件危机。人类在应对软件危机的过程中逐渐总结出一套方法,形成了软件工程这一学科。其中,一个非常重要的方法就是要对程序进行严格的版本控制

版本控制软件就是为了对软件进行版本控制而开发的工具软件。目前常用的版本控制软件有协作版本系统(CVS)Subversion(SVN),git等。

git相比于SVN具有明显的优势,主要是因为它是一个分布式管理系统。这意味着每个开发者的计算机上都有一个完整的仓库,包括完整的源代码以及开发历史。每个开发者需要在自己的仓库内完成自己的工作,形成稳定版本后再上传至远程服务器。这大大减少了开发者之间的冲突,并且对网络的依赖也不如SVN那样严重。

git的安装

推荐使用命令行工具进行git操作,一些git客户端提供简单的GUI,请感兴趣的同学自己查阅资料学习。下面主要介绍不同平台下git命令行工具的安装。

windows系统

  1. 此链接下载windows版本的安装程序。
  2. 运行安装程序进行安装,相关设置如下图。 
     
    这里选择安装git的命令行界面和GUI界面。 
     
    选择此项意味着可以在Windows的命令行cmd.exe中运行git命令。 
     
    Windows中的文本文件格式和Linux/Unix中的文本文件格式有所区别,此选项可以使得git自动进行格式转换。 
     
    使用MinTTY打开Git Bash。这是一个支持多字符集、支持256位色、支持鼠标右键菜单的强大终端。
  3. 安装完成后,在资源管理器中点击鼠标右键,会出现Git GUI HereGit Bash Here的选项。
  4. 在任意文件夹右键点击Git Bash Here选项,在打开的命令行窗口中输入如下命令 
    git clone https://github.com/Eric-Song-Love-Coding/git_document.git 
    若文件夹中出现git_document文件夹,则说明安装成功。你可以在此文件夹中查看此手册的源代码。

linux系统

  1. 打开终端,运行如下命令 
    sudo get-apt install git 
    即可安装git。
  2. 在终端中输入如下命令 
    git clone https://github.com/Eric-Song-Love-Coding/git_document.git 
    若文件夹中出现git_document文件夹,则说明安装成功。你可以在此文件夹中查看此手册的源代码。

简单的Windows cmd命令与linux命令

在使用git时会经常使用Windows cmd和linux中的一些命令,下面介绍一些常用命令。建议在git bash下使用linux命令完成git操作。

Windows cmd

运行中输入cmd.exe即可打开Windows cmd命令界面。其中输入的均为DOS命令,可以参考CMD命令速查手册。实际使用中常用的所有操作都可以使用鼠标完成。

cd命令

显示当前目录名或改变当前目录。

  • cd 不带参数时,显示当前驱动器和目录。
  • cd [路径] 可以跳转到指定目录。..表示父目录。如cd c:\learn\git\..\github

dir命令

显示目录中的文件夹和子目录列表。


Linux

Linux系统有多种发行版,如DebianUbuntu。在有GUI的发行版中,需要打开终端才可以输入命令。Linux命令文档可以使用man命令查看,也可在这里,或这里在线查询。

Tab自动补全

Linux终端大多具有自动补全功能。在输入常用命令或参数时,Tab键可以将当前命令或路径自动补全。当有多种补全形式时,还可以自动列出所有可能的方式以供选择。勤用Tab键可以大大提高输入命令的效率和准确率。

cd命令

cd命令的功能是切换目录,其参数可以是相对路径或绝对路径。在表示路径时经常要用到以下特殊符号。

  • 表示主文件夹。cd ~Eric表示去到用户Eric的主文件夹,而cd ~则表示去到当前用户的主文件夹。同时,cd命令也可以直接回到当前用户的主文件夹。
  • .. 表示上层目录。如cd ..表示回到当前目录的上层目录,cd /a/b/c/..表示回到c目录的上层目录,即b目录。
  • 表示刚才的目录,即上次使用cd命令之前的目录。
  • 完整路径/绝对路径。即将路径的全称写出来,以/或盘符开头。如cd /var/spool/mailcd C:\Users\Public
  • 相对路径。直接以目录名开头,指相对于当前路径的路径名。如cd learn/git/../github

pwd命令

pwd命令可以显示当前的目录。

ls命令

ls可以列出当前目录下所有文件/文件夹的信息。详细参数可以在此处查看。常用参数说明如下。

  • ls -a 显示所有档案及目录,包括以’.’开头的隐藏文件。
  • ls -l 以长格式显示目录下的内容列表。输出的信息从左到右依次为权限模式、硬连接数、所有者、组、文件大小、文件最后修改时间和文件名。
  • -a-l等选项可以混用,比如ls -al可以显示所有文件的详细信息。

mkdir命令

mkdir命令可以在当前目录下新建一个空目录,也可在制定路径下新建空目录。

rm命令

rm命令可以删除一个目录中的一个或多个文件夹或目录,也可以将某个目录及其下属的所有文件及子目论均删除掉。使用rm命令删除掉的文件无法恢复,应格外小心。

  • rm -i 删除已有文件或目录之前先询问用户。强烈建议进行删除时加上此选项,系统会要求用户逐一确定是否删除文件。
  • rm -r 递归处理。将指定目录下的所有文件与子目录一并处理。

git操作

以下介绍git的常用命令。git的教程资源非常丰富,推荐廖雪峰的git教程,此教程可完全满足课程需要。感兴趣的同学可以购买相关书籍或查阅官方教程深入学习。

查看git的帮助文档

git的所有命令都是‘git [参数]’的形式,可以使用不带参数的‘git'命令就可以列出常用的选项和子命令。 
git help命令可以得到详细的文档信息,如使用‘git help --all’可以获得完整的字命令列表,而通过‘git help add’命令可以得到详细的 git add 命令的用法。也可以访问这个页面来查看在线文档。

开始使用git——创建版本库

git的一个重要概念是版本库(repository),版本库只是一个简单的数据库,其中包含所有用来维护与管理项目的修订版本和历史的信息。所有的版本库数据存放在工作目录根目录下一个名为.git的隐藏目录中。请注意,无论何时都不要删除.git目录。 
使用git的头一件事就是创建本地版本库。有两种方法可以创建版本库。

  • git init 命令可以将当前目录转化为git版本库,无论文件夹中是否有文件,得到的版本库都是空的版本库,需要将需要的文件添加进去。
  • git clone 命令可以复制(或克隆)一个完整的版本库。此命令会在当前目录下建立一个目录,内含所克隆版本库的副本。git支持一组非常丰富的版本库源,不仅可以通过git clone git_doc d:\learn\git_doc这样的命令克隆本地版本库,还可以支持sshhttp[s]ftp[s]等协议克隆远程版本库。

建立版本库后,可以使用git status命令查看版本库的状态。比如此时此份文档的版本库状态为下图(此git版本号为2.7.4,运行环境为Ubuntu16.04,可以支持中文)。

git_status 
状态信息给出了当前所处的分支,与上游分支的关系,还说明了当前有未暂存的修改,修改还未提交。我们将在下文中说明它们的意义。

文件的添加与修改

如上文所述,在/home/eric/learn/test文件夹下,我们使用git init命令建立一个空的版本库。若我们向文件夹中加入test.txt文本文件,版本库的状态如下图所示。

git_add_1 
为了将新文件加入版本库,我们需要使用git add test.txt命令。git add的参数格式灵活,比如可以使用git add .来将当前文件夹下的所有更改都加入版本库。加入文件后版本库的状态如下图所示。

git_add_2 
git告诉我们,text.txt文件已经由“未跟踪的文件”变成了“要提交的文件”。实际上,git add命令只是将版本库的修改信息提交到了缓冲区中,并没有建立新的版本,用git log命令查看也可以获知当前尚无任何提交。这种设计使得开发者可以多次使用git add命令添加修改,甚至是撤回原先的修改,而无须形成过多的版本号。 
我们使用git commit -m '第一次提交'命令来进行一次提交。提交后版本库状态如下图。

git_add_3 
git commit -m命令中,-m作为选项,意为输入本次提交的说明,后面需要输入一个任意的字符串,最好是简单描述本次提交到底做了什么。如果仅仅使用git commit命令,git也会提示用户输入提交说明。 
在提交后,git生成了一个新的版本号。可以使用git log命令查看提交历史,包含了提交的详细信息以及版本号。 
在多人合作开发的过程中,还需要知道每次新的版本是由谁来提交的。我们可以在每次提交的命令行中指定身份,但是更方便的方法是使用git config命令在配置文件保存身份信息。使用以下两条命令可以设定用户名字和邮箱。 
git config user.name "Eric" 
git config user.email "This email address is being protected from spambots. You need JavaScript enabled to view it."

分支

git版本库存储了所有的历史版本和修改的记录,其存储结构可以理解成一个“树”状的图(并不等同于离散数学中的“树“),一个典型的版本结构如下图所示。

git_branch_1 
图中每个结点均代表了一个版本号。可以看到,我们初始只有主分支(master)上的第一个版本,然后由此版本引出了branchA分支。自此主分支和branchA分支平行前进,互不干扰。主分支在分出branchA分支后,还可以继续分出branchB分支,只不过branchB分支的开始版本与主分支的第二个版本相同。branchA分支依然可以继续分出branchC分支,这些分支依然是平行前进互不干扰的。分支还可以进行合并,如branchA分支的最后并入了主分支,合成了一个新的版本。在分支合并时,主分支上的版本很可能不再是branchA分支分出时的版本,当前版本很可能与branchA分支的当前版本相冲突,这时就需要开发人员解决冲突,git也为我们提供了相关的工具。分支的合并实际上是在两个分支上都进行了一次提交,使得两个分支上的版本相同,而不一定要消灭掉某个子分支。比如branchB与主分支合并后,branchB并没有被删除,而是继续开发。 
回到我们建立的版本库test,我们希望在其中的文本文件text.txt中写一首小诗。但是由于作者才疏学浅思维枯竭,写诗总是要修修改改。这时我们就应当开辟一个写诗的分支,修修改改都在上面进行,只有当满意了才将正式版的诗合并到主分支上。使用git branch dev命令建立dev分支,再直接使用不带参数的git branch命令就可以查看目前的分支状况,如下图。

git_branch_2 
分支状态显示我们当前拥有主分支和dev分支两个分支,而目前处于主分支上(由*表示)。使用git checkout dev命令可以切换到当前分支上。在此分上我们可以正常进行修改和提交。现在我开始写诗。写完一段诗之后,直接使用git addgit commit命令就可以在当前分之上提交。 
在提交了三次后,我觉得这诗写得……算那么回事了,可以形成一个正式版给别人看看了,这时我就需要将dev分支的合并到主分支上去。为了执行合并操作,需要先使用git checkout master命令移回到主分支上。这时我惊讶地发现,test.txt文件中我的诗不见了!实际上,git checkout命令相当于检出了主分支上的最新版本,而写诗的修改全部发生在dev分支中,在主分支中不可见。现在使用git merge dev命令就可以将dev分支合并到主分支。 
如上所描述的合并只是最简单的情况,在合并时并没有发生冲突,实质上只发生了一次指针的移动,相当于将主分支和dev分支重合起来。可以使用git log --graph命令来生成图形化的分支历史记录,如下图。

git_branch_3 
可见本次合并后,并没有出现分叉的分支。这是由于合并过程中,git没有检测到冲突,就自动采用了快速合并的方式进行。 
现在,我接着在dev分支中进行创作,写了一小段以后我忽然想起来诗竟然没写题目就发布在了主分支中!我只能回到主分支给诗加上题目并提交,然后再回到dev分支中继续创作。当我感觉写得不错,准备向主分支提交时,出现了问题,如下图。

git_branch_4 
主分支和dev分支出现了冲突,需要我们手动去处理。打开test.txt文件如下图。

git_branch_5 
我们发现发生冲突的地方已经被git使用<<<<<<<<====>>>>>>>等符号标出,我们将其改动为正确版本后再提交,就可以将两个分支合并了。合并后使用git log --graph --pretty=online --abbrev-commit命令就可以得到下图所示的分支图。

git_branch_6 
现在,我觉得这首诗已经写好了,不需要再修改了,就可以将dev分支删除。删除分支的命令为git branch -d dev。使用git branch查看可以确认dev分支已被删除。

版本回溯

之前,我们已经用git loggit log --graph查看过版本库的提交历史,图上每个结点都代表一次提交,对应着一个版本号。我们可以利用此版本号来进行版本回溯与快进。 
版本回溯的命令为git reset。在git中,使用HEAD代表当前版本,而HEAD^就代表上一个版本,上上个版本当然就用HEAD^^代表。所以,当我想回到上一个版本的时候,只需要使用git reset HEAD^命令。也可以使用git reset HEAD~100命令表示回到100个版本以前。

git reset 命令主要有三个参数,分别为--soft--mixed--hard。它们代表了重置当前版本时对索引和工作目录的内容的三种处理方法,git默认使用--mixed参数。这三个参数十分重要,建议通过这个链接来详细了解。

当然也可以直接跳转到某个版本号去。使用git log --pretty=oneline命令可以方便地查看版本号和对应的提交信息,如下图。

git_reset_1 
与SVN不同,git的版本号不是1.2.3这样递增的数字,而是使用SHA1算出的一个非常大的数字,使用十六进制表示。只需要使用git reset [对应的版本号]就可以跳跃到指定的版本去了。由于散列的离散特性,一般只需要版本号的前几位就可以了。 
在版本见跳跃的另一个技巧是,使用git reflog命令可以查看git操作历史,包括每条命令是在哪个版本上发出的。这就可以避免错误使用git reset --hard命令跳到过去版本回不来了的问题。

git_reset_2

GitHub和远程仓库

若仅像上文一样在本地管理版本库,相对于SVN等版本控制软件,git并没有显示出多大优势。git的最大优势在于它的分布式特点,而git分布式特征是基于远程仓库来实现的。 
远程仓库并不指的是空间上距离足够远(虽然大部分情况确实如此),而是指两个仓库之间通过局域网或者广域网(当然,也可以在同一台计算机中)保持同步的能力。搭建git服务器是容易的,但是对于学生或者个人开发者而言,搭建一个git服务器或许有些小题大做。推荐使用GitHub来搭建自己的远程版本库,使得自己可以在任意时间任何设备上进行自己的开发。 
GitHub是一个开源代码库,这意味着任何人都可以在GitHub上注册免费的账号并且托管自己的远程仓库,还可以搜索别人的开源代码来进行学习、使用和开发。GitHub也可以建立私人仓库,但这属于付费功能。 
注册GitHub后,就可以在GitHub上创建远程仓库。现在我在我的GitHub中创建poem远程仓库,创建好的界面如下图。

github_1
此界面列出了将远程仓库与本地仓库建立连接的方法,可以看到GitHub支持httpsssh协议。如果我们想在远程仓库的基础上进行开发,需要将远程仓库克隆到本地;若要将本地仓库推送到远程,则需要在本地仓库手动建立连接。 
我们在本地的test仓库中,使用git remote add origin https://github.com/Eric-Song-Love-Coding/poem.git命令就可以将本地仓库与远程仓库建立连接。

git的版本库分为裸版本库开发版本库两类。我们之前一直在使用开发版本库,它有工作目录和分支的概念,可以修改和提交。而裸版本库则没有工作目录,它一般作为协作开发的权威焦点。开发人员从裸版本库中进行克隆(clone)、抓取(fetch)和推送(push)更新操作。裸版本库适合作为服务器端的远程仓库。

本地仓库与远程仓库的连接是单向的。本地仓库会建立一个连接指回它的父仓库,但是原始版本库并不知道任何克隆版本库。默认情况下,git会将源版本库称为origin,其主分支即为origin/master。此名称可以更改。

使用不带参数的git remote命令可以查看当前连接的所有远程版本库。现在我可以使用git push -u origin master命令将当前分支推送到远程库的主分支。如下图所示。

github_2

由于我使用的是HTTP协议的git地址,所以需要输入账号密码才能够推送。欲免去这一步骤,需要使用SSH协议的git地址,并且在GitHub上 进行秘钥设置 

git push命令有许多选项,这里的-u意为将本地主分支和远程版本库主分支绑定在一起,之后只需要git push origin master命令即可。注意此命令的格式为git push [远程版本库名] [本地分支名]。 
当多人合作时,很可能出现这样的情况:在将本地修改推送到远程版本库时,远程版本库已经被他人修改,出现冲突,这时会提示推送失败。所以比较好的习惯就是在每次推送前先使用git pull命令拉取远程版本库的最新版本,手动解决冲突后即可推送。

gitlab

GitLab的使用

目前git服务器一般会采用GitLab程序包,下面介绍GitLab的用法。

注册GitLab

GitLab与GitHub类似,可以在网页上管理自己的远程仓库。使用GitLab需要首先注册一个账号。 
我们搭建的GitLab服务器域名为http://data.comdyn.cn:30000

由于校内网络与外网连接不稳定,请尽量于校内访问。校外访问时,请不要上传过大的文件,否则会产生较高的流量费用。

GitLab的登陆界面如下图,请按照图示填写个人信息。若填写信息不实或者不是选课人员,助教会关闭此账号。

GitLab_SingUp
点击Sign Up完成注册,这时注册邮箱会收到助教邮箱发来的验证邮件,如下图所示。

GitLab_Confirm
点击Confirm your account进行验证,之后账号便可以正常使用了。注意:有时服务器会与外网断开连接,若注册后收不到验证邮件,请与助教联系。助教会手动验证你的账号。

与GitLab建立连接

登陆自己的账号后,会看到如下页面。

GitLab_Home
页面的中间显示了现在正在参与的项目,包括自己创建的项目和小组中共同开发的项目。为了保证服务器的安全保证,新注册的账号没有建立自己项目的权限,助教会将同学分组,并且为每个组建立一个项目作为本组的远程仓库。每组成员权限设置为Developer

点击本组的项目,会出现项目的git地址。如下图所示。

GitLab_Project
助教已经为每组上传了STAP90的源代码,只需要将项目克隆到本地即可。git的地址有两种协议可供选择,SSHHTTPS

SSH

SSH(Secure Shell,安全外壳协议)提供了点对点的安全通讯方式。它识别的是设备信息而不是账户信息,你可以向你的账号中添加一台设备(通过添加SSH公钥)来将此设备设定为“可信赖”。之后使用此设备与远程仓库交互时,GitLab会根据你当前使用的设备来验证你的身份。 
首先需要在自己的设备上生成SSH公钥。Windows系统的SSH公钥保存在用户主目录的.ssh下(如C:\Users\ZhuJiao),若有id_rsa.pub文件,说明公钥已生成。若无此文件,则需要生成。Linux系统的SSH公钥也保存在用户主目录~/.ssh下,使用cat ~/.ssh/id_rsa.pub命令查看是否有公钥。 
若没有公钥,可以使用ssh-keygen -t rsa -C "[你的邮箱]"命令生成公钥。生成过程中不需要设置密码。生成后使用文本工具打开id_rsa.pub文件,可以看到公钥的内容如下图所示。

GitLab_SSHKey 
登陆GitLab账户后,在右侧Profile Settings→SSH Keys中添加SSH公钥。只需要将id_rsa.pub的内容复制在文本框中,再输入一个名字,点击Add Key即可添加。如下图所示。

GitLab_AddKey 
添加SSH公钥后,直接在本地使用git clone [SSH Address]命令即可将远程仓库克隆至本地。

HTTPS

HTTPS需要验证账号密码,在本地使用git clone [HTTPS Address]命令可以将远程仓库克隆至本地,但是克隆之前需要按照提示输入GitLab的账号与密码。

小组共同开发

GitLab为我们提供了非常好用的项目管理工具。使用好这些工具,能够大大提高多人合作开发软件的效率,降低出错率。小组合作的所有信息都显示在GitLab的主界面中,如下图左侧所示。

GitLab_Group

里程碑 Milestone

里程碑是版本控制中的一个重要概念,它指的是一个阶段性的可发布的稳定版本(相对于开发版本而言)。里程碑由项目管理者事先设定好,作为当前的工作目标。一般里程碑拥有一个不同于开发版本号的发布版本号。 
本课程中,同学所使用的GitLab账户没有设置里程碑的权限,里程碑由老师或助教按照目前的教学安排进行设置。

要做的事和专案 Todos & Issues

这两者是小组合作交互的灵魂所在。开发者可以在GitLab上创建专案来讨论问题,明确下一步要做的事以及指派人去完成。受到指派的人会收到邮件通知(服务器与外网连接的情况下),也会在Tudos一栏收到任务提示。与任务无关的人可以在issues页面中进行相关讨论,issues可以随时关闭专案、指派新的任务或者更换任务执行人。 
点击Issues→New Issue即可创建专案,如下图。

GitLab_Issue
在专案创建界面可以输入专案的题目、详细描述、分配给任务的人以及专案对应的里程碑。专案的题目力求简洁精炼。描述部分支持Markdown语法,可以呈现出漂亮的排版效果。创建好专案后,点击即可进入专案界面,如下图。

GitLab_IssueScreen
专案界面像是一个BBS应用,组内成员可以自由发表意见(支持Markdown),还可以添加附件。专案的创始人可以改动指派完成任务的人员,关闭专案甚至删除专案。被指派的人员可以在自己的Tudos界面看到被指定的任务,如下图。

GitLab_Tudos
当任务完成后,只要点击Done按钮就可以了!

TortoiseGit

更好用的Git - TortoiseGit

Git再好用,记忆命令行及参数对很多人来说也是很高的门槛。为了使得Git更好用,Tim Kemp开发了TortoiseGit(TortoiseSVN也是他开发的)。TortoiseGit提供了好用的Git的图形界面,大大降低了Git的学习成本。 
为了更好地理解TortoiseGit的工作原理,我们应当明确以下两个事实:

  1. 所有的git命令都为git [参数]这样的形式
  2. 几乎所有的git命令都对一个对象/目录/文件进行了操作

基于这两点,就可以很容易地理解TortoiseGit的工作原理。它实际上就是将git命令放在了Windows的右键菜单中供人选择,而命令的对象就是当前点击的目录/对象/文件。

TortoiseGit只能在Windows系统上运行。请于这里下载适合的安装包(注意区分32位和64位)。安装前请保证已经安装了Git for windows,否则会无法使用。 
打开安装程序,修改安装路径后全部默认进行安装就可以,安装完成后在资源管理器中随意右击即可看到git选项。其选项名称均与git命令相同,非常容易操作,请同学自己学习。

用户登录