Mercurial MQ 補齊 git stage

by thinker

關鍵字:

最近 git 實在是如雷灌耳，到處都有人在說 git 有多強，有多快。對我這個已經習慣 Mercurial 的劣者而言，實在不懂 git 到底是好在哪。說到速度，小 project 是沒什麼差，大 project 而言，不管是 git 或 hg ，主要 bottleneck 還是卡在網路和 disk I/O。快? 似乎差不了多少。不可否認，用 $Python$ implement 的 hg ，在速度上是吃虧的。

說到功能強大， git 是提供了一堆功能。但，大部分功能不是必要的，可以由幾個主要功能組成相同的結果。另一方面， hg 則只提供必要的功能。兩者之間的差異，有些類似 Windows 和 UN*X 的差異。一則功能豐富、包山包海，一則小巧精幹、容易組合$應用$。也就是說， git 所提供的豐富功能，有很大一部分只是其它主要功能的組合，也就是沒有存在的必要性。但 git 傾向於將這些程序變成一項單一的功能，有點像 Windows 下的 application ，希望包山包海，最好是每個功能都是一個 button 按下去就可以用。相反的， hg 比較像 UN*X ，只提供必要的功能。透過 script 的組合，能用精簡的功能組合完成複雜的工作。總體來說， hg 功能面的 orthogonal 程度較高，而 git 則是功能豐富。那一種形式好呢? 基於 KISS 原則，我較認同 hg 。

我最常聽到 git 的好，就是 git 有 stage 的功能。 stage 能暫存您手頭的工作，在不同的工作之間切換，直到適當的時機才 commit 到 repository 。這個功能確實是很吸引人，能夠幫 programmer 省下很多事。然而，既然 hg 沒有 stage 的概念， hg user 就理所當然的無法享受相同的方便嗎? 事實上， hg user 可以借用 MQ 的功能，來完成一樣的效果。

linkname:MQ http://www.selenic.com/mercurial/wiki/index.cgi/MqTutorial 是 hg 內建的 extension ，user 不用另外安裝，只需啟用即可。 MQ 原本的設計目的是用來管理 patches ，功能和 guilt 相同。 MQ 能讓 user 建立一系列的 patch ，並讓你決定 apply patches 的順序。於是你可以測試各個 patch 的功能，並在測試不同 patch 階段的內容。

== 啟用 MQ ==
除了管理外來 patch 之外， MQ 也可以用來產生自已的 patch 。 hg user 可以使用 MQ 來取代 stage ，達到一樣的效果。假設，我們已有一個 repository ，下面有
* foo.txt
* bar.txt
兩個檔案。接下來，我們要開始修改這個 repository 的內容。在開始之前我們先啟用 MQ 。請在 $$HOME/.hgrc 或 repository 的 .hg/hgrc 裡加入下列設定:
{{{
[extensions]
hgext.mq =
}}}
存檔後，執行 hg help 就能看到 MQ 提供的功能。

接著，要為 MQ 初使化 repository ，在 working directory 裡執行
{{{
hg qinit
}}}
如此就可以在該 repository 裡使用 MQ 的功能。

== 開始修改 ==
在開始修改之前，我們執行
{{{
$$ hg qnew test1.patch
}}}
以增加一個新的 patch ，稱為 test1.patch 。接著，我們可以開始修改 working directory 的內容，並將修改的結果存成 patch。

我們先進行一次修改，並將結果存成 patch。
{{{#!raw
$$ echo "hello" >> foo.txt
$$ echo "world" >> bar.txt
$$ hg qrefresh
}}}
hg qrefresh 指令的效果就像 hg commit ，但將修改存入 patch 檔，而不是直接存入 repository 裡。
在修改過一陣子之後，我們可能會需要另一個新的 patch ，以將不同功能分開。這時，可以再次使用
{{{
$$ hg qnew test2.patch
}}}
這時就又多了一個 patch 。在更改程式碼之後，新的修改會記錄在 test2.patch 這個 patch 裡。
{{{#!raw
$$ echo "another" >> foo.txt
$$ echo "new file" >> cool.txt
$$ hg add cool.txt
$$ hg qrefresh
}}}
hg qrefresh 會將 foo.txt 的修改和新加入的 cool.txt 記錄在 test2.patch 裡。
這時，在 .hg/patches/ 裡可以看到 test1.patch 和 test2.patch 這兩個檔案，內容是 unified cotext 的 diff 格式。

我們能將一個 patch 進行多次的修改和 refresh 。因此， programmer 能修改小部分的程式碼，並將完成的修改持續、多次的記錄在 patch 裡。例如:
{{{#!raw
$$ echo "line" >> cool.txt
$$ hg qrefresh
}}}
新的修改會加入 test2.patch 。因此，你可以無限次數的加入新的內容。每次 refresh 時，也可同時修改 log。
{{{
$$ hg qrefresh -m 'this is a log'
}}}
或透過
{{{
$$ hg qrefresh -e
}}}
會呼叫 text editor ，讓 user 修改 log 的內容。因此，不用等完整的修改完成後，才進行儲存。而 log 也可以分次，一點一點的加入。

