3. Makefileの記述

[ ? ]

3.1 Makefileに含まれるもの

Makefileは5つの項目を含んでいます。それは、explicit rules、 implicit rules、variable definitions、directivesと commentsです。また、ルール、変数とディレクティブについては章の後半で説明しています。

explicit rule（明示的なルール）は、1つあるいは複数のファイルをいつどのように変更するかを示し、ルールのターゲットと呼ばれます。そしてターゲットが依存するほかのファイルをリストし、ターゲットの必要条件を呼び出します、さらにターゲットをアップデートしたり生成したりする命令を与えます。See section ルールの記述.。
implicit rule（暗黙のルール）は、名前に基づくファイルのクラスをいつどのように変更するかを示し、ターゲットがその名前に似たファイルにどのように依存しているかを記述し、ターゲットをアップデートしたり生成したりする命令を与えます。 See section 暗黙のルールの使用.。
variable definition（変数の定義）は、あとでテキストで代用できる変数のための文字列を特定するラインです。簡単なmakefileの例では、すべてのオブジェクトファイルのリストとしてobjectsに対する変数を定義しています（see section 変数によるMakefilesの簡素化.）。
directive（ディレクティブ）は、makefileを読み取るあいだにmakeに何か特別に実行させる命令です。これらは以下を含みます。
- ほかのmakefileを読み取ること（see section ほかのMakefileをインクルードする.）。
- 変数の値に基づいて、makefileの一部分を使用するか無視するかを決定すること（see section Makefileの条件文.）。
- 複数の行にわたる文字列から変数を定義すること（see section 変数のまったく同一の定義.）。
‘#’で始まるmakefileの行はコメントで、その行は無視されます。ただし、バックスラッシュで区切られた複数の行にわたるコメントは例外です。また、コメントはmakefileのどこにでも置けます。ただし、defineディレクティブのなかでは例外となりますし、命令行においても例外となります。コメントだけの行（先頭がスペースで始まる）は空白と同じで無視されます。

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

3.2 Makefileの名前のつけ方

デフォルトではmakeはmaefileを探しますが、その際には、‘GNUmakefile’、 ‘makefile’、‘Makefile’の順序で探します。

通常は、makefileを‘makefile’あるいは‘Makefile’としたほうがよく、こうしておけば、‘README’などの重要なファイルのあるディレクトリのリストの先頭に出てきます。名前のチェックでは、ほとんどの場合 ‘GNUmakefile’は推奨しません。この名前は、とくにGNUのmakeを使用する場合に用いますが、ほかのバージョンのmakeでは認識されないでしょう。ほかのmakeプログラムは、‘makefile’あるいは ‘Makefile’は認識しますが、‘GNUmakefile’は認識しません。

もしmakeがこれらのファイルを探し出せなかった場合には、 makefileを用いません。したがって、コマンドの引数でゴールを指定する必要があり、 makeは組み込まれている暗黙のルールにのみ従ってremakeしようとします。 See section 暗黙のルールの使用.。

標準的なmakefile以外の名前を用いたい場合には、‘-f’あるいは ‘--file’オプションをつけてmakefileの名前を指定できます。引数 ‘-f name’あるいは‘--file=name’によって makeにnameをmakefileだと認識させられます。また、‘-f’ あるいは‘--file’オプションによって、複数のmakefileの指定を行なうこともできます。指定されたすべてのmakefileは順序に従って効果的に連結されます。また、‘-f’あるいは‘--file’オプションを使用した場合には、デフォルトの名前である‘GNUmakefile’や‘makefile’や‘Makefile’は自動的にチェックは行なわれません。

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

3.3 ほかのMakefileをインクルードする

includeディレクティブは、makeに対してmakefileの読み込みを中断し、1つあるいは複数のほかのmakefileを読み込んでから継続するように指示します。makefileのなかのディレクティブは以下のようなものです。

include filenames…

filenamesは、シェルのファイル名のパターンを含むことができます。

行の先頭では、スペースは無視されるのでかまいませんが、タブは許されません。タブで始まる行はコマンド行と認識されてしまいます。また、includeとファイル名のあいだには空白が必要で、2つ以上の空白やディレクティブの終わりの空白は無視されます。行の終わりに‘#’で始まるコメントも可能です。さらに、ファイル名がなんらかの変数や関数の参照を含んでいる場合にはそれが展開されます。See section 変数の使用法.。

