如何用 git 命令生成 Patch 和打 Patch（git format-Patch 和 git am）

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

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

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

對單個文件或者多個文件，diff 和 patch 這兩個文件比較方便。對於 git 這種以 project 爲單位的修改，尤其是涉及到多個文件夾下的多個文件的改動時，就很不方便
無法保存 commit 的信息。

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

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

可以保存 commit 信息。
能夠靈活的獲取 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 文件的方式解決衝突。值得注意的是，.rej 文件描述的是現有的源文件與 patch 文件發生衝突的部分，即因爲文件的哪裏不一樣導致 patch 打不上去，同時也有 patch 所沒打上的 change。關於如何讀懂. rej 文件，這裏有一個很好的例子：https://qa.1r1g.com/sf/ask/38002681/

(3) 廢棄上一條 am 命令已經打了的 patch：git am --abort

(4) 重新打 patch：git am ~/patch-set/*.patchpatch

方案二：

(2) 根據. rej 文件，通過編輯發生衝突的 code 文件的方式解決衝突。

(3) 將該 patch 涉及到的所有文件（不僅僅是發生衝突的文件）通過命令 git add <file_name > 添加到工作區中

(4) 告訴 git 衝突已經解決，繼續打 patch: git am --resolved (git am --resolved 和 git am --continue 是一樣的)

分析：方案一和方案二主要區別是解決衝突的方法不一樣。方案一是通過編輯 patch 文件的方式解決衝突，方案二是通過編輯衝突 code 文件的方式解決衝突。這兩種方案區別比較大：經過實驗，核心區別在於，方案一在修改 patch 時，如果修改的地方比較多, patch 可能就打不上了，因爲 patch 文件裏對改動的行和列，以及修改了幾個字符有精確的描述，很可能你改了想改的代碼，卻不符合描述了，就無法 apply 上 Patch。方案二無法驗證衝突有沒有切實的解決。即使你在方案二的第二步亂改一通，也能 “打完” 發生衝突的 patch（並沒有檢測修改後的 code 文件跟 patch 期望的是否相同）。因此，如果採用方案二，那麼再解決 code 文件衝突後，需要人工去確認修改的正確性。

來源網絡：https://www.cnblogs.com/ArsenalfanInECNU/p/8931377.html

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/Cg0Zr9BECdXMTHMxsp61Pw

猜你喜歡