Differences between revisions 1 and 12 (spanning 11 versions)
⇤ ← Revision 1 as of 2009-08-25 13:58:32 →
Size: 8347
Editor: YuyaNishihara
Comment: Translated MqExtension to Japanese
← Revision 12 as of 2012-12-14 15:38:53 → ⇥
Size: 9837
Editor: YuyaNishihara
Comment: sync with MqExtension@60 and update translation
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
''このページは MqExtension の日本語訳です。''
Line 13: Line 11:
通常、分散開発モデルでは [[ChangeSet|changeset]] を変更できません。 一度 [[Commit|commit]] したものは、プロジェクトの履歴に永久に残ることになります。 これでは、プロジェクトメンテナに提出する一連の変更を作るのが面倒でしょう。 開発 [[Repository|repository]] では時とともに [[Merge|merge]] が繰り返され、コードが成熟するにつれ、そこには長い変更の記録が現れます。 この履歴は開発者本人にとっては重要ですが、アップストリームに提出された時には非常にレビューしづらいものになるでしょう。

Andrew Morton はかつて、カーネル [[Patch|patch]] を [[SCM]] の外部で管理するためのスクリプト一式を書きました。 そのスクリプトが拡張され、 [[http://savannah.nongnu.org/projects/quilt|quilt]] というスイートへ発展しました。 quilt の基本的な考えは、ソースファイルの代わりにパッチを管理するということです。 パッチは追加、削除、順序変更可能で、バグを直した場合や新しいバージョンへ追従した場合に更新(refresh)されます。 quilt はとても強力ですが、下層の SCM ツールと統合されていません。 そのため、変更内容を可視化するのは面倒です。		 通常、分散開発モデルでは [[ChangeSet|changeset]] を変更できません。 一度 [[Commit|commit]] したものは、プロジェクトの履歴に永久に残ることになります。 これでは、プロジェクトメンテナに提出する一連の変更を作るのが面倒でしょう。 コードが成熟するにつれて、開発 [[Repository|repository]] には長い [[Merge|merges]] と変更の履歴が蓄積されます。 この履歴は開発者本人にとっては重要ですが、アップストリームに提出された時には非常にレビューしづらいものになるでしょう。

Andrew Morton はかつて、カーネル [[Patch|patch]] を SCM の外部で管理するためのスクリプト一式を書きました。 そのスクリプトが拡張され、 [[http://savannah.nongnu.org/projects/quilt|quilt]] というスイートへ発展しました。 quilt の基本的な考えは、ソースファイルの代わりにパッチを管理するということです。 パッチは追加、削除、順序変更可能で、バグを直した場合や新しいバージョンへ追従した場合に更新(refresh)されます。 quilt はとても強力ですが、下層の SCM ツールと統合されていません。 そのため、変更内容を可視化するのは面倒です。
Line 20: Line 18:
以下の行を設定ファイル([[.hgrc]])へ追加し、エクステンションを有効にしてください: 以下の行を設定ファイル([[.hgrc]] or Mercurial.ini)へ追加し、エクステンションを有効にしてください:
Line 24: Line 22:
hgext.mq = mq =
Line 29: Line 27:
エクステンションを正しくインストールすると、 hg help に mq 系コマンドが追加されているはずです。 コマンド名は q で始まり、 quilt のコマンドをできるだけ真似ています。 パッチキューは .hg/patches というディレクトリにあります。 パッチファイル自体を編集し、 Mercurial のコミットメッセージとして使われるコメントを変更することができます。 .hg/patches/series はパッチ適用順のリストです。 series ファイル内の順序を変えるだけで、パッチの順序を変更可能です。 series ファイルを編集する時は、適用中のパッチの項目を変更しないように注意してください。 エクステンションを正しくインストールすると、 hg help に mq 系コマンドが追加されているはずです。 コマンド名は q で始まり、 quilt のコマンドをできるだけ真似ています。 パッチキューは .hg/patches というディレクトリにあります。 .hg/patches/series はパッチ適用順のリストです。 series ファイル内の順序を変えるだけで、パッチの順序を変更可能です。 series ファイルを編集する時は、適用中のパッチの項目を変更しないように注意してください。
Line 33: Line 31:
[[MqMerge]] で詳しく説明します。 [[JapaneseRebaseExtension|Rebase エクステンション]] を使うと、一連のパッチをアップストリームの最新ヘッドとマージするのがかなり楽になります。たいていの場合、やることはたったのこれだけです:

{{{
$ hg pull
$ hg rebase -s <rev1> -d <rev2>
}}}
このコマンドは、 rev1 (要は mq に紐付いた最も古い適用済みリビジョン)とその子孫を、 rev2 (pull したばかりの最新ヘッド)へリベースします。必要に応じてマージが行われます。リベースしたいパッチは適用済みでなければなりません。 qpop したパッチは対象になりませんから。リベース後も、一連のリビジョンは依然として mq に紐付いており、 mq で管理された先のリビジョンへ戻って編集することができます。
Line 53: Line 57:
Mercurial 2.1 以降では、 [[#A.2BMNEwwzDBMK0w5TD8MG5ZCWb0MJJeODBr_secret_.2BMNUwpzD8MLowazBZMIs-|mq secret フェーズサポート]] を使ってみるとよいでしょう。
Line 55: Line 61:
Line 58: Line 65:
# パッチキュー・ディレクトリをセットアップ # パッチキュー・ディレクトリをセットアップ (Mercurial 1.5 で非推奨に)
Line 117: Line 124:
hg qdelete -r qbase:qtip
}}}

訳注: `hg qfinish -a` のほうが良いと思われます。 -- YuyaNishihara <<DateTime(2009-08-25T13:17:20Z)>>		 hg qfinish -a
}}}
Line 124: Line 129:
hg diff -r $(hg parents -r qbase --template '#rev#') -r qtip hg diff -r qparent:qtip
Line 133: Line 138:

