用Diff和Patch工具维护源码
国防科技大学计算机学院 杨沙洲
在Unix系统下，维护源码版本可以使用很多方法，其中最常用的当然是大名鼎鼎的CVS，但实际上，简单的版本维护工作并没有必要使用复杂的CVS等专门的版本维护工具，Unix标配中的diff和patch工具就完全可以完成代码的简单备份和升级工作。
diff 以"行"为单位比较两个文本文件（也可以是目录比较），并将不同之处以某种格式输出到标准输出上；patch可以读入这种输出，并按照一定指令使源文件 （目录）按照目标文件（目录）更新。Linux内核源码就是按照这种方式保持更新的，我们在www.kernel.org上可以下载到最新内核的 patch文件的bzip2包。本文以gnudiffutils 2.7和patch 2.5为例介绍diff和patch工具的使用。
diff 既可以用来比较两个文件，也可以用来比较两个目录中每个文件。使用-r（--recursive）参数时还可以在目录中嵌套比较。比较目录时除比较同名文 件外，对不同名的文件当成新文件处理。对于比较C程序文件，diff还提供了专门的参数（-p，--show-c-function）来标识不同之处所在 的函数名。
diff的输出格式有三种：列举方式、命令模式和上下文模式，其中命令模式有分为两种：ed命令格式和RCS（Revision Control System，版本控制系统）命令格式，上下文模式也按格式分为老版和新版两种。看下面的例子就能基本清楚各个格式的区别：
命令格式记录的是从test1更新到test2所需要执行的命令，而上下文模式通常可读性更好一些，它所记录的主要是二者的差异，通常还记录所需修改部分的上下几行（可配置）内容以供比较。见下面的例子：
新版格式较之老版要紧凑一些，Linux内核源码的升级就是按照新版上下文格式用diff组织的，比如patch-2.4.16中所用的具体命令为：
diff -Nur linux-2.4.15 linux
参数N表示如果某个文件仅在一个目录中出现，则假定其在另一个目录中为空文件；u表示unified格式，r表示在目录中嵌套使用，linux-2.4.15显然是老核的目录名，而linux则为新核的目录名。
 |
