make comme exécuteur de tâches : cibles fictives, tabulations et un shell par ligne

Ce que c'est

make reconstruit une cible à partir de ses prérequis en exécutant une recette lorsque la cible est absente ou plus ancienne que ce dont elle dépend. Utilisé comme exécuteur de tâches, la plupart des cibles ne sont pas des fichiers mais des noms de commandes : make test, make lint, make deploy. Le manuel de GNU make appelle celles-ci des cibles fictives (phony targets) et indique qu'il faut les déclarer comme prérequis de la cible spéciale .PHONY, afin que la recette s'exécute même si un fichier portant ce nom existe. Deux règles de syntaxe documentées causent la plupart des erreurs de débutant : chaque ligne de recette doit commencer par une tabulation (sauf si .RECIPEPREFIX est modifié), et chaque ligne de recette s'exécute dans un nouveau sous-shell, si bien qu'un cd ou une variable shell sur une ligne n'affecte pas la suivante, à moins que les lignes ne soient jointes en une seule ligne logique avec && et des antislashs, ou que la cible spéciale .ONESHELL ne soit déclarée.

Pourquoi c'est important

Un Makefile offre aux nouveaux venus et aux agents un endroit unique et découvrable pour les commandes d'un projet, ne nécessite aucun exécuteur spécifique à un langage, et peut exprimer de véritables dépendances (générer du code avant de compiler) qu'une simple liste de scripts ne peut pas exprimer. Mal interpréter les deux règles ci-dessus produit des erreurs « missing separator » et des recettes qui s'exécutent silencieusement dans le mauvais répertoire.

Comment l'appliquer

• Rendre le défaut inoffensif : le manuel indique que la première cible est l'objectif par défaut sauf si .DEFAULT_GOAL est défini, donc placer help en premier ou définir .DEFAULT_GOAL := help.
• Déclarer chaque cible de commande dans une seule ligne .PHONY: près du début.
• Joindre les étapes shell dépendantes : cd build && cmake .. && $(MAKE) ; l'exemple du manuel utilise && afin qu'un cd en échec arrête la ligne. Utiliser $(MAKE) pour la récursion.
• Proposer des valeurs par défaut modifiables : PYTHON ?= python3, invoqué comme make test PYTHON=python3.12.
• Garder réelles les cibles de fichiers réels, avec des prérequis, afin que le travail inchangé soit ignoré ; garder fictives les cibles fictives afin qu'elles s'exécutent toujours.
• Utiliser make -n pour afficher les recettes sans les exécuter et make -j pour les cibles indépendantes.

Pièges

Des espaces à la place d'une tabulation. $VAR dans une recette est développé par make comme $V suivi de AR ; écrire $$VAR pour la variable shell. Une cible fictive portant le même nom qu'un répertoire existant qui n'a pas été déclaré .PHONY est « à jour » et ne s'exécute jamais. Les lignes rendues silencieuses avec @ masquent la commande en échec. Les recettes qui reposent sur des fonctionnalités bash s'exécutent sous /bin/sh sauf si SHELL := bash est défini. Les exécutions parallèles révèlent des dépendances manquantes entre cibles qui fonctionnaient par hasard en séquence.