たとえば、3つの‘.mk’すなわち、‘a.mk’、‘b.mk’、‘c.mk’を含んでいる場合には、bish bashとともに展開され、以下のようになります。

include foo *.mk $(bar)

は、以下と同様です。

include foo a.mk b.mk c.mk bish bash

makeがincludeディレクティブを処理する際は、makefileの読み込みを中断し、かわりにリストされたファイルの読み込みを実行します。その後、 makeはディレクティブの現われた箇所に戻り読み込み処理を続けます。

さまざまなディレクトリにある個々のmakefileによって処理されるいくつかのプログラムが変数定義の標準的なセットを必要とする場合にinclude ディレクティブを使用します（see section 変数の設定.、あるいはパターンルールについては see section パターンルールの定義と再定義.）。

また、ソースファイルから必要条件を自動的に生成する場合にもinclude ディレクティブを用います。その場合、必要条件はメインのmakefileに含まれるようにファイルとして生成されます。この方法は、従来のほかのバージョンのmakeのようにメインのmakefileの最後に追加していく方法よりもすっきりしています。 See section 必要条件の自動生成.。

もし、指定したファイルの名前がスラッシュで始まるものでない場合やカレントディレクトリにない場合には、いくつかのディレクトリがサーチされます。その際に、まず‘-I’あるいは‘--include-dir’で指定されたディレクトリがサーチされ（see section オプションのサマリー.）、次に（存在する場合には）以下のディレクトリがサーチされます。 ‘prefix/include’（普通は‘/usr/local/include’ ですが、MS-DOSとMS-Windowsの場合は、DJGPPツリー階層のルートディレクトリであるようにGNUのMakeはコンパイルを行ないます）、 ‘/usr/gnu/include’、‘/usr/local/include’、 ‘/usr/include’。

もし、含まれているmakefileがどのディレクトリでもみつからない場合には、警告メッセージが生成されますが、これはすぐに致命的なエラーということではなく、 includeを含むmakefileの処理は継続します。そして、makefileの読み込みが終了するとmakeは期限切れや存在しないファイルを再構成しようとします。See section Makefileの作られ方.。ただし、makefile自体を変更しようとする方法をみつけた場合には再構成は失敗します。そして致命的なエラーとして、makefileの存在を診断しようとします。

存在しないため、変更しようのないmakefileをエラーメッセージなしに単純に無視する場合には、以下のようにincludeディレクティブのかわりに -includeを使用してください。

-include filenames…

filenameがまったく存在せず、エラーがないという場合を除けば、この動作はincludeによく似ています。これはほかのmake インプリメンテーションとの互換性のためで、 sincludeは-includeの別名となっています。

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

3.4 `MAKEFILES`の変数

環境変数MAKEFILESが定義されている場合には、makeはその変数を、先行して読み込むmakefileの名前のリスト（空白で区切られた）とみなします。この動作はincludeディレクティブとたいへん似ていて、さまざまなディレクトリをサーチします（see section ほかのMakefileをインクルードする.）。さらに、デフォルトのゴールはこれらのmakefileから得られることはなく、MAKEFILESにリストされたファイルが、たとえみつからない場合でもエラーとなることはありません。

MAKEFILESの主な用途は、makeの再帰的な呼び出しの際の通信です。（see section makeの再帰的用法.）通常は、トップレベルの makeの呼び出しのまえに環境変数を設定することは好ましくありません。なぜなら、外部からmakefileに対して干渉しないことがよいからです。しかしながら、makefileを指定せずにmakeを実行する場合には、 MAKEFILESのなかのmakefileは組み込まれた暗黙のルールが定義されたサーチパスよりもうまく機能します（see section 必要条件のためのディレクトリサーチ.）。

ユーザーによっては、ログイン時に自動的にMAKEFILESを環境に設定して、このような動作をするように設定したがりますが、これはよくないアイデアといえます。なぜなら、異なるユーザーによって実行された場合には失敗してしまうからです。したがって、明示的にincludeディレクティブを記述するほうがずっとよいのです。 See section ほかのMakefileをインクルードする.。

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

