開源項目makefile晦澀難懂?能改就不寫?學會編寫自己的Makefile,讓別人對你投來羨慕的目光

轉自嵌入式RAM

學號:16020311003。姓名:楊虎成【嵌牛導讀】makefile帶來的好處就是——“自動化編譯”,一旦寫好,只需要一個make命令,整個工程完全自動編譯,極大的提高了軟件開發的效率。

【嵌牛鼻子】要把源文件編譯成中間代碼文件,在Windows下也就是 .obj 文件,UNIX下是 .o 文件,即 Object File

【嵌牛提問】

你有比makefile更簡單又強大得方法嗎?

【嵌牛正文】

相信很多朋友都有過這樣的經歷,看著開源項目中好幾頁的makefile文件,不知所云。在日常學習和工作中,也有意無意的去回避makefile,能改就不寫,能用IDE就用IDE。其實makefile并沒有想象的那么難寫,只要你明白了其中的原理,自己實踐幾次。你也可以自己寫makefile,讓別人對你頭來羨慕的目光。下面是本人的經驗,忘大神指正。

簡單的說,makefile定義了一系列的規則來指定,哪些文件需要先編譯,哪些文件需要后編譯,哪些文件需要重新編譯,甚至可以在makefile中執行shell腳本。makefile帶來的好處就是——“自動化編譯”,一旦寫好,只需要一個make命令,整個工程完全自動編譯,極大的提高了軟件開發的效率。

關于程序的編譯和鏈接

一般來說,無論是C還是C++,首先要把源文件編譯成中間代碼文件,在Windows下也就是 .obj 文件,UNIX下是 .o 文件,即 Object File,這個動作叫做編譯(compile),一般來說,每個源文件都應該對應于一個中間目標文件(O文件或是OBJ文件)。然后再把大量的Object File合成執行文件,這個動作叫作鏈接(link)。

編譯時,編譯器需要的是語法的正確,函數與變量的聲明的正確。對于后者,通常是你需要告訴編譯器頭文件的所在位置(頭文件中應該只是聲明,而定義應該放在C/C++文件中),只要所有的語法正確,編譯器就可以編譯出中間目標文件。

鏈接時,主要是鏈接函數和全局變量,所以,我們可以使用這些中間目標文件(O文件或是OBJ文件)來 鏈接我們的應用程序。鏈接器并不管函數所在的源文件,只管函數的中間目標文件(Object File),在大多數時候,由于源文件太多,編譯生成的中間目標文件太多,而在鏈接時需要明顯地指出中間目標文件名,這對于編譯很不方便,所以,我們要給 中間目標文件打個包,在Windows下這種包叫“庫文件”(Library File),也就是 .lib 文件,在UNIX下,是Archive File,也就是 .a 文件。

下面我們開始看看如何自己寫出makefile。

Makefile的規則

目標 : 需要的條件 (注意冒號兩邊有空格)

命令  (注意前面用tab鍵開頭)

解釋一下:

1 目標可以是一個或多個,可以是Object File,也可以是執行文件,甚至可以是一個標簽。

2 需要的條件就是生成目標所需要的文件或目標

3 命令就是生成目標所需要執行的腳本

總結一下,就是說一條makefile規則規定了編譯的依賴關系,也就是目標文件依賴于條件,生成規則用命令來描述。在編譯時,如果需要的條件的文件比目標更新的話,就會執行生成命令來更新目標。

下面舉個簡單的例子說明。如果一個工程有3個頭文件,和8個C文件,我們為了完成前面所述的那三個規則,我們的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文件中,然后執行make就可以進行編譯,執行make clean就可以刪除所有目標文件。解釋一下,也就是說生成最終的目標文件edit,依賴于一系列的.o目標文件,而這些.o文件又是需要用源文件來編譯生成的。

需要注意的是,clean后面沒有條件,而clean本身也不是文件,它只不過是一個動作名字,其冒號后什么也沒有,那么,make就不會自動去找文件的依賴性,也就不會自動執行其后所定義的命令。

make是如何工作的

在默認的方式下,也就是我們只輸入make命令。那么,

1、make會在當前目錄下找名字叫“Makefile”或“makefile”的文件。

