vim-jp » Vimのユーザと開発者を結ぶコミュニティサイト

パッチの書き方

追記

mercurialでテンポラリなブランチを作るのであれば、branchよりもmercurial queueもしくはbookmarkを使った方が良いとのご意見を頂きました。

ここでは既に、コンパイル環境やMercurialが使える状態になっている事を前提とします。 なお、WindowsユーザであればVisual Studioでのコンパイル方法もしくはMinGWでのコンパイル方法も参照して下さい。

最新のソースコードを取得する為に、シェル(Windowsであればコマンドプロンプト)から以下を実行します。

hg clone https://vim.googlecode.com/hg/ vim

次に修正内容に対応するブランチを作成します。

hg branch fix-quickfix-on-windows

ここで気を付けておいた方がいいのが、hg branchする際のブランチは常にdefaultであった方が良いという事です。 これはvimに限った話ですが、authorであるBram Moolenaar氏は1つのパッチに対して1チェンジセットでcommitを作りますが、パッチファイルとして提供する際にはvim_devメーリングリストへ投げたパッチに対して少し変更を少し変えてパッチリリースする事があるからです。その変更の中にはvimのパッチ番号でもある7.3.322の322をソースコードに埋め込む作業も行われます。つまりパッチが取り入れられてdefaultブランチが更新された場合でマージが正常に行く事があまりないのです。例えば作成したブランチから作った派生ブランチが壊れてしまう可能性もあります。 よってブランチは1つの修正に対して1回限りの物と思って良いでしょう。

ブランチが作成されたらソースファイルを修正します。

vim os_win32.c

この際コーディングスタイルは既存のものに合わせるようにしましょう。 :help coding-styleにコーディング規約が書かれてあります。 また:help develop.txtにはVimの開発に関する事項が書かれています。一度目を通すといいでしょう。

修正したらcommitしましょう。

hg commit

全ての修正が完了したらパッチを作りましょう。最終的には全修正を一連のパッチファイルとしてメーリングリストに投げます。

hg diff -r default:fix-quickfix-on-windows >
  fix-quickfix-on-windows.diff

※実際は1行

これでブランチ間の差分ファイルが作成出来るので、メーリングリストvim_devに添付ファイルを付けるか本文に貼り付けてメールを投げます。 メールの冒頭で

• 発生している現象
• 再現手順

を説明します。 あとは誰かがレビューしてくれるはずです。 なお、パッチファイルには名前が記されますが基本的には実名が相応しいと以前Bram氏が言っていました。

さぁ君もCONTRIBUTE AUTHORになろう！