如何用git命令生成Patch和打Patch


在程序員的日常開發與合作過程中,對於code的生成patch和打patch(應用patch)成為經常需要做的事情。

  • 什么是patch?簡單來講,patch中存儲的是你對代碼的修改
  • 什么是生成patch?生成patch就是記錄你對代碼的修改並將其保存在patch文件中
  • 什么是打patch?打patch就是將patch文件中對代碼的修改,應用到源代碼,從而把對代碼的修改應用到code中。

盡管本身Linux命令里有diff和patch兩個命令可以生成patch和打patch。但是有兩個缺點值得注意:

1. 對單個文件或者多個文件,diff和patch這兩個文件比較方便。對於git這種以project為單位的修改,尤其是涉及到多個文件夾下的多個文件的改動時,就很不方便

2. 無法保存commit的信息。

 

因此,推薦大家使用git的format-patch和am命令進行生成patch和打patch,用此方法獲得的patch其實就是commit里提交的code修改以及commit信息。有如下好處

1. 對於git這種以project為單位的修改,尤其是涉及到多個文件夾下的多個文件的改動時,非常方便,能夠記錄所有的改動(添加,修改,刪除文件等)

2. 可以保存commit信息。

3. 能夠靈活的獲取patch。可以獲取任意兩個commit之間的patch集。

 

使用方法(直接給一些examples):

git format-patch

$ git format-patch HEAD^                 #生成最近的1次commit的patch

$ git format-patch HEAD^^               #生成最近的2次commit的patch

$ git format-patch HEAD^^^              #生成最近的3次commit的patch

$ git format-patch HEAD^^^^                  #生成最近的4次commit的patch

$ git format-patch <r1>..<r2>                                              #生成兩個commit間的修改的patch(包含兩個commit. <r1>和<r2>都是具體的commit號)
$ git format-patch -1 <r1>                                                   #生成單個commit的patch
$ git format-patch <r1>                                                       #生成某commit以來的修改patch(不包含該commit)
$ git format-patch --root <r1>               #生成從根到r1提交的所有patch
 
git am
$ git apply --stat 0001-limit-log-function.patch         # 查看patch的情況
$ git apply --check 0001-limit-log-function.patch        # 檢查patch是否能夠打上,如果沒有任何輸出,則說明無沖突,可以打上
(注:git apply是另外一種打patch的命令,其與git am的區別是,git apply並不會將commit message等打上去,打完patch后需要重新git add和git commit,而git am會直接將patch的所有信息打上去,而且不用重新git add和git commit,author也是patch的author而不是打patch的人)
$ git am 0001-limit-log-function.patch                                # 將名字為0001-limit-log-function.patch的patch打上
$ git am --signoff 0001-limit-log-function.patch                  # 添加-s或者--signoff,還可以把自己的名字添加為signed off by信息,作用是注明打patch的人是誰,因為有時打patch的人並不是patch的作者
$ git am ~/patch-set/*.patch             # 將路徑~/patch-set/*.patch 按照先后順序打上
$ git am --abort                                                                   # 當git am失敗時,用以將已經在am過程中打上的patch廢棄掉(比如有三個patch,打到第三個patch時有沖突,那么這條命令會把打上的前兩個patch丟棄掉,返回沒有打patch的狀態)
$ git am --resolved                                                             #當git am失敗,解決完沖突后,這條命令會接着打patch
 
如果打Patch的過程中發生了沖突(conflicts),怎么辦?
解決patch沖突的過程是:
如果不想打這一系列patch了,直接:git am --abort。
如果還想打, 有兩種解決方案:
方案一(個人推薦):
(1) 根據git am失敗的信息,找到發生沖突的具體patch文件,然后用命令git apply --reject <patch_name>,強行打這個patch,發生沖突的部分會保存為.rej文件(例如發生沖突的文件是a.txt,那么運行完這個命令后,發生conflict的部分會保存為a.txt.rej),未發生沖突的部分會成功打上patch
(2) 根據.rej文件,通過編輯該patch文件的方式解決沖突。
(3) 廢棄上一條am命令已經打了的patch:git am --abort
(4) 重新打patch:git am ~/patch-set/*.patchpatch
方案二:
(1) 根據git am失敗的信息,找到發生沖突的具體patch文件,然后用命令git apply --reject <patch_name>,強行打這個patch,發生沖突的部分會保存為.rej文件(例如發生沖突的文件是a.txt,那么運行完這個命令后,發生conflict的部分會保存為a.txt.rej),未發生沖突的部分會成功打上patch
(2) 根據.rej文件,通過編輯發生沖突的code文件的方式解決沖突。
(3) 將該patch涉及到的所有文件(不僅僅是發生沖突的文件)通過命令git add <file_name>添加到工作區中
(4) 告訴git沖突已經解決,繼續打patch: git am --resolved (git am --resolved 和 git am --continue是一樣的)
 
分析:方案一和方案二主要區別是解決沖突的方法不一樣。方案一是通過編輯patch文件的方式解決沖突,方案二十通過編輯沖突code文件的方式解決沖突。這兩種方案區別比較大:經過實驗,核心區別在於,方案二無法驗證沖突有沒有切實的解決。即使你在方案二的第二步亂改一通,也能“打完”發生沖突的patch(並沒有檢測修改后的code文件跟patch期望的是否相同)。因此,如果采用方案二,那么再解決code文件沖突后,需要人工去確認修改的正確性。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM