Makefile ohje:

Yleistä

Makefile on aputiedosto, jolla voidaan helpottaa esim. C-ohjelmien kääntämistä. Isompia, monesta tiedostosta koostuvia ohjelmia kirjoitettaessa se on käytännössä lähes välttämätön, koska kääntämiseen tarvittavien komentojen määrä kasvaa ja niiden kirjoittaminen komentoriville käy hankalaksi. Makefilen käyttöön liittyy:

Tiedosto nimeltä Makefile omassa hakemistossasi
Komento make, jolla ohjelman kääntäminen tapahtuu.

Makefilen rakenne

Alla on hyvin yksinkertainen makefile, jolla esimerkkiohjelman kääntäminen onnistuu (antamalla komento make):

esimohjelma: osa1.o osa2.o
	gcc osa1.o osa2.o -o esimohjelma

osa1.o: osa1.c header.h
	gcc -Wall -ansi -pedantic -c osa1.c

osa2.o: osa2.c header.h
	gcc -Wall -ansi -pedantic -c osa2.c

Makefilessa on kohteita (targets), riippuvuuksia (dependencies) ja sääntöjä (rules). Perusajatus on, että make muodostaa riippuvuustiedostoista kohdetiedoston käyttäen sille määriteltyjä sääntöjä.

Kohteet ja riippuvuudet vastaavat tässä saman nimisiä tiedostoja. Kohteiden ja riippuvuuksien ei ole pakko olla tiedostojen nimiä, mutta siitä lisää toisessa esimerkissä myöhemmin. Kohde tulee ennen kaksoispistettä ja riippuvuudet kaksoispisteen jälkeen.
Säännöt voivat olla mitä tahansa unix-komentoja, tässä esimerkissä samat gcc-komennot kuin ylempänä. Kohteet ja niiden riippuvuudet määräävät, missä järjestyksessä niitä suoritetaan. Huom: Jotta rivi tulkittaisiin säännöksi, sen alussa on oltava täsmälleen yksi tabulaattorimerkki. Välilyönnit eivät kelpaa!

Järjestyksessä ensimmäinen kohde (tässä esimohjelma) on ns. default-kohde, josta ohjelman rakentaminen aloitetaan suoritettaessa komento make ilman argumentteja. Kohteen rakentaminen tapahtuu seuraavasti:

Jos kohteella on riippuvuuksia, tarkistetaan ovatko ne myös kohteina makefilessa.
Mikäli ovat, rakennetaan ne ensin, suorittaen jokaiselle vastava prosessi kohdasta 1 alkaen.
Jos kohteen kaikkien riippuvuuksien rakentamisen jälkeen jokin riippuvuustiedosto on uudempi kuin kohdetiedosto, tai jos kohdetiedostoa ei ole olemassa, suoritetaan kohteelle määritellyt säännöt.

Monimutkaisempi esimerkki

Edellisessä kohdassa esitettiin siis hyvin yksinkertainen perus-makefile. Yleensä makefilessa käytetään makroja, josta esimerkki alla.

#
# Tämä kääntää kuvitteellisen ohjelman nimeltä esim2,
# jossa käytetään curses- ja matematiikkakirjastoja.
# Kaikki #-merkillä alkavat rivit ovat kommentteja.
#

CC      = gcc
CFLAGS  = -Wall -ansi -pedantic
LDFLAGS = -lm -lcurses
OBJS    = main.o math.o user.o
EXE     = esim2
RM      = /bin/rm -f

$(EXE): $(OBJS)
	$(CC) $(OBJS) $(LDFLAGS) -o $(EXE)

main.o: main.c defs.h math.h user.h
	$(CC) $(CFLAGS) -c main.c

math.o: math.c defs.h
	$(CC) $(CFLAGS) -c math.c

user.o: user.c defs.h
	$(CC) $(CFLAGS) -c user.c

clean:
	$(RM) $(OBJS)

Tässä ohjelma koostuu kolmesta lähdetiedostosta (main.c, math.c ja user.c) ja kolmesta header-tiedostosta (defs.h, math.h ja user.h).

Makefilessa on edelleen kohteita, riippuvuuksia ja sääntöjä, sekä uutena asiana makroja. Makroina onkin tässä määritelty esimerkin vuoksi lähes kaikki mahdollinen.

Makro määritellään merkinnällä NIMI=sisältö, ja sen jälkeen kaikki $(NIMI)-viittaukset korvautuvat makron sisällöllä. Esim. ensimmäisen kohteen säännössä makrot korvataan makea ajettaessa näin:


esim2: main.o math.o user.o
	gcc main.o math.o user.o -lm -lcurses -o esim2

Makromäärittelyistä on se hyöty, että makefilen muuttaminen tulee helpommaksi. Jos halutaan vaikkapa kääntää kaikki tiedostot debug-optiolla -g, se voidaan yksinkertaisesti lisätä CFLAGS-makron määrittelyyn sen sijaan, että jokaista sääntöä pitäisi muuttaa erikseen. Myös ohjelman siirtäminen toiseen ympäristöön (eri nimiselle kääntäjälle jne.) helpottuu.

CC, CFLAGS ja LDFLAGS ovat standardinimiä, joiden käyttämiseen on omat syynsä. -lm ja -lcurses ovat linkkerin optioita, joilla saadaan käyttöön matematiikka- ja curses-kirjastojen funktiot. Jos ohjelmassa ei käytetä <math.h>:n tai <curses.h>:n funktioita, ei -l-optioitakaan tarvita käännettäessä.

Tässä makefilessa on myös yksi kohde, johon ei liity mitään tiedostoa: clean. Muu kuin default-kohde voidaan rakentaa antamalla kohteen nimi komentoriviargumenttina makelle, tässä siis make clean.

Kohteella clean ei ole riippuvuuksia, joten se ei aiheuta minkään muiden sääntöjen suorittamista. Sen omat säännöt sen sijaan suoritetaan aina, koska tiedostoa nimeltä clean ei ole olemassa. Käytännössä siis käsky make clean tuhoaa käännöksessä syntyneet objektitiedostot, jolloin seuraava make ilman argumentteja aloittaa 'puhtaalta pöydältä' ja kääntää kaikki lähdetiedostot uudestaan.

Esimerkkejä java-projektin hallinnasta make:lla ja muita linkkejä

http://geosoft.no/javamake.html

http://www.eng.hawaii.edu/Tutor/Make/index.html

http://vertigo.hsrl.rutgers.edu/ug/make_help.html