2、如果找到,它會找文件中的第一個目標文件(target),在上面的例子中,他會找到“edit”這個文件,并把這個文件作為最終的目標文件。

3、如果edit文件不存在,或是edit所依賴的后面的 .o 文件的文件修改時間要比edit這個文件新,那么,他就會執行后面所定義的命令來生成edit這個文件。

4、如果edit所依賴的.o文件也不存在,那么make會在當前文件中找目標為.o文件的依賴性,如果找到則再根據那一個規則生成.o文件。(這有點像一個堆棧的過程)

5、當然,你的C文件和H文件是存在的啦,于是make會生成 .o 文件,然后再用 .o 文件生命make的終極任務,也就是執行文件edit了。

相信很多朋友都有過這樣的經歷,看著開源項目中好幾頁的makefile文件,不知所云。在日常學習和工作中,也有意無意的去回避makefile,能改就不寫,能用ide就用ide。其實makefile并沒有想象的那么難寫,只要你明白了其中的原理,自己實踐幾次。你也可以自己寫makefile,讓別人對你頭來羨慕的目光。下面是本人的學習成果,忘大神指正。

簡單的說,makefile定義了一系列的規則來指定,哪些文件需要先編譯,哪些文件需要后編譯,哪些文件需要重新編譯,甚至可以在makefile中執行shell腳本。makefile帶來的好處就是——“自動化編譯”,一旦寫好,只需要一個make命令,整個工程完全自動編譯,極大的提高了軟件開發的效率。

關于程序的編譯和鏈接

一般來說,無論是C還是C++,首先要把源文件編譯成中間代碼文件,在Windows下也就是 .obj 文件,UNIX下是 .o 文件,即 Object File,這個動作叫做編譯(compile),一般來說,每個源文件都應該對應于一個中間目標文件(O文件或是OBJ文件)。然后再把大量的Object File合成執行文件,這個動作叫作鏈接(link)。

編譯時,編譯器需要的是語法的正確,函數與變量的聲明的正確。對于后者,通常是你需要告訴編譯器頭文件的所在位置(頭文件中應該只是聲明,而定義應該放在C/C++文件中),只要所有的語法正確,編譯器就可以編譯出中間目標文件。

鏈接時,主要是鏈接函數和全局變量,所以,我們可以使用這些中間目標文件(O文件或是OBJ文件)來 鏈接我們的應用程序。鏈接器并不管函數所在的源文件,只管函數的中間目標文件(Object File),在大多數時候,由于源文件太多,編譯生成的中間目標文件太多,而在鏈接時需要明顯地指出中間目標文件名,這對于編譯很不方便,所以,我們要給 中間目標文件打個包,在Windows下這種包叫“庫文件”(Library File),也就是 .lib 文件,在UNIX下,是Archive File,也就是 .a 文件。

下面我們開始看看如何自己寫出makefile。

Makefile的規則

目標 : 需要的條件 (注意冒號兩邊有空格)

命令  (注意前面用tab鍵開頭)

解釋一下:

1 目標可以是一個或多個,可以是Object File,也可以是執行文件,甚至可以是一個標簽。

2 需要的條件就是生成目標所需要的文件或目標

3 命令就是生成目標所需要執行的腳本

總結一下,就是說一條makefile規則規定了編譯的依賴關系,也就是目標文件依賴于條件,生成規則用命令來描述。在編譯時,如果需要的條件的文件比目標更新的話,就會執行生成命令來更新目標。

下面舉個簡單的例子說明。如果一個工程有3個頭文件,和8個C文件,我們為了完成前面所述的那三個規則,我們的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文件中,然后執行make就可以進行編譯,執行make clean就可以刪除所有目標文件。解釋一下,也就是說生成最終的目標文件edit,依賴于一系列的.o目標文件,而這些.o文件又是需要用源文件來編譯生成的。

需要注意的是,clean后面沒有條件,而clean本身也不是文件,它只不過是一個動作名字,其冒號后什么也沒有,那么,make就不會自動去找文件的依賴性,也就不會自動執行其后所定義的命令。

make是如何工作的

在默認的方式下,也就是我們只輸入make命令。那么,

1、make會在當前目錄下找名字叫“Makefile”或“makefile”的文件。

2、如果找到,它會找文件中的第一個目標文件(target),在上面的例子中,他會找到“edit”這個文件,并把這個文件作為最終的目標文件。

