小粋空間  -  a cheap joke and a play on words site

パッチをあてる（その1：適用方法）

以前、カスタマイズを色々紹介する中で「パッチをあてる」という作業の具体的な方法について、認識不足のため誤った説明をしておりましたので、その適用方法についてお詫びを兼ねて改めて紹介したいと思います。ここでは Windows での作業について説明します。

１．パッチとは

「パッチ」はプログラムの一部を修正することです。「パッチワーク」を思い出して頂ければ分かりやすいと思います。「パッチファイル」はプログラムを修正するための差分が記述されたファイルです。
「パッチをあてる」というのは実際にプログラムを修正する行為を指します。

２．patch コマンドの準備

パッチの適用にあたっては patch コマンドを使用します。Linux ではデフォルトで用意されているようですが、Windows では用意されていません。
ということで、まず patch コマンドを入手します。

patch コマンドは Cygwin・ソフトウェア工房α・Vector 等で配布されていますが、ここではソフトウェア工房αから入手します。

プログラミング・ツール（移植ソフト）に表示されている、

patc254w.zip

をクリックし、解凍した中にある

patch.exe

をPCの任意のディレクトリに配置します。C:\WINDOWS 配下または C:\WINDOWS\system32 配下に
配置できれば、後述するMS-DOSコマンドプロンプトからの起動でパスを指定せずに実行することができます。
配置できない場合はとりあえず C:\ 配下においておきましょう。

３．パッチをあてる

パッチをあてる作業は、パッチファイル（またはパッチとなるテキスト）とパッチをあてる元のプログラムを用意し、その2つが用意された状態で patch コマンドを実施すると元のプログラムが書き換えられます。
以下、順を追って作業内容を説明します。

３．１ パッチファイルを保存する

下記のような内容のパッチファイルがあると想定します。

--- Util.pm.bak Fri Jan 06 14:19:44 2006
+++ Util.pm     Fri Jan 06 14:20:48 2006
@@ -401,7 +401,7 @@
     $str ||= '';
     my @paras = split /\r?\n\r?\n/, $str;
     for my $p (@paras) {
-        if ($p !~ m@^</?(?:h1|h2|h3|h4|h5|h6|table|ol|dl|ul|menu|dir|p|pre|center|form|fieldset|select|blockquote|address|div|hr)@) {
+        if ($p !~ m@^</?(?:h1|h2|h3|h4|h5|h6|menu|dir|p|pre|center|form|fieldset|select|address|div|hr)@) {
             $p =~ s!\r?\n!<br />\n!g;
             $p = "<p>$p</p>";
         }

これは Movable Type の lib/MT/Util.pm の 404 行目あたりにある、エントリー保存時、エントリーに改行を付与する処理を修正するパッチで、プログラム内に改行タグを付与する基準となるタグが列挙されており、そのタグを一部変更するものです。
具体的な変更内容は、行頭に "-" のある行を "+" がある行に変更します。つまり並んでいるタグから、table/ul/ol/dl/blockquote が取り除かれます。

さて、ここで行う作業ですが、C:\ 配下に work ディレクトリを作り、patch.txt というファイル名で上記パッチの内容をマウスコピーして保存します。最初からファイルになっている場合はそのまま C:\ 配下に保存します。
実際に作業を行う場合、ディレクトリ・ファイル名は任意の名称で構いません。
注：ファイルの最後の行（上の例では "}"）の末尾には必ず改行を含めてください。

３．２ パッチをあてるファイルを配置する

次に、パッチをあてる元のファイル lib/MT/Util.pm を先ほどの work ディレクトリにコピーします。ファイル名は Util.pm のままで結構です。
興味のある方は、このファイルを任意のエディタで開き、404 行目がパッチファイルの "-" と同じ内容であることを確認しましょう。

３．３ パッチをあてる

MS-DOS コマンドプロンプトを起動し、

C:¥>cd work

で、work ディレクトリへ移動し、patchコマンド

C:¥work>patch < patch.txt

を実行します。この実行イメージは patch コマンドが C:\WINDOWS 配下または C:\WINDOWS\system32 配下にある場合（つまり patch コマンドのパスが認識されている場合）を想定しています。コマンドが認識されない場合は、patch コマンドが置かれているパスを記述します（パスの設定する方法もありますがここでは省略します）。
C:\ 直下に patch を置いている場合は

C:¥work>C:¥patch < patch.txt

とします。

コマンド実行が成功すると画面の最後に

patching file Util.pm

と表示されます。これで完了です。
これで Util.pm の 404 行目が変更されていますので、この変更された Util.pm を元のディレクトリに上書きしてください。なお、patch コマンドに -p0 というオプションがついている場合がありますが、この使用方法については「パッチをあてる（その3：patchコマンドの-pオプションについて）」で説明します。

なお、以前の説明では、Utll.pm を任意のエディタで開き、「"-" の部分を削除して "+" の部分を追加する」という内容を記述してました。正常に動作すれば結果オーライなのですが、パッチの適用方法について適正な方法を最初にお伝えできていなかったことについては反省しております。

３．４ パッチをはずす

３．３項であてたパッチを外したい（元に戻したい）場合は、MS-DOS コマンドプロンプトで

C:¥work>patch -R < patch.txt

と入力してください。成功すると画面の最後に

patching file Util.pm

と表示されます。

４．パッチが分からない方＆面倒な方へ

要は、パッチの行頭に「+」が記された行を追加して、「-」の行を削除すればOKです。３．１項のパッチを例に示します。赤色が削除行で青色が追加行です。この変更内容と３．１のパッチの表示を見比べ、どこを修正すればよいかを把握してください。

修正前

--- Util.pm.bak Fri Jan 06 14:19:44 2006
+++ Util.pm     Fri Jan 06 14:20:48 2006
@@ -401,7 +401,7 @@
     $str ||= '';
     my @paras = split /\r?\n\r?\n/, $str;
     for my $p (@paras) {
        if ($p !~ m@^</?(?:h1|h2|h3|h4|h5|h6|table|ol|dl|ul|menu|dir|p|pre|center|form|fieldset|select|blockquote|address|div|hr)@) {
             $p =~ s!\r?\n!<br />\n!g;
             $p = "<p>$p</p>";
         }

修正後

--- Util.pm.bak Fri Jan 06 14:19:44 2006
+++ Util.pm     Fri Jan 06 14:20:48 2006
@@ -401,7 +401,7 @@
     $str ||= '';
     my @paras = split /\r?\n\r?\n/, $str;
     for my $p (@paras) {
        if ($p !~ m@^</?(?:h1|h2|h3|h4|h5|h6|menu|dir|p|pre|center|form|fieldset|select|address|div|hr)@) {
             $p =~ s!\r?\n!<br />\n!g;
             $p = "<p>$p</p>";
         }

なおこの方法による修正の場合、事前に該当ファイルのバックアップをとっておきましょう。修正を誤るとMovable Type が正常に動作しなくなる可能性があります（失敗した場合は修正前のファイルに戻せば良いので心配することはありません）。

以上です。
参考サイトは下記です。ありがとうございました。

• diff/patch Tips
• Azrael：Tagwire、MT-XSearch、Cygwin導入メモ
• プログラマの道具箱

2007.04.25 追記
ファイルを保存する際の注意事項を追加しました。