Makefile 介紹
make命令執(zhí)行時,需要一個 Makefile 文件慢宗,以告訴make命令需要怎么樣的去編譯和鏈接程序。
首先,我們用一個示例來說明Makefile的書寫規(guī)則镜沽。以便給大家一個感興認識敏晤。這個示例來源于GNU的make使用手冊,在這個示例中缅茉,我們的工程有8個C文件嘴脾,和3個頭文件,我們要寫一個Makefile來告訴make命令如何編譯和鏈接這幾個文件宾舅。我們的規(guī)則是:
1.如果這個工程沒有編譯過统阿,那么我們的所有C文件都要編譯并被鏈接。
2.如果這個工程的某幾個C文件被修改筹我,那么我們只編譯被修改的C文件扶平,
并鏈接目標程序。3.如果這個工程的頭文件被改變了蔬蕊,那么我們需要編譯引用了
這幾個頭文件的C文件结澄,并鏈接目標程序。
只要我們的Makefile寫得夠好岸夯,所有的這一切麻献,我們只用一個make命令就可以完成,make命令會自動智能地根據(jù)當前的文件修改的情況來確定哪些文件需要重編譯猜扮,從而自己編譯所需要的文件和鏈接目標程序勉吻。
1.1 Makefile的規(guī)則
在講述這個Makefile之前,還是讓我們先來粗略地看一看Makefile的規(guī)則旅赢。
target... : prerequisites ...
command
...
...
-------------------------------------------------------------------------------
target也就是一個目標文件齿桃,可以是Object File,也可以是執(zhí)行文件煮盼。還可以是一個標簽(Label)短纵,對于標簽這種特性,在后續(xù)的“偽目標”章節(jié)中會有敘述僵控。
prerequisites就是香到,要生成那個target所需要的文件或是目標。
command也就是make需要執(zhí)行的命令报破。(任意的Shell命令)
這是一個文件的依賴關(guān)系悠就,也就是說,target這一個或多個的目標文件依賴于prerequisites中的文件泛烙,其生成規(guī)則定義在command中理卑。說白一點就是說,prerequisites中如果有一個以上的文件比target文件要新的話蔽氨,command所定義的命令就會被執(zhí)行藐唠。這就是Makefile的規(guī)則帆疟。也就是Makefile中最核心的內(nèi)容。
說到底宇立,Makefile的東西就是這樣一點踪宠,好像我的這篇文檔也該結(jié)束了。呵呵妈嘹。還不盡然柳琢,這是Makefile的主線和核心,但要寫好一個Makefile還不夠润脸,我會以后面一點一點地結(jié)合我的工作經(jīng)驗給你慢慢到來柬脸。內(nèi)容還多著呢。:)
1.2 一個示例
正如前面所說的毙驯,如果一個工程有3個頭文件倒堕,和8個C文件,我們?yōu)榱送瓿汕懊嫠龅哪侨齻€規(guī)則爆价,我們的Makefile應該是下面的這個樣子的垦巴。
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
main.o : main.c defs.h
cc -c main.c
kbd.o : kbd.c defs.h command.h
cc -c kbd.c
command.o : command.c defs.h command.h
cc -c command.c
display.o : display.c defs.h buffer.h
cc -c display.c
insert.o : insert.c defs.h buffer.h
cc -c insert.c
search.o : search.c defs.h buffer.h
cc -c search.c
files.o : files.c defs.h buffer.h command.h
cc -c files.c
utils.o : utils.c defs.h
cc -c utils.c
clean :
rm edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
反斜杠(\)是換行符的意思。這樣比較便于Makefile的易讀铭段。我們可以把這個內(nèi)容保存在文件為“Makefile”或“makefile”的文件中骤宣,然后在該目錄下直接輸入命令“make”就可以生成執(zhí)行文件edit。如果要刪除執(zhí)行文件和所有的中間目標文件序愚,那么憔披,只要簡單地執(zhí)行一下“make clean”就可以了。
在這個makefile中爸吮,目標文件(target)包含:執(zhí)行文件edit和中間目標文件(*.o)活逆,依賴文件(prerequisites)就是冒號后面的那些 .c 文件和 .h文件。每一個 .o 文件都有一組依賴文件拗胜,而這些 .o 文件又是執(zhí)行文件 edit 的依賴文件。依賴關(guān)系的實質(zhì)上就是說明了目標文件是由哪些文件生成的怒允,換言之埂软,目標文件是哪些文件更新的。
在定義好依賴關(guān)系后纫事,后續(xù)的那一行定義了如何生成目標文件的操作系統(tǒng)命令勘畔,一定要以一個Tab鍵作為開頭。記住丽惶,make并不管命令是怎么工作的炫七,他只管執(zhí)行所定義的命令。make會比較targets文件和prerequisites文件的修改日期钾唬,如果prerequisites文件的日期要比targets文件的日期要新万哪,或者target不存在的話侠驯,那么,make就會執(zhí)行后續(xù)定義的命令奕巍。
這里要說明一點的是吟策,clean不是一個文件,它只不過是一個動作名字的止,有點像C語言中的lable一樣檩坚,其冒號后什么也沒有,那么诅福,make就不會自動去找文件的依賴性匾委,也就不會自動執(zhí)行其后所定義的命令。要執(zhí)行其后的命令氓润,就要在make命令后明顯得指出這個lable的名字赂乐。這樣的方法非常有用,我們可以在一個makefile中定義不用的編譯或是和編譯無關(guān)的命令旺芽,比如程序的打包沪猴,程序的備份,等等采章。
1.3 make是如何工作的
在默認的方式下运嗜,也就是我們只輸入make命令。那么悯舟,
- make會在當前目錄下找名字叫“Makefile”或“makefile”的文件担租。
- 如果找到,它會找文件中的第一個目標文件(target)抵怎,在上面的例子中奋救,他會找到“edit”這個文件,并把這個文件作為最終的目標文件反惕。
- 如果edit文件不存在尝艘,或是edit所依賴的后面的 .o 文件的文件修改時間要比edit這個文件新,那么姿染,他就會執(zhí)行后面所定義的命令來生成edit這個文件背亥。
- 如果edit所依賴的.o文件也存在,那么make會在當前文件中找目標為.o文件的依賴性悬赏,如果找到則再根據(jù)那一個規(guī)則生成.o文件狡汉。(這有點像一個堆棧的過程)
- 當然,你的C文件和H文件是存在的啦闽颇,于是make會生成 .o 文件盾戴,然后再用 .o 文件聲明make的終極任務(wù),也就是執(zhí)行文件edit了兵多。
<pre style="box-sizing: border-box; outline: 0px; padding: 8px; margin: 0px 0px 24px; position: relative; white-space: pre-wrap; word-wrap: break-word; overflow-x: auto; font-family: Consolas, Inconsolata, Courier, monospace; font-size: 14px; line-height: 22px; color: rgb(0, 0, 0); word-break: break-all; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-style: initial; text-decoration-color: initial;"> 這就是整個make的依賴性尖啡,make會一層又一層地去找文件的依賴關(guān)系橄仆,直到最終編譯出第一個目標文件。在找尋的過程中可婶,如果出現(xiàn)錯誤沿癞,比如最后被依賴的文件找不到,那么make就會直接退出矛渴,并報錯椎扬,而對于所定義的命令的錯誤,或是編譯不成功具温,make根本不理蚕涤。make只管文件的依賴性,即铣猩,如果在我找了依賴關(guān)系之后揖铜,冒號后面的文件還是不在,那么對不起达皿,我就不工作啦天吓。</pre>
通過上述分析,我們知道峦椰,像clean這種龄寞,沒有被第一個目標文件直接或間接關(guān)聯(lián),那么它后面所定義的命令將不會被自動執(zhí)行汤功,不過物邑,我們可以顯示要make執(zhí)行。即命令——“make clean”滔金,以此來清除所有的目標文件色解,以便重編譯。
于是在我們編程中餐茵,如果這個工程已被編譯過了科阎,當我們修改了其中一個源文件,比如file.c忿族,那么根據(jù)我們的依賴性萧恕,我們的目標file.o會被重編譯(也就是在這個依性關(guān)系后面所定義的命令),于是file.o的文件也是最新的啦肠阱,于是file.o的文件修改時間要比edit要新,所以edit也會被重新鏈接了(詳見edit目標文件后定義的命令)朴读。
而如果我們改變了“command.h”屹徘,那么,kdb.o衅金、command.o和files.o都會被重編譯噪伊,并且簿煌,edit會被重鏈接。
1.4 makefile中使用變量
在上面的例子中鉴吹,先讓我們看看edit的規(guī)則:
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
我們可以看到[.o]文件的字符串被重復了兩次姨伟,如果我們的工程需要加入一個新的[.o]文件,那么我們需要在兩個地方加(應該是三個地方豆励,還有一個地方在clean中)夺荒。當然,我們的makefile并不復雜良蒸,所以在兩個地方加也不累技扼,但如果makefile變得復雜,那么我們就有可能會忘掉一個需要加入的地方嫩痰,而導致編譯失敗剿吻。所以,為了makefile的易維護串纺,在makefile中我們可以使用變量丽旅。makefile的變量也就是一個字符串,理解成C語言中的宏可能會更好纺棺。
比如榄笙,我們聲明一個變量,叫objects, OBJECTS, objs, OBJS, obj, 或是 OBJ五辽,反正不管什么啦办斑,只要能夠表示obj文件就行了。我們在makefile一開始就這樣定義:
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
于是杆逗,我們就可以很方便地在我們的makefile中以“$(objects)”的方式來使用這個變量了乡翅,于是我們的改良版makefile就變成下面這個樣子:
<pre style="box-sizing: border-box; outline: 0px; padding: 8px; margin: 0px 0px 24px; position: relative; white-space: pre-wrap; word-wrap: break-word; overflow-x: auto; font-family: Consolas, Inconsolata, Courier, monospace; font-size: 14px; line-height: 22px; color: rgb(0, 0, 0); word-break: break-all; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-style: initial; text-decoration-color: initial;">objects = main.o kbd.o command.o display.o \ insert.osearch.o files.o utils.o
edit : (objects) cc -o edit(objects) main.o : main.c defs.h cc -c main.c kbd.o : kbd.c defs.h command.h cc -c kbd.c command.o : command.c defs.h command.h cc -c command.c display.o : display.c defs.h buffer.h cc -c display.c insert.o : insert.c defs.h buffer.h cc -c insert.c search.o : search.c defs.h buffer.h cc -c search.c files.o : files.c defs.h buffer.h command.h cc -c files.c utils.o : utils.c defs.h cc -c utils.c clean : rm edit $(objects)</pre>
于是如果有新的 .o 文件加入,我們只需簡單地修改一下 objects 變量就可以了罪郊。
關(guān)于變量更多的話題蠕蚜,我會在后續(xù)給你一一道來。
1.5 讓make自動推導
GNU的make很強大悔橄,它可以自動推導文件以及文件依賴關(guān)系后面的命令靶累,于是我們就沒必要去在每一個[.o]文件后都寫上類似的命令,因為癣疟,我們的make會自動識別挣柬,并自己推導命令。
只要make看到一個[.o]文件睛挚,它就會自動的把[.c]文件加在依賴關(guān)系中邪蛔,如果make找到一個whatever.o,那么whatever.c扎狱,就會是whatever.o的依賴文件侧到。并且 cc -c whatever.c 也會被推導出來勃教,于是,我們的makefile再也不用寫得這么復雜匠抗。我們的是新的makefile又出爐了故源。
<pre style="box-sizing: border-box; outline: 0px; padding: 8px; margin: 0px 0px 24px; position: relative; white-space: pre-wrap; word-wrap: break-word; overflow-x: auto; font-family: Consolas, Inconsolata, Courier, monospace; font-size: 14px; line-height: 22px; color: rgb(0, 0, 0); word-break: break-all; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-style: initial; text-decoration-color: initial;">objects = main.o kbd.o command.o display.o \ insert.o search.o files.o utils.o edit : (objects) cc -o edit(objects) main.o : defs.h kbd.o : defs.h command.h command.o : defs.h command.h display.o : defs.h buffer.h insert.o : defs.h buffer.h search.o : defs.h buffer.h files.o : defs.h buffer.h command.h utils.o : defs.h .PHONY : clean clean : rm edit $(objects)</pre>
這種方法,也就是make的“隱晦規(guī)則”汞贸。上面文件內(nèi)容中绳军,“.PHONY”表示,clean是個偽目標文件著蛙。
關(guān)于更為詳細的“隱晦規(guī)則”和“偽目標文件”删铃,我會在后續(xù)給你一一道來。
1.6 另類風格的makefile
即然我們的make可以自動推導命令踏堡,那么我看到那堆[.o]和[.h]的依賴就有點不爽猎唁,那么多的重復的[.h],能不能把其收攏起來顷蟆,好吧诫隅,沒有問題,這個對于make來說很容易帐偎,誰叫它提供了自動推導命令和文件的功能呢逐纬?來看看最新風格的makefile吧。
<pre style="box-sizing: border-box; outline: 0px; padding: 8px; margin: 0px 0px 24px; position: relative; white-space: pre-wrap; word-wrap: break-word; overflow-x: auto; font-family: Consolas, Inconsolata, Courier, monospace; font-size: 14px; line-height: 22px; color: rgb(0, 0, 0); word-break: break-all; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-style: initial; text-decoration-color: initial;"> objects = main.o kbd.o command.o display.o \ insert.o search.o files.o utils.o edit : (objects) cc -o edit(objects) (objects) : defs.h kbd.o command.o files.o : command.h display.o insert.o search.o files.o : buffer.h .PHONY : clean clean : rm edit(objects)</pre>
這種風格削樊,讓我們的makefile變得很簡單豁生,但我們的文件依賴關(guān)系就顯得有點凌亂了。魚和熊掌不可兼得漫贞。還看你的喜好了甸箱。我是不喜歡這種風格的,一是文件的依賴關(guān)系看不清楚迅脐,二是如果文件一多芍殖,要加入幾個新的.o文件,那就理不清楚了谴蔑。
1.7 清空目標文件的規(guī)則
每個Makefile中都應該寫一個清空目標文件(.o和執(zhí)行文件)的規(guī)則豌骏,這不僅便于重編譯,也很利于保持文件的清潔隐锭。這是一個“修養(yǎng)”(呵呵窃躲,還記得我的《編程修養(yǎng)》嗎)。一般的風格都是:
clean:
rm edit $(objects)
更為穩(wěn)健的做法是:
.PHONY : clean
clean :
-rm edit $(objects)
前面說過钦睡,.PHONY意思表示clean是一個“偽目標”框舔,。而在rm命令前面加了一個小減號的意思就是,也許某些文件出現(xiàn)問題刘绣,但不要管,繼續(xù)做后面的事挣输。當然纬凤,clean的規(guī)則不要放在文件的開頭,不然撩嚼,這就會變成make的默認目標停士,相信誰也不愿意這樣。不成文的規(guī)矩是——“clean從來都是放在文件的最后”完丽。
上面就是一個makefile的概貌恋技,也是makefile的基礎(chǔ),下面還有很多makefile的相關(guān)細節(jié)逻族,準備好了嗎蜻底?準備好了就來。