patch コマンド

目的

変更内容をファイルに適用します。

構文

patch [  -b [ -B Prefix ] ] [  -f ] [ -l ] [ -N ] [ -R ] [  -s ] [  -v ] [  -c | -e | -n  | -u ] [  -d Directory ] [  -D Define ] [  -F Number ] [  -i PatchFile ] [  -o OutFile ] [  -p Number ] [  -r RejectFile ] [  -x Number ] [ File ]

説明

patch コマンドは、ファイルの変更方法についてのソース・ファイルの命令を読み、その変更を適用します。 このソース・ファイルには、diff -c または -u コマンドで作成される差分に関するリスト (diff リスト) が入っており、diff コマンド出力の 1 つまたは複数のセットを、通常 hunk (ハンク) と呼びます。

patch コマンドは、パッチ・ファイル内の先行テキストをスキップし、実際の diff リストを適用し、後続のテキストをスキップします。 したがって、diff リストを含むメッセージをパッチ・ファイルとして使用しても、patch コマンドは引き続き機能します。 その場合、diff リスト全体が一定量だけ字下げされていると、patch コマンドもそのスペーシングに合わせて調整します。

元のファイル内の行範囲を変更するには、パッチ内の各ハンクが別個の diff リストでなくてはなりません。 パッチ内の連続するハンクの行番号は、昇順で指定しなくてはなりません。

ファイル名の判別

File パラメーターを指定しないと、patch コマンドは以下の手順を行って、編集するファイルの名前を取得します。

1. コンテキスト diff リストのヘッダーでは、
   • diff のタイプがコピー・コンテキストである場合、ファイル名は *** (3 個のアスタリスク) または —- (3 個のダッシュ) で始まる行から判別されます。 *** で始まる行はパッチが取り出されたファイルの名前を示し、—- で始まる行はパッチを適用するファイルの名前を示します。 既存のファイルの最も短い名前が選択されます。
   • diff のタイプが統合コンテキストである場合、 ファイル名は --- (3 個のダッシュ) または +++ (3 個のプラス) で始まる行で判別されます。--- で始まる行は、パッチが取り出されたファイルの名前を示し、+++ で始まる行はパッチを適用するファイルの名前を示します。 既存のファイルの最も短い名前が選択されます。
2. 先行テキスト内に Index: 行があると、patch コマンドはその行のファイル名を使おうとします。
3. コンテキスト diff ヘッダーは Index: 行よりも優先されます。
4. 先行テキストからファイル名を判別できない場合、patch コマンドは、 パッチするファイルの名前の入力を求めるプロンプトを表示します。
5. 元のファイルが見つからなくても、適切な SCCS ファイルまたは RCS ファイルが使用可能であれば、patch コマンドはそのファイルを取得またはチェックアウトしようとします。
6. 先行テキストに Prereq: 行があると、patch コマンドは前提条件の行から最初のワード (通常はバージョン番号) を取り出し、入力ファイルにそのワードがあるかどうかを調べます。見つからない場合は、patch コマンドは処理を続ける前に確認を求めるプロンプトを表示します。

パッチの適用

パッチ・ファイルに複数のパッチが入っていると、patch コマンドは各 diff リストを別のパッチ・ファイルから取り出したものとして適用しようとします。 この場合、パッチされるファイルの名前は diff リストごとに判別され、各 diff リストの前に表示されるヘッダー・テキスト内でファイル名や改訂レベルなどの情報が検査されます。

-c、 -e、 -n、または -u フラグを指定すると、patch コマンドは各ハンク内の情報を、それぞれコピー・コンテキストの差分、ed エディターの差分、通常の差分、または統合コンテキストの差分として、おのおのを解釈します。 これらのフラグを指定しないと、patch コマンドはハンク内の情報のフォーマットに基づいて差分のタイプを判別します。

patch コマンドは、ハンクの最初の行の番号を取り出して、直前のハンクを適用することによって生じる行オフセットを加算または減算することにより、各ハンクの適用個所を検索します。 この行位置で正確に一致させることができなければ、patch コマンドはハンクの内容と正確に一致する行の集合を、順方向と逆方向の両方にスキャンします。

この適用個所が見つからず、patch コマンドがコンテキスト diff リストを適用している場合は、patch コマンドは、完全ではないが部分的に一致するものを検索することができます。 fuzz ファクター は、部分的に一致する行がどのくらいあるかを指定します。 fuzz ファクターを 1 以上の値に設定すると、patch コマンドは 2 回目のスキャンを実行します。このときはコンテキストの先頭行と最終行を無視します。 一致するものがない場合、最大 fuzz ファクターが 2 以上に設定されていると、patch コマンドは 3 回目のスキャンを実行します。このときはコンテキストの最初の 2 行と最後の 2 行を無視します (デフォルトの最大 fuzz ファクターは 2 です)。 これで一致するものがない場合、patch コマンドはそのハンクをリジェクト・ファイルに入れます。 リジェクト・ファイルは、出力ファイルと同じ名前と接尾部 .rej で作成されます。 この命名規則は、-r フラグを指定すると上書きできます。