3.5 Makefileの作られ方

makefileはRCSやSCCSファイルから作られる場合があります。このようにほかのファイルからmakefileが作られる場合には、makeが最新のバージョンの makefileを読み込むことが期待されます。

すべてのmakefileを読み込んだあと、makeはそれぞれをゴールのターゲットとみなし、アップデートしようと試みます。あるmakefileがその（まさにその makefileまたは別のmakefile）アップデートの方法についてのルールを持つ場合（see section 暗黙のルールの使用.）、あるいは暗黙のルールを持つ場合には必要に応じてアップデートされるでしょう。すべてのmakefileがチェックされたあと、なんらかの変更が行なわれた場合には、makeはクリーン動作を行ないすべてのmakefileの読み込みをふたたび開始します。（それぞれのアップデートもふたたび試みられますが、通常はアップデートされているはずなので、再度変更を加えることはしません。）

1つあるいは複数のmakefileが変更できないことを知っていて、しかも暗黙のルールのサーチをmakeにさせないようにしたい場合、おそらくその理由は効率の問題で、暗黙のルールのルックアップは通常の方法で防止することができます。たとえば、明示的なルールをターゲットとしてmakefileに記述し、空のコマンド文字列を書いておけばよいのです（see section 空のコマンドの使用.）。

必要条件ではなく、命令でファイルを変更するために2つのコロンのルールを makefileで指定する場合には、ファイルはつねに変更されます（see section ダブルコロンルール.）。つまり、命令と2つのコロンのついた必要条件でないルールはmakeが実行されるたびに実行され、ふたたびmakeが実行される際に再度読み込みも行なわれます。これは無限ループを引き起こします。makeはつねにmakefileを変更しようと試み、ほかに何もしないことになります。したがって、これを避けるために、命令と2つのコロンのついた必要条件でないルールのターゲットとして指定された makefileについてはmakeは変更しようとしません。

‘-f’や‘--file’オプションでmakefileを何も指定しない場合は、 makeはデフォルトの名前のmakefileを試します（see section Makefileの名前のつけ方.）。 ‘-f’や‘--file’オプションで明示的に要求されたmakefileと異なり、 makeはファイルの存在をあてにしません。しかしながら、デフォルトの makefileが存在せず、かつmakeの実行によって生成される場合には、 makefileが使用されるようにルールの実行が行なわれたほうがよいことになります。

したがって、もしデフォルトのmakefileが存在しない場合には、makeはサーチされる順序でそれを生成しようとしますが（see section Makefileの名前のつけ方.）、サーチする名前を使い果たしてしまいます。注意しなければならないのは、makeが makefileをサーチあるいは生成できなかったとしてもこれはエラーとはなりません。なぜなら、makefileがつねに必要というわけではないからです。

‘-t’あるいは‘--touch’オプション（see section コマンド実行の代替.）を使用する際には、どのターゲットにtouchするかを決定するために期限切れの makefileを使用したいとは考えないはずです。したがって、‘-t’オプションは makefileのアップデートには何の効果も与えません。同様に、‘-q’ （あるいは‘--question’）や‘-n’ （あるいは‘--just-print’）オプションは、makefileのアップデートを妨げません。なぜなら期限切れのmakefileはほかのターゲットに対して誤った出力を行なってしまうからです。したがって、‘make -f mfile -n foo’は‘mfile’をアップデートし、それを読み込みます。そして実行することなしに、命令を出力して ‘foo’と必要条件をアップデートします。‘foo’に出力された命令は、 ‘mfile’のアップデートされた内容において指定されたものです。

しかしながら、ときにはmakefileのアップデートを止めたいと考えることもあるかもしれません。その場合、makefileのなかで行なうようにmakefile自体をゴールに指定することで、実現できます。明示的なゴールとしてmakefileが指定されている場合には、‘-t’などのオプションが適用されます。

したがって、‘make -f mfile -n mfile foo’はmakefile ‘mfile’を読み込み実際に実行することはせずに、アップデートに必要な命令を出力します。そして、 ‘foo’のアップデートに必要な命令も出力します。‘foo’に対する命令は ‘mfile’の実際の内容によって指定されたものとなります。

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

3.6 ほかのMakefileの部分的なオーバーライド

