09-makefiles.md

title	subtitle	author	date
9. Automatiseren v/workflows met Makefiles	Linux (for data Scientists)<br/>HOGENT toegepaste informatica	Thomas Parmentier, Andy Van Maele, Bert Van Vreckem	2024-2025

Makefiles

GNU Make

• make = deel van basis toolset voor software-ontwikkeling op Unix
  • POSIX!
• GNU make = implementatie op Linux
• Vgl. met ant, Maven, Grunt, ..
• Oorspronkelijk voor C/C++
• Algemeen bruikbaar!
  • bronbestand > transformatie > doelbestand
  • bv. c-code > GCC compiler > executable
  • bv. java-code > javac > .class-files
  • ...

https://www.gnu.org/software/make/manual/

Makefile

doel: bronnen...
    recept
    @cmd
    ...

• doel: naam v/te creëren bestand
• bronnen: naam van bestanden die daarvoor nodig zijn
• recept: commando('s) die nodig zijn om doel te creëren uit bronnen
  • @cmd uitgevoerde commando wordt niet getoond
  • LET OP! Inspringen met TAB, geen spaties!

Voorbeeld Makefile

Makefile:

hello: hello.c
    gcc -o hello hello.c

hello.c:

#include <stdio.h>
int main()
{
    printf("Hello World");
    return 0;
}

Uitvoeren

• make [DOEL]
  • zonder argumenten: eerste doel
  • hier bv. make hello
• Resultaat: uitvoerbaar bestand met de naam hello

$ make
gcc -o hello hello.c
$ ./hello
Hello World
$ make hello
make: 'hello' is up to date.

Make voert enkel recept uit als bron veranderd is!

Voorbeeld meerdere bron- en doelbestanden

// booleans.h
int EXIT_TRUE  = 0;
int EXIT_FALSE = 1;

// true.c
#include <stdio.h>
#include "booleans.h"

int main(void) {
    return EXIT_TRUE;
}

(false.c: analoog)

---

# Makefile
.PHONY: all clean

all: true false
true: true.c booleans.h
    gcc -o true true.c
false: false.c booleans.h
    gcc -o false false.c
clean:
    rm -vf true false

• all
  • 1e regel wordt uitgevoerd bij oproepen make (zonder args)
  • "recursieve" regel, zal true én false uitvoeren
• clean
  • regel voor het opruimen van alle gegenereerde bestanden
• .PHONY = geen "echt" recept, moet altijd uitgevoerd worden

Makefiles compacter & generisch maken

# Makefile - part 1

sources := $(wildcard *.c)
objects := $(patsubst %.c,%.o,$(sources))
executables := true false

CC := gcc
CFLAGS := -Wall -O

• Variabelen:
  • declaratie: :=
  • waarde opvragen: $(variabele)
• wildcard - lijst v/bestanden die matchen met globbing-patroon
  • hier: true.c false.c
• patsubsts - zoeken & vervangen
  • hier: true.o false.o

---

# Makefile - part 2

.PHONY: all clean mrproper

all: $(executables)

%: %.o
	$(CC) $(CFLAGS) -o $@ $<

%.o: %.c booleans.h
	$(CC) $(CFLAGS) -c $<

---

• % = "Pattern rule"
  • % matcht met true en false
• $< = Automatische variabele
  • Eerste bron voor deze regel
• $@ = target van deze regel (hier: true of false)

%.o: %.c booleans.h
	$(CC) $(CFLAGS)  -c $<

wordt vertaald naar:

true.o: true.c booleans.h
	gcc -Wall -O -c true.c
false.o: false.c booleans.h
	gcc -Wall -O -c false.c

---

# Makefile - part 3

clean:
	rm -vf $(objects)

mrproper: clean
	rm -vf $(executables)

Resultaat:

$ make mrproper
rm -vf *.o
rm -vf true false
removed 'true'
removed 'false'
$ make all
gcc -Wall -O -c false.c
gcc -Wall -O -o false false.o
gcc -Wall -O -c true.c
gcc -Wall -O -o true true.o
rm false.o true.o

Voeg .SECONDARY: toe om .o-bestanden te bewaren:

Portable Makefiles

Begin Makefile met:

.POSIX:     # Get reliable POSIX behaviour
.SUFFIXES:  # Clear built-in inference rules

• .POSIX: Makefile werkt beter op andere platformen
  • bv. MacOS, Windows, BSD, ...
• .SUFFIXES: ingebouwde regels (voor C-compilatie) wissen
• .PHONY is een GNU make uitbreiding, werkt misschien niet op andere platformen

Praktijkvoorbeelden van Makefiles

• Omzetten van Markdown naar Reveal.js-presentatie:
  • https://github.com/HoGentTIN/linux-slides/blob/main/Makefile
• Compileren van LaTeX naar PDF:
  • https://github.com/HoGentTIN/latex-hogent-article/blob/main/Makefile
  • https://github.com/HoGentTIN/latex-hogent-exam/blob/main/Makefile
• ABC muzieknotatie naar PDF, MIDI, PNG, JPEG:
  • https://github.com/bertvv/abc-transcriptions/blob/main/Makefile