解析linux patch

来自个人维基
跳转至: 导航搜索

Patch的主要用途是给代码打补丁,修正已知的错误,或者作为一种调试手段来调试有问题的代码,发现问题和验证修正的结果。

Patch 过程分三个大的步骤:一是用diff工具比较新旧代码,生成patch文件;二是使用patch命令,将patch文件合并到原有代码;三是检查有无无法patch的文件,修改或重新选择是否对其做patch。patch打完了就可以直接编译了。

patch对应到的主要命令有两个,diff和patch。至于检查结果,在linux环境下使用ls命令或者find命令查看有无rej类型的文件就可以了。

现实中常见的做法,是在makefile中加入patch命令,在编译过程中做好代码的patch,然后编译代码。


diff 命令常用选项

以下面的命令作为例子:

   $:diff -uNr orginal_proj updated_proj > test.patch 

其中,-u 表示使用unified output format,统一输出格式,比较紧凑而且易读;

-N 用来处理新增的文件(此时参数对应的是目录)

-r 表示递归处理所有的子目录。

整条命令的意思是,递归比较original和updated两个工程中的所有文件,使用统一的输出格式,添加新增的文件,生成结果输出到 test.patch文件中。

其他常用的选项还有:-p 仅针对C程序有效,显示每个不同所对应的函数;-i 忽略大小写,对于大小写不敏感的场合使用,比如某些html文件;–exclude 表示排除某些文件或者目录,不做比较,适用于如代码包含cvs目录之类的场合。剩下的其他参数可以参考info或者help或者man。


patch文件的格式

上个例子中生成的文件是统一输出格式的,比较紧凑而且易读。举个例子,##是我加的注释:

   --- autoconf-2.7/acgeneral.m4 Wed Nov 22 11:42:00 1995     ## 旧文件
   +++ autoconf-2.9/acgeneral.m4 Sat Mar 16 15:53:07 1996    ## 新文件
   @@ -1,7 +1,7 @@   ##  第一段不同的地方,旧文件从1行开始,共7行;新文件从1行开始,共7行
   dnl Parameterized macros.  ## 无+—符号,是引用的内容
   dnl Requires GNU m4.
   dnl This file is part of Autoconf.
   -dnl Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.  ## 删除的内容
   +dnl Copyright (C) 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc. ## 替换的内容
   dnl
   dnl This program is free software; you can redistribute it and/or modify
   dnl it under the terms of the GNU General Public License as published by
   @@ -51,7 +51,7 @@     ## 第二段不同之处
   divert(-1)dnl Throw away output until AC_INIT is called.
   changequote([, ])
   -define(AC_ACVERSION, 2.7)
   +define(AC_ACVERSION, 2.9)
   dnl Some old m4′s don’t support m4exit. But they provide
   dnl equivalent functionality by core dumping because of the

从刚才的diff命令的例子可以看到,一个patch文件中可能包含整个工程中所有不同文件的比较结果,因此,必须区分具体的文件路径和文件名,以及单一文件中多个不同之处的情况。统一输出格式中,使用---表示旧文件,使用+++表示新文件;文件中的多个不同的文本或代码段,使用@@开始,@@结束的一行来开始;中间的内容是新旧文件的起始行数和本段比较包含的函数,空格做分隔。每段中,无-+符号的是引用的行,有-号的是删除的行,有+号的是新增的行。这样就可以区分开这些情况了。

diff命令还可以生成非统一格式的patch文件,但可读性非常差,所以从编程的角度讲,一定是使用unified output format比较合理。这里就不做说明了,有兴趣的可以使用diff文件的-c选项来生成一份看看,网上也有些介绍。


patch命令常用选项

以下面的命令做例子:

   $:patch -lNp0 < test.patch

其中, -l的意思–ignore-whitespace,忽略空白字符;-N 表示 –forward,忽略已经打过或者已经取消的补丁(ignore patches that seem to be reversed or already applied);-pnum 表示–strip=num,如果没有num参数,表示直接使用文件名,0表示全路径名,其他表示从左开始去除几个slash到,哪一级目录(cut slash count).

整条命令的意思是,使用test.patch文件作为输入,忽略空白符号和已经处理过的补丁,保留patch文件中的包含文件的全路径名,对patch文件涉及到的文件做补丁。

其他常用的选项有:-i 指定使用的patch文件名,代替常用的命令行重定向;-R 反转(取消)patch。其他的可以查看帮助。


参考文档:

http://samever.com/archives/330