透過
{{{
$$ hg qdiff
}}}
可以顯示目前 patch 的內容，並包括 working directory 裡尚未 refresh 的新修改。如果只想顯示尚未 refresh 的新修改，可透過
{{{
$$ hg diff
}}}

== 目前的 patch set ==
如果我們用 hg qseries 就可以看到目前有兩個 patch 在 queue 裡。
{{{
$$ hg qseries
test1.patch
test2.patch
}}}
代表 queue 裡有兩個 patch ， test1.patch 和 test2.patch 。 MQ 會依序 apply queue 裡的 patch ，但使用者可以決定要 apply 至那個 patch 為止。例如:
{{{
$$ hg qpop
}}}
就可以暫時移除最後 apply 的 patch 。假設原本已 apply test1.patch 和 test2.patch ，則這動作能將test2.patch 暫時不 apply。再做一次相同動作，則會更近一步移除 test1.patch 。而
{{{
$$ hg qpush
}}}
則是相反的動作。例如，queue 裡有 test1.patch 和 test2.patch 兩個 patch ，但只 apply test1.patch。這時做 hg qpush ，則會重新 apply test2.patch。透過 hg qpop 和 hg qpush ，user 可以在 patch 之間來來回回，測試各階段的結果。

== 完成修改 ==
在完成所有的修改之後，我們以將結果正式 commit 至 repository 。
{{{
$$ hg qfinish -a
}}}
如此就可以 commit 所有的 patch ，每個 patch 變成一個新的 changeset 。

如果 user 希望將數個小 patch 整合成一個 changeset ，那麼可以透過 hg qfold 。假設你有 test1.patch 、 test2.patch 和 test3.patch ，而你目前只 apply test1.patch 和 test2.patch ，則可執行下面指令:
{{{
$$ hg qfold test3.patch
}}}
將 test3.patch 和目前的 test2.patch 進行合併。合併完成後， test3.patch 會被刪除。

== 切換 patch set ==
當一個修改項目進行到一半，卻必需暫時轉到另一個修改時，可以透過
{{{
$$ hg qsave -c -e
}}}
先目前 queue 裡所有的 patch file， 儲存在一個新的目錄，並將目前的 queue 清空。這時你可以進行新的修改。在開始新修改之前，你必需先 update working 至你要修改的 changeset。如果沒做這個動作，新的修改會基於前面 patch 的結果。例如:
{{{
$$ hg update -$C$ -r 0
}}}
先回到第一個 changeset 。接著，你以 new 一個新的 patch :
{{{
$$ hg qnew another_bug_fix.patch
}}}
接著開始修改。

如果你在新修改進行到一半時，想切換回原本的工作。請如之前的作法，先將 queue 裡的 patch 儲存起來。如:
{{{
$$ hg qsave -c -e
}}}
在完成這個動作時，你會發現每一個 hg qsave 的動作都會在 repository 裡加入一筆新的 changeset。例如:
{{{#!raw
changeset:   4:f36d91bdde05
tag:         tip
user:        $Thinker$ K.F. Li <thinker@branda.to>
date:        Sat Jan 24 12:24:29 2009 +0800
summary:     hg patches saved state
}}}
假設你之前儲起來的 queue 是編號 4 ，你可以透過下面指令，使 queue 回到該次儲存的狀態。
{{{
$$ hg qrestore -d 4
}}}
如此 patch queue 的狀態就會回到該次儲存時的狀態。但該 changeset 也會被刪除 (-d)。

== 最後 ==
透過 MQ 的使用，其實也可以有 stage 相同的功能。但， MQ 似乎還不夠穩定，有時會出現一些狀況。希望 MQ 能快速的穩定下來。另外， MQ 產生的 changeset ，例如 qsave 產生的 changeset ，在 push 時會被傳送出去。雖然這讓我手癢，有動手修改的衝動，但必竟還是要自我克制。希望未來能夠加上 local changeset 的功能，像是加上 local 的 tag ，push 時就不會被傳送出去。

最後更新時間: 2009-01-25 17:50:57 CST | 引用

查詢:

COMMENTS:

on 2009-01-25 22:47:33 CST

keitheis said ..

太讚了，我之前玩的時候不知道 qfinish，結果搞半天。qfold 看來也不錯用。大感謝。

on 2009-01-28 22:21:33 CST

yungyuc said ..

感謝 thinker 大大教會我用 mq! 不過 applied patches 會進入 repository，不小心 push 的時候還是會出問題，這有點討厭