文章目录
  1. 1. Git的Patch功能
    1. 1.1. git diff生成的标准patch
    2. 1.2. git format-patch生成的git专用补丁
    3. 1.3. 两种patch的比较

Git的Patch功能

UNIX世界的软件开发大多都是协作式的,因此,Patch(补丁)是一个相当重要的东西,因为几乎所有的大型UNIX项目的普通贡献者,都是通过 Patch来提交代码的。作为最重要的开源项目之一,Linux,也是这样的。普通开发者从软件仓库clone下代码,然后写入代码,做一个Patch, 最后用E-mail发给Linux Kernel的维护者就好了。Git最初作为Linux的版本控制工具,提供了透明、完整、稳定的Patch功能。

我们先介绍一下Patch是什么。如果一个软件有了新版本,我们可以完整地下载新版本的代码进行编译安装。然而,像Linux Kernel这样的大型项目,代码即使压缩,也超过70MB,每次全新下载是有相当大的代价的。然而,每次更新变动的代码可能不超过1MB,因此,我们只 要能够有两个版本代码的diff的数据,应该就可以以极低的代价更新程序了。因此,Larry Wall开发了一个工具:patch。它可以根据一个diff文件进行版本更新。

不过在git中,我们没有必要直接使用diff和patch来做补丁,这样做既危险又麻烦。git提供了两种简单的patch方案。一是用git diff生成的标准patch,二是git format-patch生成的Git专用Patch。

git diff生成的标准patch

我们可以首先用git diff制作一个patch。
本文示例的工作目录里最初有一个文件readme.txt,内容是“Git is a distributed version control system.”,放置在master分支中。为了修改代码,我们一般的做法是建立一个新分支:

git branch Fix
git checkout Fix

接下来我们在readme.txt文件里面追加一行,然后执行git diff。
echo 'Fix!!!'>>readme.txt
git diff

我们看到了Git diff的输出,这是一个非常典型的Patch式diff。这样我们可以直接把这个输出变为一个Patch:
git commit -a -m "Fix"
git diff master > patch
git checkout master

我们现在有一个patch文件,并且切换到了master,接下来我们可以使用git apply来应用这个patch。一般情况下,为了保护master,我们会建立一个专门处理新交来的patch的分支:
git branch PATCH
git checkout PATCH
git apply patch
git commit -a -m "Patch Apply"

看,现在我们在PATCH分支中应用了这个补丁,我们可以把PATCH分支和Fix比对一下,结果肯定是什么也没有,说明PATCH分支和Fix分支完全一样。patch应用成功。即使有多个文件git diff 也能生成一个patch。

git format-patch生成的git专用补丁

我们同样用上面那个例子的工作目录,这次,我们在Fix分支中的a添加了新行之后,用git format-patch生成一个patch。
git checkout Fix
echo 'Fix!!!'>>readme.txt
git commit -a -m "Fix1"
git format-patch -M master

git format-patch的-M选项表示这个patch要和那个分支比对。现在它生成了一个patch文件,我们看看那是什么:
cat 0001-Fix1.patch

看,这次多了好多东西,不仅有diff的信息,还有提交者,时间等等,仔细一看你会发现,这是个E-mail的文件,你可以直接发送它!这种patch,我们要用git am来应用。

git checkout master
git branch PATCH
git checkout PATCH
git am 0001-Fix1.patch
git commit -a -m "PATCH apply"

在提交了补丁之后,我们可以再看看目前文件readme.txt的情况:

cat readme.txt

果然,多了一个Fix!!!

不过要注意的是,如果master与Fix分支中间有多次提交,它会针对每次提交生成一个patch。

两种patch的比较

  • 兼容性:很明显,git diff生成的Patch兼容性强。如果你在修改的代码的官方版本库不是Git管理的版本库,那么你必须使用git diff生成的patch才能让你的代码被项目的维护人接受。

  • 除错功能:对于git diff生成的patch,你可以用git apply –check 查看补丁是否能够干净顺利地应用到当前分支中;如果git format-patch 生成的补丁不能打到当前分支,git am会给出提示,并协助你完成打补丁工作,你也可以使用git am -3进行三方合并,详细的做法可以参考git手册或者《Progit》。从这一点上看,两者除错功能都很强。

  • 版本库信息:由于git format-patch生成的补丁中含有这个补丁开发者的名字,因此在应用补丁时,这个名字会被记录进版本库,显然,这样做是恰当的。因此,目前使用Git的开源社区往往建议大家使用format-patch生成补丁。


参考资料:

  1. 老z的博客
  2. git 廖雪峰
文章目录
  1. 1. Git的Patch功能
    1. 1.1. git diff生成的标准patch
    2. 1.2. git format-patch生成的git专用补丁
    3. 1.3. 两种patch的比较