3、如果edit文件不存在,或是edit所依賴的后面的 .o 文件的文件修改時間要比edit這個文件新,那么,他就會執行后面所定義的命令來生成edit這個文件。

4、如果edit所依賴的.o文件也不存在,那么make會在當前文件中找目標為.o文件的依賴性,如果找到則再根據那一個規則生成.o文件。(這有點像一個堆棧的過程)

5、當然,你的C文件和H文件是存在的啦,于是make會生成 .o 文件,然后再用 .o 文件生命make的終極任務,也就是執行文件edit了。

makefile中使用變量

前面的知識已經足以讓你自己完成一個簡單的makefile了,不過makefile的精妙之處遠不止如此,下面來看看如何在makefile中使用變量吧。

在上面的例子中,先讓我們看看edit的規則:

? ? ? 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 = main.o kbd.o command.o display.o /

? ? ? ? ? ? ? insert.o search.o files.o utils.o

  這樣一來,原來的makefile變成如下的樣子:

  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 : 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)

這樣看起來方便多了吧,也更加省事了。如果有新的.o文件怎么辦?當然是在objects里面添加了,這樣只需要一處改變,很方便吧。

  

讓make自動推導

GNU的make很強大,它可以自動推導文件以及文件依賴關系后面的命令,于是我們就沒必要去在每一個[.o]文件后都寫上類似的命令,因為,我們的make會自動識別,并自己推導命令。

只要make看到一個[.o]文件,它就會自動的把[.c]文件加在依賴關系中,如果make找到一 個whatever.o,那么whatever.c,就會是whatever.o的依賴文件。并且 cc -c whatever.c 也會被推導出來,于是,我們的makefile再也不用寫得這么復雜。我們的是新的makefile又出爐了。

 

 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

  clean :

? ? ? ? ? ? rm edit $(objects)

當然,如果你覺得那么多[.o]和[.h]的依賴有點不爽的話,好吧,沒有問題,這個對于make來說很容易,誰叫它提供了自動推導命令和文件的功能呢?來看看最新風格的makefile吧。 

 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

? ? clean :

? ? ? ? ? ? rm edit $(objects)

不過話說回來,本人并不推薦這種方法。雖然簡單,但是這種方法破壞了文件本身的依賴關系。如果文件過多的話,可能你自己都不清楚了。

  

怎么樣,makefile是不是既簡單又強大?其實makefile遠比這更強大。

makefile中使用變量

前面的知識已經足以讓你自己完成一個簡單的makefile了,不過makefile的精妙之處遠不止如此,下面來看看如何在makefile中使用變量吧。

在上面的例子中,先讓我們看看edit的規則:

?

? ? 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 = main.o kbd.o command.o display.o /

? ? ? ? ? ? ? insert.o search.o files.o utils.o

這樣一來,原來的makefile變成如下的樣子:

  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 : 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)

這樣看起來方便多了吧,也更加省事了。如果有新的.o文件怎么辦?當然是在objects里面添加了,這樣只需要一處改變,很方便吧。

  

讓make自動推導

GNU的make很強大,它可以自動推導文件以及文件依賴關系后面的命令,于是我們就沒必要去在每一個[.o]文件后都寫上類似的命令,因為,我們的make會自動識別,并自己推導命令。

只要make看到一個[.o]文件,它就會自動的把[.c]文件加在依賴關系中,如果make找到一 個whatever.o,那么whatever.c,就會是whatever.o的依賴文件。并且 cc -c whatever.c 也會被推導出來,于是,我們的makefile再也不用寫得這么復雜。我們的是新的makefile又出爐了。

 

 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

  clean :

? ? ? ? ? ? rm edit $(objects)

當然,如果你覺得那么多[.o]和[.h]的依賴有點不爽的話,好吧,沒有問題,這個對于make來說很容易,誰叫它提供了自動推導命令和文件的功能呢?來看看最新風格的makefile吧。

 

 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

? ? clean :

? ? ? ? ? ? rm edit $(objects)

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,546評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,570評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,505評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,017評論 1 313
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,786評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,219評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,287評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,438評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,971評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,796評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,995評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,540評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,230評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,918評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,697評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374

推薦閱讀更多精彩內容