訳注: バイナリファイルを mq で管理する場合は、必ず git 拡張フォーマットを指定してください。 -- YuyaNishihara <<DateTime(2009-08-25T13:17:20Z)>>
Line 152: Line 155:
=== Publishing patches === === パッチのコミットメッセージを更新 ===
1 行メッセージを書き換えるだけなら、こうしてください:
{{{
hg qrefresh -m "新しいメッセージ"
}}}
メッセージが複数行に及ぶ場合はこうです:
{{{
hg qrefresh -e
}}}
$EDITOR が開くのでコミットメッセージを編集してください。

=== パッチの公開 ===
Line 173: Line 187:
=== パッチキューの変更を常に secret フェーズにする ===
[[https://groups.google.com/d/msg/mercurial_general/cr2rWYeloUo/gAWq-ePGyPUJ|互換性の問題で]] 、 mq パッチはデフォルトで secret [[Phases|phase]] になりません。つまり、パッチを他のリポジトリとやり取りできてしまいます。たいていこれは好ましくありませんから、設定で secret フェーズサポートを有効にできるようになっています:
{{{
[mq]
secret = True
}}}
Line 175: Line 196:
[[Strip|strip]] コマンドはパッチキューをはっきりとは使いませんが、 mq エクステンションの一部です。 [[Cmd:strip|strip コマンド]]はパッチキューをはっきりとは使いませんが、 mq エクステンションの一部です。
Line 181: Line 202:
 * MqTutorial, MqMergePatches, MqMerge

== 外部リンク ==
Line 182: Line 207:
 * http://blogs.sun.com/ace/entry/mq_mercurial_queues
Line 185: Line 210:

[[MqExtension|English]]

Mercurial Queues エクステンション

現在、このエクステンションは Mercurial とともに配布されています。

作者: Chris Mason

Contents

  1. まえがき
  2. 設定
  3. Mercurial Queues の利用
  4. パッチを新しいアップストリーム・バージョンとマージ
  5. チュートリアル
  6. フックの例
  7. コマンドの例
  8. 小ワザ
    1. 適用中のパッチを全て E-Mail
    2. 適用中のパッチを恒久なチェンジセットへ変換
    3. 適用中のパッチを1つのパッチにまとめて出力
    4. パッチを常に git 拡張フォーマットに
    5. qrefresh でタイムスタンプを更新しない
    6. qstatus コマンドの追加方法
    7. パッチのコミットメッセージを更新
    8. パッチの公開
    9. パッチキューの変更を常に secret フェーズにする
  9. Strip
  10. 関連項目
  11. 外部リンク

1. まえがき

通常、分散開発モデルでは changeset を変更できません。 一度 commit したものは、プロジェクトの履歴に永久に残ることになります。 これでは、プロジェクトメンテナに提出する一連の変更を作るのが面倒でしょう。 コードが成熟するにつれて、開発 repository には長い merges と変更の履歴が蓄積されます。 この履歴は開発者本人にとっては重要ですが、アップストリームに提出された時には非常にレビューしづらいものになるでしょう。

Andrew Morton はかつて、カーネル patch を SCM の外部で管理するためのスクリプト一式を書きました。 そのスクリプトが拡張され、 quilt というスイートへ発展しました。 quilt の基本的な考えは、ソースファイルの代わりにパッチを管理するということです。 パッチは追加、削除、順序変更可能で、バグを直した場合や新しいバージョンへ追従した場合に更新(refresh)されます。 quilt はとても強力ですが、下層の SCM ツールと統合されていません。 そのため、変更内容を可視化するのは面倒です。

パッチキュー・エクステンションは quilt の機能を Mercurial と統合します。 変更内容は Mercurial にコミットされたパッチとして管理されます。 コミットは削除、順序変更可能で、 下位のパッチは working directory への変更をもとに更新(refresh)されます。 パッチディレクトリもバージョン管理下へ置くことができ、パッチへの変更を別個の履歴として管理することができます。

2. 設定

以下の行を設定ファイル(.hgrc or Mercurial.ini)へ追加し、エクステンションを有効にしてください: 

[extensions]
mq =

3. Mercurial Queues の利用

エクステンションを正しくインストールすると、 hg help に mq 系コマンドが追加されているはずです。 コマンド名は q で始まり、 quilt のコマンドをできるだけ真似ています。 パッチキューは .hg/patches というディレクトリにあります。 .hg/patches/series はパッチ適用順のリストです。 series ファイル内の順序を変えるだけで、パッチの順序を変更可能です。 series ファイルを編集する時は、適用中のパッチの項目を変更しないように注意してください。

4. パッチを新しいアップストリーム・バージョンとマージ

Rebase エクステンション を使うと、一連のパッチをアップストリームの最新ヘッドとマージするのがかなり楽になります。たいていの場合、やることはたったのこれだけです: 

$ hg pull
$ hg rebase -s <rev1> -d <rev2>

このコマンドは、 rev1 (要は mq に紐付いた最も古い適用済みリビジョン)とその子孫を、 rev2 (pull したばかりの最新ヘッド)へリベースします。必要に応じてマージが行われます。リベースしたいパッチは適用済みでなければなりません。 qpop したパッチは対象になりませんから。リベース後も、一連のリビジョンは依然として mq に紐付いており、 mq で管理された先のリビジョンへ戻って編集することができます。

5. チュートリアル

mq について詳しくは MqTutorial をご覧ください。

6. フックの例

たいていの場合は、パッチを適用したリポジトリから変更内容を push または pull したくないでしょう。 うっかりやってしまわないように、 hook をリポジトリの .hg/hgrc へ追加しましょう。

Mercurial 0.9.2 以降では、 --force オプションなしで push することはありません。 -- ThomasArendsenHein 2007-01-05 08:36:33 

[hooks]
# MQ パッチ適用中 は "hg pull" を防止
prechangegroup.mq-no-pull = ! hg qtop > /dev/null 2>&1
# MQ パッチ適用中 は "hg push" を防止
preoutgoing.mq-no-push = ! hg qtop > /dev/null 2>&1

Mercurial 2.1 以降では、 mq secret フェーズサポート を使ってみるとよいでしょう。

7. コマンドの例

cd some_existing_hg_repository

# パッチキュー・ディレクトリをセットアップ (Mercurial 1.5 で非推奨に)
hg qinit

# firstpatch という名前のパッチを作る
hg qnew firstpatch

# ファイルを変更
vi filename

# 変更内容でパッチを更新
hg qrefresh

# vi .hg/patches/firstpatch で結果を見て
# 現在のパッチの内容を画面に出力
hg qdiff

# さらに変更
vi filename

# パッチに保存されていない差異を見る
hg diff

# パッチを更新
hg qrefresh

# 別のパッチを作る
hg qnew secondpatch

# さらなる変更を加え、パッチを更新
vi filename
hg qrefresh

# 適用中のパッチを調べる
# キューにある全パッチを見る
hg qapplied
hg qseries

# 最上位のパッチを取り除く
hg qpop

# そのパッチを再度適用
hg qpush

# パッチを全て取り除く
hg qpop -a

# パッチを全て適用
hg qpush -a

8. 小ワザ

8.1. 適用中のパッチを全て E-Mail

hg email qbase:qtip

8.2. 適用中のパッチを恒久なチェンジセットへ変換

hg qfinish -a

8.3. 適用中のパッチを1つのパッチにまとめて出力

hg diff -r qparent:qtip

8.4. パッチを常に git 拡張フォーマットに

以下を .hgrc へ追加 

[diff]
git=1

8.5. qrefresh でタイムスタンプを更新しない

パッチキューをバージョン管理下に置いている場合は、 qrefresh する度にパッチのタイムスタンプが更新されてイライラするかもしれません。 タイムスタンプを更新させたくない場合は、以下を .hgrc へ追加してください。 

[diff]
nodates=1

8.6. qstatus コマンドの追加方法

以下を .hgrc へ追加 (詳しくは AliasExtension を): 

[alias]
qstatus = status --rev -2:.

他には "status --rev qparent:." や "status --rev qparent:qtip" というエイリアスが有用でしょう。

8.7. パッチのコミットメッセージを更新

1 行メッセージを書き換えるだけなら、こうしてください: 

hg qrefresh -m "新しいメッセージ"

メッセージが複数行に及ぶ場合はこうです: 

hg qrefresh -e

$EDITOR が開くのでコミットメッセージを編集してください。

8.8. パッチの公開

パッチキューで長い間操作していると、公開リポジトリを継続的に最新の変更内容で更新するのに辟易することと思います。 フックを使えば一連の処理をかなり自動化できます。 ここにリポジトリが2つあるとします。ひとつは基本のリポジトリで、もうひとつは hg qinit -c で作成するようなパッチのリポジトリです。

パッチリポジトリ(メインリポジトリのルートの中、 .hg/patches)に、次の changegroup フックをセットアップしましょう: 

[hooks]
# 最新バージョンのパッチをチェックアウト
changegroup.1update = hg update
# ベースリポジトリから古いバージョンを pop
changegroup.2pop = hg -R ../.. qpop -a
# 今チェックアウトしたところのバージョンを push
changegroup.3push = hg -R ../.. qpush -a

もし手の込んだ事が好きなら, パッチ・リポジトリを別のフックで公開することもできます: 

changegroup.publish = hg push ../../../patches/foo

この方法で overlay patch queue を http://hg.kublai.com/mercurial/overlay へ公開しています。

8.9. パッチキューの変更を常に secret フェーズにする

互換性の問題で 、 mq パッチはデフォルトで secret phase になりません。つまり、パッチを他のリポジトリとやり取りできてしまいます。たいていこれは好ましくありませんから、設定で secret フェーズサポートを有効にできるようになっています: 

[mq]
secret = True

9. Strip

strip コマンドはパッチキューをはっきりとは使いませんが、 mq エクステンションの一部です。

10. 関連項目

11. 外部リンク

CategoryJapanese

English

JapaneseMqExtension (last edited 2014-08-27 14:06:43 by YuyaNishihara)