まれに、もう1つほとんど同じmakefileを持つことが有益な場合があります。その場合、‘include’ディレクティブによってもう一方をインクルードするようにします。そして、より多くのターゲットあるいは変数定義を付け加えます。しかし、同じターゲットに対して2つのmakefileが異なる命令を与える場合にはmakeはこの方法は用いることができません。この場合には別の方法があります。

他方をインクルードしようとするmakefileにおいては、そのmakefileに含まれる内容から導けないどんなターゲットでも再構成できる何にでもマッチするパターンルールを使用することができ、makeは他方のmakefileを読み取ることになります。パターンルールについては、 See section パターンルールの定義と再定義.。

たとえば、ターゲット‘foo’をmakeするための‘Makefile’があるとして、もう1つ別の‘GNUmakefile’を作ることができ、その中身は、以下のようにします。

foo:
        frobnicate > foo

%: force
        @$(MAKE) -f Makefile $@
force: ;

‘make foo’とした場合、makeは‘GNUmakefile’をみつけだし、それを読み‘foo’をmakeしようとします。そしてコマンド ‘frobnicate > foo’を実行しようとします。また、‘make bar’とした場合には、makeは‘GNUmakefile’のなかで‘bar’をmakeする方法をみつけられません。つまりここでは、‘make -f Makefile bar’というパターンルールを使おうとしたからです。もし‘Makefile’が‘bar’をアップデートするルールを提供するならば、makeはそれを適用します。 ‘GNUmakefile’がどのようにmakeするかを指示しないあらゆるターゲットに対しても同様です。

この動作は、‘%’だけのパターンを持つパターンルールによります。‘%’はあらゆるターゲットにマッチします。たとえターゲットファイルがすでに存在していても命令の実行を保証するために、ルールは‘force’という必要条件を指定します。makeが暗黙のルールをサーチしないように空の命令を‘force’ターゲットに与えます。そうしないと同一の何にでもマッチするルールを‘force’に適用してしまい、必要条件のループを生成してしまいます。

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

3.7 `make`はどのようにMakefileを解釈するか

GNUのmakeは2つの異なったフェーズで仕事を行ないます。最初のフェーズでは、すべてのmakefileを読み、makefileのインクルードを行ないすべての変数と値を内部の値として持ち、暗黙および明示的なルールおよびすべてのターゲットとその必要条件の依存状態のグラフを構築します。次のフェーズでは、どのターゲットが再構築される必要があり、ルールの適用が必要なのかを決定するためにmakeは内部構造を使用します。

この2段階のアプローチを理解しておくのが重要なのは、変数と関数の展開による直接的な影響があるからです。このことはしばしばmakefileを記述する際の混乱のもとになります。ここでは、makefileのなかの異なる構成に対する展開における2つの段階の要約を示します。最初のフェーズで展開が行なわれる場合を immediateといい、この場合はmakeは構文解析されたmakefileとして構成のセクションの部分にすべての変数と関数を展開します。また、展開がただちに行なわれない場合をdeferredといい、即時の文脈のなかでその構成が出現しない限り実行されることはなく、そうでない場合は2番目のフェーズで実行されることになります。

読者はこの構成（物）に関してはまだ詳しくはないかもしれませんが、あとの章を読み詳しくなるに従ってこの章を参照するとよいでしょう。

変数の割り当て

変数の定義は以下のように構文解析されます。

immediate = deferred
immediate ?= deferred
immediate := immediate
immediate += deferred or immediate

define immediate
  deferred
endef

‘+=’は付加オペレーターで、以前に変数が単純変数としてセット（‘:=’）されていてdeferredでない場合には、オペレーターの右側は immediateであるとみなされます。

条件付きのシンタックス

条件付きのすべてのインスタンスはただちに全体として構文解析され、これには ifdefやifeqやifndefとifneq形式が含まれます。

ルールの定義

ルールは形式を問わず、つねに同じ方法で展開されます。

immediate : immediate ; deferred
	deferred

つまり、ターゲットと必要条件であるセクションはただちに展開されて、ターゲットを構成するための命令はつねにdeferredとなります。この一般的なルールは明示的なルール、パターンルール、サフィックスルール、静的なパターンルールと単純な必要条件の定義に対してあてはまります。

[ << ]

[ >> ]