make als Task-Runner: Phony-Targets, Tabulatoren und eine Shell pro Zeile

Worum es geht

make baut ein Target aus seinen Voraussetzungen neu, indem es ein Rezept ausführt, wenn das Target fehlt oder älter ist als das, wovon es abhängt. Als Task-Runner eingesetzt, sind die meisten Targets keine Dateien, sondern Namen für Befehle: make test, make lint, make deploy. Das GNU-make-Handbuch nennt diese Phony Targets und verlangt, sie als Voraussetzungen des besonderen Targets .PHONY zu deklarieren, damit das Rezept auch dann läuft, wenn eine Datei mit diesem Namen existiert. Zwei dokumentierte Syntaxregeln verursachen die meisten Anfängerfehler: Jede Rezeptzeile muss mit einem Tabulator beginnen (sofern .RECIPEPREFIX nicht geändert wurde), und jede Rezeptzeile wird in einer neuen Subshell ausgeführt, sodass ein cd oder eine Shell-Variable in einer Zeile die nächste nicht beeinflusst, sofern die Zeilen nicht mit && und Backslashes zu einer logischen Zeile zusammengefügt oder das besondere Target .ONESHELL deklariert wird.

Warum es wichtig ist

Ein Makefile bietet Neulingen und Agenten eine einzige auffindbare Stelle für die Befehle eines Projekts, benötigt keinen sprachspezifischen Runner und kann echte Abhängigkeiten ausdrücken (Code generieren, bevor kompiliert wird), was eine flache Liste von Skripten nicht kann. Ein Missverständnis der beiden obigen Regeln führt zu „missing separator"-Fehlern und zu Rezepten, die stillschweigend im falschen Verzeichnis laufen.

So wird es angewendet

• Das Standardziel harmlos halten: Das Handbuch besagt, dass das erste Target das Standardziel ist, sofern .DEFAULT_GOAL nicht gesetzt wird; also help zuerst platzieren oder .DEFAULT_GOAL := help setzen.
• Jedes Befehls-Target in einer .PHONY:-Zeile nahe am Anfang deklarieren.
• Abhängige Shell-Schritte verbinden: cd build && cmake .. && $(MAKE); das Beispiel im Handbuch verwendet &&, damit ein fehlschlagendes cd die Zeile stoppt. $(MAKE) für Rekursion verwenden.
• Überschreibbare Standardwerte anbieten: PYTHON ?= python3, aufgerufen als make test PYTHON=python3.12.
• Echte Datei-Targets echt halten, mit Voraussetzungen, damit unveränderte Arbeit übersprungen wird; Phony-Targets phony halten, damit sie immer laufen.
• make -n verwenden, um Rezepte auszugeben, ohne sie auszuführen, und make -j für unabhängige Targets.

Stolpersteine

Leerzeichen statt eines Tabulators. $VAR in einem Rezept wird von make als $V gefolgt von AR expandiert; für die Shell-Variable $$VAR schreiben. Ein Phony-Target mit demselben Namen wie ein bestehendes Verzeichnis, das nicht als .PHONY deklariert wurde, gilt als „aktuell" und läuft nie. Mit @ stummgeschaltete Zeilen verbergen den fehlschlagenden Befehl. Rezepte, die auf Bash-Funktionen angewiesen sind, laufen unter /bin/sh, sofern nicht SHELL := bash gesetzt ist. Parallele Läufe legen fehlende Abhängigkeiten zwischen Targets offen, die in sequenzieller Ausführung zufällig funktionierten.