diff和patch使用指南 Options

[猫猫草]

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文件，记录失败的地方，你可以手工修改。

[猫猫草]

Linux下patch的制作和应用

因为在u-boot移植过程中，有几处通用文件要修改，如果每次都要手动修改就太麻烦了。制作补丁可以解决这个问题。

学习资料的收集比较简单，方法一类似于这种初级问题网上资料非常丰富，google或者baidu搜索一下，然后选择有价值的资料，方法二是阅读man在线文档。完成收集工作，当然最终要在自己的Linux上作实验，比较总结，消化吸收为自己的东西。要除去这么一种错误思想：一定要学全。要知道，一次学全是不可能的，只能先学习最为常用的，在以后不断实践的过程中逐步的丰富，最终达到比较高的水平。把握的原则是：日有所学，学以致用，用以促学。

首先介绍一下diff和patch。在这里不会把man在线文档上所有的选项都介绍一下，那样也没有必要。在99％的时间里，我们只会用到几个选项。所以必须学会这几个选项。

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 选项说明在补丁文件中的“新”文件和“旧”文件现在要调换过来了（实际上就是给新版本打补丁，让它变成老版本）

下面结合具体实例来分析和解决，分为两种类型：为单个文件打补丁和为文件夹内的多个文件打补丁。

环境：在RedHat 9.0下面以armlinux用户登陆。

目录树如下：

|-- bootloader

|-- debug

|-- images

|-- kernel

|-- program

|-- rootfiles

|-- software

|-- source

|-- sysapps

|-- tmp

