補丁(patch)的製作與應用
出自Linux Wiki
如果hack了開源代碼,為了方便分享(如提交Bug)或自己留存使用,一般都要製作一個補丁(Patch)。在從源碼安裝軟體時,也難免要應用些別人做好的補丁。本文介紹如何製作和應用補丁。[1]
目錄 |
命令簡介
用到的兩個命令是diff和patch。
diff
diff可以比較兩個東西,並可同時記錄下二者的區別。製作補丁時的一般用法和常見選項為:
diff 【选项】 源文件(夹) 目的文件(夹)
- -r
- 遞歸。設置後diff會將兩個不同版本源代碼目錄中的所有對應文件全部都進行一次比較,包括子目錄文件。
- -N
- 選項確保補丁文件將正確地處理已經創建或刪除文件的情況。
- -u
- 輸出每個修改前後的3行,也可以用-u5等指定輸出更多上下文。
- -E, -b, -w, -B, --strip-trailing-cr
- 忽略各種空白,可參見文檔,按需選用。
patch
patch的作用則是將diff記錄的結果(即補丁)應用到相應文件(夾)上。最常見的用法為:
patch -pNUM <patchfile>
- -p Num
- 忽略幾層文件夾,隨後詳解。
- -E
- 選項說明如果發現了空文件,那麼就刪除它
- -R
- 取消打過的補丁。
為了解釋 -p 參數,需要看看如下patch文件片段:
--- 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。
應用
利用以上命令,處理單個文件補丁的方法:
# 产生补丁 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 # 打补丁 cd to-docu patch -p1 < to-docu.patch # 取消补丁 patch -R -p1 <to-docu.patch
另外,使用版本控制工具時,可以直接用svn diff或git diff生成補丁文件。
值得一提的是,由於應用補丁時的目標代碼和生成補丁時的代碼未必相同,打補丁操作可能失敗。補丁失敗的文件會以.rej結尾,下面命令可以找出所有rej文件:
find . -name '*.rej'
patch文件構成
補丁文件里到底存儲了哪些信息呢?看看這個例子:
--- 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
- 補丁頭
- 補丁頭是分別由---/+++開頭的兩行,用來表示要打補丁的文件。---開頭表示舊文件,+++開頭表示新文件。
- 一個補丁文件中的多個補丁
- 一個補丁文件中可能包含以---/+++開頭的很多節,每一節用來打一個補丁。所以在一個補丁文件中可以包含好多個補丁。
- 塊
- 塊是補丁中要修改的地方。它通常由一部分不用修改的東西開始和結束。他們只是用來表示要修改的位置。他們通常以@@開始,結束於另一個塊的開始或者一個新的補丁頭。'-'後的數字代表該塊在舊文件的行號,修改前該塊總行數;'+'後的數字代表該塊在新文件的行號,修改後該塊總行數。
- 塊的縮進
- 塊會縮進一列,而這一列是用來表示這一行是要增加還是要刪除的。
- 塊的第一列
- +號表示這一行是要加上的。-號表示這一行是要刪除的。沒有加號也沒有減號表示這裡只是引用的而不需要修改。
實例分析
單文件補丁
設當前目錄有文件 test0:
111111 111111 111111
和文件test1:
222222 111111 222222 111111
使用diff創建補丁test1.patch
diff -uN test0 test1 > test1.patch
因為是單個文件,故不需要 -r 選項。此命令得到如下補丁:
--- 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
要應用補丁,只需:
$ patch -p0 < test1.patch patching file test0
此時test0就和test1一樣了。
如果要取消補丁做出的更改,恢復舊版本:
$ patch -RE -p0 < test1.patch patching file test0
文件夾補丁
設有如下環境:
--prj0/ test0 prj0name --prj1/ test1 prj1name
prj0/prj0name內容為如下三行:
-------- prj0/prj0name --------
prj1/prj1name內容為如下三行:
-------- prj1/prj1name --------
用 diff -uNr 創建補丁,
diff -uNr prj0 prj1 > prj1.patch
得到的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
如果要應用此補丁,則:
$ ls prj0 prj1 prj1.patch $ cd prj0 $ patch -p1 < ../prj1.patch patching file prj0name patching file prj1name patching file test0 patching file test1
此時可用ls看到打補丁後的結果:
$ ls
prj1name test1
類似的,如果要回滾補丁操作:
$ patch -R -p1 < ../prj1.patch patching file prj0name patching file prj1name patching file test0 patching file test1 $ ls prj0name test0