リジェクトされたハンクは、パッチ・ファイルのフォーマットに関係なく コピー・コンテキスト diff リスト・フォーマットで書かれます。 入力が通常または ed エディター・スタイルの差分であれば、リジェクト・ファイルには コピー・コンテキスト・フォーマットの行がない差分が含まれることがあります。 リジェクト・ファイル内のハンクに関する行番号は、パッチ・ファイル内の行番号とは異なることがあります。 これは、リジェクト・ファイルの行番号には、旧ファイルではなく新規ファイル内で失敗したハンクの位置の近似値が反映されるからです。

各ハンクが完了するたびに、patch コマンドはハンクが正常に終了したか失敗したかを示します。 また、各ハンクに想定された新しい行番号も表示されます。 この行番号が diff リスト内で指定した行番号と異なる場合は、オフセットが通知されます。 また、patch コマンドは、fuzz ファクターを使用して一致を探したかどうかも表示します。

注: 1 つの広範なオフセットが通知されると、ハンクが正しくないロケーションにインストールされた可能性があります。fuzz ファクターを使用した場合も、間違った配置を示すことがあります。

ほかのユーザーのためのパッチの準備

ほかのユーザーに配布するパッチを準備するプログラマーは、ほかにも以下のガイドラインに注意しなくてはなりません。

• 同じパッチを 2 回適用しようとすると、patch コマンドは 2 回目の適用が逆パッチであると想定し、逆パッチの確認を求めるプロンプトを表示します。したがって、逆パッチを適用するとユーザーは既にパッチを適用したかどうかがわかりにくくなるので、逆パッチを送信しないようにしてください。
• 最新のパッチ・レベルで更新される patchlevel.h ファイルを保管することをお勧めします。これにより、送信するパッチ・ファイル内の最初の diff リストとして、パッチ・レベルを使用できます。 パッチに Prereq: 行が含まれていると、秩序の正しくないパッチに対しては必ず警告されます。
• コンテキスト diff リスト・ヘッダーで、 または Index: 行で、ファイル名を正しく指定しなくてはなりません。サブディレクトリー内のものをパッチする場合は、必要に応じて -p フラグを指定するようにパッチ・ユーザーに必ず指示してください。
• null ファイルを作成したいファイルと比較する diff リストを送信することによって、ファイルを作成することができます。ただしこの方法は、作成したいファイルがターゲット・ディレクトリー内に存在していない場合にしか使用できません。
• 多数の diff リストを 1 つのファイルに入れることは可能ですが、関連するパッチを別々のファイルにグループ化しておくことをお勧めします。
• patch コマンドは、ed スクリプト内の行番号が正しくないかどうかを表示できません。 変更または削除コマンドを見つけたときに、通常 diff リスト内の正しくない行番号を示すことだけができます。fuzz ファクター 3 を使用するコンテキスト diff リストには、同じ行番号の問題が発生することがあります。 このような場合には、適切な対話型インターフェースを追加するまでは、コンテキスト diff リストを使用して変更が正確かどうかを検査してください。 エラーが発生せずにコンパイルされた場合は、一般にパッチが機能したことを意味しますが、パッチ機能を絶対保証できるわけではありません。
• patch コマンドの結果は、パッチが、 その生成元ファイルと正確に同じバージョンに適用されるときだけ保証されます。
• 以下のようにコードが重複する場合を仮定します。

  #ifdef 
  ... NEWCODE
  #else
  ... OLDCODE
  # endif

  patch コマンドは、両方のバージョンともパッチできません。 patch コマンドが正常に終了した場合は、正しくないバージョンをパッチして、正常な終了状況を戻した可能性があります。

フラグ

#ifdef Define
...  (NEWCODE)
#else
...  (OLDCODE)
#endif /* Define */

終了状況

次の終了値が戻されます。

例

1. difflisting ファイル内の diff リストをファイル prog.c に適用するには、以下のように入力します。

   patch -i difflisting prog.c

2. prog.c ファイルの元のバージョンを保存するには、 以下のように入力します。

   patch -b -i difflisting prog.c

   これにより、変更が prog.c に適用され、prog.c の元の内容はファイル prog.c.orig に保存されます。
3. 元のバージョンを変更せずに prog.c ファイルをパッチするには、以下のように入力します。

   patch -i difflisting -o prog.new prog.c

   これにより、prog.c がソース・ファイルとして使用されますが、変更後のバージョンは prog.new というファイルに書かれます。

ファイル