`-- tools

下面在program文件夹下面建立patch文件夹作为实验用，然后进入patch文件夹。

一、为单个文件进行补丁操作

1、建立测试文件test0、test1

[armlinux@lqm patch]$ cat >>test0<<EOF

> 111111

> 111111

> 111111

> EOF

[armlinux@lqm patch]$ more test0

111111

111111

111111

[armlinux@lqm patch]$ cat >>test1<<EOF

> 222222

> 111111

> 222222

> 111111

> EOF

[armlinux@lqm patch]$ more test1

222222

111111

222222

111111

2、使用diff创建补丁test1.patch

[armlinux@lqm patch]$ diff -uN test0 test1 > test1.patch

【注：因为单个文件，所以不需要-r选项。选项顺序没有关系，即可以是-uN，也可以是-Nu。】

[armlinux@lqm patch]$ ls

test0 test1 test1.patch

[armlinux@lqm patch]$ more test1.patch

************************************************************

patch文件的结构

补丁头

补丁头是分别由---/+++开头的两行，用来表示要打补丁的文件。---开头表示旧文件，+++开头表示新文件。

一个补丁文件中的多个补丁

一个补丁文件中可能包含以---/+++开头的很多节，每一节用来打一个补丁。所以在一个补丁文件中可以包含好多个补丁。

块

块是补丁中要修改的地方。它通常由一部分不用修改的东西开始和结束。他们只是用来表示要修改的位置。他们通常以@@开始，结束于另一个块的开始或者一个新的补丁头。

块的缩进

块会缩进一列，而这一列是用来表示这一行是要增加还是要删除的。

块的第一列

+号表示这一行是要加上的。

-号表示这一行是要删除的。

没有加号也没有减号表示这里只是引用的而不需要修改。

************************************************************

***diff命令会在补丁文件中记录这两个文件的首次创建时间，如下***

--- test0 2006-08-18 09:12:01.000000000 +0800

+++ test1 2006-08-18 09:13:09.000000000 +0800

@@ -1,3 +1,4 @@

+222222

111111

-111111

+222222

111111

[armlinux@lqm patch]$ patch -p0 < test1.patch

patching file test0

[armlinux@lqm patch]$ ls

test0 test1 test1.patch

[armlinux@lqm patch]$ cat test0

222222

111111

222222

111111

3、可以去除补丁，恢复旧版本

[armlinux@lqm patch]$ patch -RE -p0 < test1.patch

patching file test0

[armlinux@lqm patch]$ ls

test0 test1 test1.patch

[armlinux@lqm patch]$ cat test0

111111

111111

111111

二、为多个文件进行补丁操作

1、创建测试文件夹

[armlinux@lqm patch]$ mkdir prj0

[armlinux@lqm patch]$ cp test0 prj0

[armlinux@lqm patch]$ ls

prj0 test0 test1 test1.patch

[armlinux@lqm patch]$ cd prj0/

[armlinux@lqm prj0]$ ls

test0

[armlinux@lqm prj0]$ cat >>prj0name<<EOF

> --------

> prj0/prj0name

> --------

> EOF

[armlinux@lqm prj0]$ ls

prj0name test0

[armlinux@lqm prj0]$ cat prj0name

--------

prj0/prj0name

--------

[armlinux@lqm prj0]$ cd ..

[armlinux@lqm patch]$ mkdir prj1

[armlinux@lqm patch]$ cp test1 prj1

[armlinux@lqm patch]$ cd prj1

[armlinux@lqm prj1]$ cat >>prj1name<<EOF

> ---------

> prj1/prj1name

> ---------

> EOF

[armlinux@lqm prj1]$ cat prj1name

---------

prj1/prj1name

---------

[armlinux@lqm prj1]$ cd ..

2、创建补丁

[armlinux@lqm patch]$ diff -uNr prj0 prj1 > prj1.patch

[armlinux@lqm patch]$ more prj1.patch



diff -uNr prj0/prj0name prj1/prj0name

--- prj0/prj0name 2006-08-18 09:25:11.000000000 +0800

+++ prj1/prj0name 1970-01-01 08:00:00.000000000 +0800

@@ -1,3 +0,0 @@

---------

-prj0/prj0name

---------

diff -uNr prj0/prj1name prj1/prj1name

--- prj0/prj1name 1970-01-01 08:00:00.000000000 +0800

+++ prj1/prj1name 2006-08-18 09:26:36.000000000 +0800

@@ -0,0 +1,3 @@

+---------

+prj1/prj1name

+---------

diff -uNr prj0/test0 prj1/test0

--- prj0/test0 2006-08-18 09:23:53.000000000 +0800

+++ prj1/test0 1970-01-01 08:00:00.000000000 +0800

@@ -1,3 +0,0 @@

-111111

-111111

-111111

diff -uNr prj0/test1 prj1/test1

--- prj0/test1 1970-01-01 08:00:00.000000000 +0800

+++ prj1/test1 2006-08-18 09:26:00.000000000 +0800

@@ -0,0 +1,4 @@

+222222

+111111

+222222

+111111



[armlinux@lqm patch]$ ls

prj0 prj1 prj1.patch test0 test1 test1.patch

[armlinux@lqm patch]$ cp prj1.patch ./prj0

[armlinux@lqm patch]$ cd prj0

[armlinux@lqm prj0]$ patch -p1 < prj1.patch

patching file prj0name

patching file prj1name

patching file test0

patching file test1

[armlinux@lqm prj0]$ ls

prj1name prj1.patch test1

[armlinux@lqm prj0]$ patch -R -p1 < prj1.patch

patching file prj0name

patching file prj1name

patching file test0

patching file test1

[armlinux@lqm prj0]$ ls

prj0name prj1.patch test0

－－－－－－－－－－－－－－－－－－－

总结一下：

单个文件

diff –uN from-file to-file >to-file.patch

patch –p0 < to-file.patch

patch –RE –p0 < to-file.patch

多个文件

diff –uNr from-docu to-docu >to-docu.patch

patch –p1 < to-docu.patch

patch –R –p1 <to-docu.patch

－－－－－－－－－－－－－－－－－－－

三、应用

为内核打补丁。前面在创建交叉编译工具链时，其中有一步就是为内核打补丁。当时还不是特别了解，现在很清晰了。参考前面的文章《基于ARM+Linux嵌入式开发的开发工具链的建立》。

1、首先是解压，因为发布的补丁文件都是使用gzip压缩的。

$gunzip ../setup-dir/ patch-2.4.21-rmk1.gz

2、然后进入你的内核源代码目录

$cd linux-2.4.21

3、打补丁

$patch –p1 < ../../setup-dir/patch-2.4.21-rmk1

打完补丁后，需要检查一下有没有拒绝执行的文件，即检查.rej文件的存在。使用命令：

$find . -name *.rej

如果发现，会将其输出到标准输出终端，默认屏幕。当然，你也可以采用重定向，输出到指定文件，比如reject。

$fine . -name *.rej >reject

然后可以查看reject的内容了。