尽 管并没有指定patch和diff的关系，但通常patch都使用diff的结果来完成打补丁的工作，这和patch本身支持多种diff输出文件格式有 很大关系。patch通过读入patch命令文件（可以从标准输入），对目标文件进行修改。通常先用diff命令比较新老版本，patch命令文件则采用 diff的输出文件，从而保持原版本与新版本一致。
patch的标准格式为
|
如果patchfile为空则从标准 输入读取patchfile内容；如果originalfile也为空，则从patchfile（肯定来自标准输入）中读取需要打补丁的文件名。因此，如 果需要修改的是目录，一般都必须在patchfile中记录目录下的各个文件名。绝大多数情况下，patch都用以下这种简单的方式使用：
|
patch命令可以忽略文件中的冗余 信息，从中取出diff的格式以及所需要patch的文件名，文件名按照diff参数中的"源文件"、"目标文件"以及冗余信息中的"Index："行中 所指定的文件的顺序来决定。也就是说，对于如下diff结果文件（Linux内核源码2.4.16升级包，部分）：
|
patch首先尝试当前目录（或者- d参数指定的目录）下的linux-2.4.15/Makefile文件是否存在，如果不存在则试图对linux/Makefile文件操作，仅当两者都 不存在时（或者设置了POSIXLY_CORRECT环境变量）才会读取Index:的内容（此文件中没有标识）。
前面提 到的-p参数决定了是否使用读出的源文件名的前缀目录信息，不提供-p参数，则忽略所有目录信息，-p0（或者-p 0）表示使用全部的路径信息，-p1将忽略第一个"/"以前的目录，依此类推。如/usr/src/linux-2.4.15/Makefile这样的文 件名，在提供-p3参数时将使用linux-2.4.15/Makefile作为所要patch的文件。
对于刚才举的 Linux内核源码2.4.16升级包的例子，假定源码目录位于/usr/src/linux中，则在当前目录为/usr/src时使用"patch -p0 <patch-2.4.16"可以工作，在当前目录为/usr/src/linux时，"patch -p1<patch-2.4.16"也可以正常工作。
patch可以直接操作上下文格式以及混合ed格式的diff输出文件，而将ed格式文件通过管道提交给ed程序操作（暂时不知RCS格式的文件如何处理）。
|
在此仅举一个简单的例子来说明如何用diff/patch工具维护源码升级。
假设program-1.0目录中为老版，现开发完成的新版位于program-2.0目录中，将两个目录置于同一父目录下，然后在该父目录上执行：
|
将生成一个program-2.0.patch的补丁文件，发布该补丁文件（当然可以先压缩成bzip2格式）。
假设拿到的是program-2.0.patch.bz2文件，则在program-1.0目录同级执行：
|
如此即完成了从1.0到2.0的升级。
如果希望恢复到原版本，可以使用-R（--reverse）参数，但仅对上下文格式的diff文件有效。还有一个备份参数也可以使用，但简单应用中，整个目录备份可能更方便一些。
==== 注意事项====diff 和 patch 是 unix 世界里面代码编写与管理的常用工具。cvs 是 Unix 里面应用最广的代码管理服务。当这两套体系放在一起使用的时候，稍不注意，难免就会出现一些问题
主要的问题，基本上在于 CVS 版本信息的维护和保持上面。由于从 cvs 服务器中 checkout 出的代码，所属的版本信息都被存储在相应的 CVS 目录里面，因此在使用 diff 制作代码的 patch 文件的时候，一定要记得加入 --exclude=CVS 参数，将所有的 CVS 目录排除在外。这样才能保证应用补丁文件的时候不会改变原是代码的版本数据。
====Diff与Patch简介====
diff就如其名，是一个比较文件之间差异的工具。它可以比较两个文件或者两个目录下的文件。
diff的最简单的用法如下：
diff file1 file2
例如：
diff ESDMain.java ESDMain.new.java
这个指令可能有以下输出…
545c545
< System.out.println("added");
---
> logger.info("added");
548c548,549
< System.out.println("not added");
---
> // popup error details
> logger.info("not added");
以<开头的是旧文件的源代码，而以>开头的则是新文件的源代码。其中548c548,549表示548行的code被換為548和549行。
diff也可以让我们记录两个版本的source directory的分別，并制作成patch让其他有旧版本源码的人可以简单地更新源码。很多時在Linux或者其他open source的討論區人們自制更新時也會用patch的方式上傳，因為同一個檔案可能被多人同時更改，使用patch可以減少變更衝突的機會，也同時清楚 顯示了更新的地方。
要制作patch可用如下指令：
diff -ruN src-1.0 src-1.1
這裏的r是recursive，u是顯示出上下三行共通的程式碼以方便開發人員找出更新的地方，N則是把新增的檔案也記錄。看看這個patch檔案會給你一些概念。
有了patch檔當然也需要知道patch程式的用法：
patch -p1 < ..\patch.txt
這裏的-p1是指patch中記錄的第一個directory略去，而<則是將patch.txt的內容輸入到patch指令中。執行指令後如無錯誤畫面會顯示出每個被更新的檔案，如果有衝突它會顯示警告，將同樣的patch執行兩次則可以將patch回復。
這裏只是簡介了這兩個程式的其中一些用法，想更加了解它們你需要執行diff –help或patch –help。
當然，如果你的開發隊伍己有一些完善的版本管理系統那大可以不用人手diff和patch，但如果只是自己一丁友或者圍內幾個人幹，那每晚也制作一個版本記錄會是一個好點子。這樣不單可以讓可能發生的錯誤輕易地回復，也可以讓開發者清楚源碼的更新。
====Diff和Patch的使用====1.diff的使用
diff可以完成比较功能，生成补丁文件
格式：：diff [option] oldfile newfile
常用的option选项有：
-r 对目录进行递归处理
-u 输出统一格式，diff有"传统"和"统一"两种格式，现在一般使用"统一"格式，比较而言，统一格式生成的文件大，但包含了更多的信息，有利于阅读与定位
-N 补丁中包含整个新文件
-a 补丁中包含二进制文件
缺省时,diff向标准输出打印，所以一般都重定向到文件并以patch为后缀，也就是所谓的补丁文件
举例：
/* oldfile hello.c */
void main()
{
printf("hello the world!\n");
}
/* newfile hello-new.c */
void main()
{
printf("HELLO THE WORLD!\n");
}
使用以下命令生成补丁文件hello.patch
$diff -u hello.c hello-new.c >hello.patch
diff可以对整个目录进行比较，生成补丁文件
例如有hello-1.0 和hello-1.1两个目录，其中hello-1.1为hello-1.0的更新
命令：
$diff -ruNa hello-1.0 hello-1.1 >hello-1.1.patch
2.patch的使用
把补丁运用到原代码上的命令为patch
patch [-b] suffix <patchfile
如果patch失败，patch会把成功的行打上补丁，失败的行存为以.rej为后缀的文件折，并生成原文件的备份，如果成功则不生成备份。 -b选项可以指定后缀名。
注意：运行patch所在的目录应该与用diff生成补丁的时候一致。例如，上面在hello-1.0目录的上层目录生成补丁文件，patch时也应该在此目录进行。
diff和patch是一对工具，在数学上来说，diff是对两个集合的差运算，patch是对两个集合的和运算。
diff比较两个文件或文件集合的差异，并记录下来，生成一个diff文件，这也是我们常说的patch文件，即补丁文件。
patch能将diff文件运用于 原来的两个集合之一，从而得到另一个集合。举个例子来说文件A和文件B,经过diff之后生成了补丁文件C,那么着个过程相当于 A -B = C ,那么patch的过程就是B+C = A 或A-C =B。
因此我们只要能得到A, B, C三个文件中的任何两个，就能用diff和patch这对工具生成另外一个文件。
这就是diff和patch的妙处。下面分别介绍一下两个工具的用法:
1. diff的用法
diff后面可以接两个文件名或两个目录名。 如果是一个目录名加一个文件名，那么只作用在那么个目录下的同名文件。
如果是两个目录的话，作用于该目录下的所有文件，不递归。如果我们希望递归执行，需要使用-r参数。
命令diff A B > C ,一般A是原始文件，B是修改后的文件，C称为A的补丁文件。
不加任何参数生成的diff文件格式是一种简单的格式，这种格式只标出了不一样的行数和内容。我们需要一种更详细的格式，可以标识出不同之处的上下文环境，这样更有利于提高patch命令的识别能力。这个时候可以用-c开关。
2. patch的用法
patch用于根据原文件和补丁文件生成目标文件。还是拿上个例子来说
patch A C 就能得到B, 这一步叫做对A打上了B的名字为C的补丁。
之一步之后，你的文件A就变成了文件B。如果你打完补丁之后想恢复到A怎么办呢？
patch -R B C 就可以重新还原到A了。
所以不用担心会失去A的问题。
其 实patch在具体使用的时候是不用指定原文件的，因为补丁文件中都已经记载了原文件的路径和名称。patch足够聪明可以认出来。但是有时候会有点小问 题。比如一般对两个目录diff的时候可能已经包含了原目录的名字，但是我们打补丁的时候会进入到目录中再使用patch,着个时候就需要你告诉 patch命令怎么处理补丁文件中的路径。可以利用-pn开关，告诉patch命令忽略的路径分隔符的个数。举例如下：
A文件在 DIR_A下，修改后的B文件在DIR_B下，一般DIR_A和DIR_B在同一级目录。我们为了对整个目录下的所有文件一次性diff,我们一般会到DIR_A和DIR_B的父目录下执行以下命令
diff -rc DIR_A DIR_B > C
这个时候补丁文件C中会记录了原始文件的路径为 DIR_A/A
现在另一个用户得到了A文件和C文件，其中A文件所在的目录也是DIR_A。 一般，他会比较喜欢在DIR_A目录下面进行patch操作，它会执行
patch < C
但是这个时候patch分析C文件中的记录，认为原始文件是./DIR_A/A，但实际上是./A，此时patch会找不到原始文件。为了避免这种情况我们可以使用-p1参数如下
patch -p1 < C
此时，patch会忽略掉第1个”/”之前的内容，认为原始文件是 ./A，这样就正确了。
最后有以下几点注意：
1. 一次打多个patch的话，一般这些patch有先后顺序，得按次序打才行。
2. 在patch之前不要对原文件进行任何修改
3. 如果patch中记录的原始文件和你得到的原始文件版本不匹配(很容易出现)，那么你可以尝试使用patch, 如果幸运的话，可以成功。大部分情况下，会有不匹配的情况，此时patch会生成rej文件，记录失败的地方，你可以手工修改。
==== patch的制作和应用,Patch文件格式====
1、diff
－－－－－－－－－－－－－－－－－－－－
NAME
diff - find differences between two files
SYNOPSIS
diff [options] from-file to-file
－－－－－－－－－－－－－－－－－－－－
简单的说，diff的功能就是用来比较两个文件的不同，然后记录下来，也就是所谓的diff补丁。语法格式：diff 【选项】 源文件（夹） 目的文件（夹），就是要给源文件（夹）打个补丁，使之变成目的文件（夹），术语也就是“升级”。下面介绍三个最为常用选项：
-r 是一个递归选项，设置了这个选项，diff会将两个不同版本源代码目录中的所有对应文件全部都进行一次比较，包括子目录文件。
-N 选项确保补丁文件将正确地处理已经创建或删除文件的情况。
-u 选项以统一格式创建补丁文件，这种格式比缺省格式更紧凑些。
2、patch
－－－－－－－－－－－－－－－－－－
NAME
patch - apply a diff file to an original
SYNOPSIS
patch [options] [originalfile [patchfile]]
but usually just
patch -pnum <patchfile>
－－－－－－－－－－－－－－－－－－
简单的说，patch就是利用diff制作的补丁来实现源文件（夹）和目的文件（夹）的转换。这样说就意味着你可以有源文件（夹）――>目的文件（夹），也可以目的文件（夹）――>源文件（夹）。下面介绍几个最常用选项：
-p0 选项要从当前目录查找目的文件（夹）
-p1 选项要忽略掉第一层目录，从当前目录开始查找。
************************************************************
在这里以实例说明：
--- old/modules/pcitable Mon Sep 27 11:03:56 1999
+++ new/modules/pcitable Tue Dec 19 20:05:41 2000
如果使用参数-p0，那就表示从当前目录找一个叫做old的文件夹，在它下面寻找modules下的pcitable文件来执行patch操作。
如果使用参数-p1，那就表示忽略第一层目录（即不管old），从当前目录寻找modules的文件夹，在它下面找pcitable。这样的前提是当前目 录必须为modules所在的目录。而diff补丁文件则可以在任意位置，只要指明了diff补丁文件的路径就可以了。当然，可以用相对路径，也可以用绝 对路径。不过我一般习惯用相对路径。
************************************************************-E 选项说明如果发现了空文件，那么就删除它
-R 选项说明在补丁文件中的“新”文件和“旧”文件现在要调换过来了（实际上就是给新版本打补丁，让它变成老版本）
patch文件的结构
补丁头
补丁头是分别由---/+++开头的两行，用来表示要打补丁的文件。---开头表示旧文件，+++开头表示新文件。
一个补丁文件中的多个补丁
一个补丁文件中可能包含以---/+++开头的很多节，每一节用来打一个补丁。所以在一个补丁文件中可以包含好多个补丁。
块
块是补丁中要修改的地方。它通常由一部分不用修改的东西开始和结束。他们只是用来表示要修改的位置。他们通常以@@开始，结束于另一个块的开始或者一个新的补丁头。
块的缩进
块会缩进一列，而这一列是用来表示这一行是要增加还是要删除的。
块的第一列
+号表示这一行是要加上的。
-号表示这一行是要删除的。
没有加号也没有减号表示这里只是引用的而不需要修改。
====VIM中使用Diff====
进入比较模式编辑的最简单方法就是用 "vimdiff" 命令。它如常启动 Vim，但附加一些
设置，以便于查看输入参数所指定的文件间的差异:vimdiff file1 file2 [file3 [file4]]
这等同于:vim -d file1 file2 [file3 [file4]]
你也可以使用 "gvimdiff" 或 "vim -d -g" 以启动 GUI 的版本。
又或者，使用 "viewdiff" 或 "gviewdiff" 以启动只读模式。
第二个及其后的参数也可以是目录名。Vim 将依据第一个参数所指定的文件名在指定目录
使 用 补 丁
选项 'patchexpr' 可以用来设定非标准的 "patch" 程序。
当 'patchexpr' 为空时，Vim 将这样调用 "patch" 程序:patch -o outfile origfile < patchfile
对于大多数的 "patch" 程序版本，这都可以正确工作。注意: 在一行中间的 CR 可能产
生问题。它被当做一个换行符。
如果默认值无法使工作，设定 'patchexpr' 使之有以上所述的同样的效果。它被执行
时，以下的变量会被设定为相关的文件名:
v:fname_in 原始文件
v:fname_diff 补丁文件
v:fname_out 要生成的打过补丁的文件
示例 (对应 'patchexpr' 为空时的行为):
中查找另外的文件名。这一特性仅对标准的 "diff" 命令有效。参见 'diffexpr'。
"r" 可以附加在这些名字前面，用来进入受限模式
作者:upsdn整理 更新日期:2004-12-23
来源:upsdn.net
浏览次数:
相关文章
相关评论 发表评论
- No Comments