如何写一个通用的Makefile

本文目的只是为了方便自己以后查看。通用Makefile

有三个文件 a.c b.c a.h，内容：

//a.c

#include <stdio.h>
#include "a.h"

int main()
{
	printf("hello, world!\n");
	printf("A= %d\n", A);
	test_fun();
	return 0;
}

//a.h
#define A 1

//b.c
#include <stdio.h>

int test_fun()
{ 
	printf("it is B\n");
	return 0;
} 

Makefile可以写成：

#Makefile 1
test:a.c b.c a.h
	gcc -o test a.c b.c


#Makefile 2
test:a.o b.o
	gcc -o test a.o b.o
a.o : a.c 
	gcc -c -o a.o a.c	
b.o : b.c
	gcc -c -o b.o b.c	

#Makefile 3
test:a.o b.o
	gcc -o test a.o b.o
a.o:a.c a.h
%.o : %.c 
	gcc -c -o $@ $<

#Makefile 4
objs := a.o b.o

test:$(objs)
	gcc -o test $^
# .a.o.d .b.o.d
dep_files := $(foreach f,$(objs),.$(f).d)
dep_files := $(wildcard $(dep_files))

ifneq ($(dep_files),)
  include $(dep_files)
endif

%.o : %.c 
	gcc -Wp,-MD,.$@.d -c -o $@ $<
#%.o : %.c
#	gcc -c -o $@ $< -MD -MF .$@.d

clean:
	rm *.o test

.PHONY: clean

%.o：表示所有的.o文件
%.c：表示所有的.c文件
$@：表示目标
$<：表示第1个依赖文件
$^：表示所有依赖文件
.PHONY: clean	是把clean定义为假想目标。他就不会判断名为“clean”的文件是否存在

gcc -M c.c // 打印出依赖
gcc -M -MF c.d c.c  // 把依赖写入文件c.d
gcc -c -o c.o c.c -MD -MF c.d  // 编译c.o, 把依赖写入文件c.d

Makefile的函数

#1 $(foreach var,list,text)

A = a b c
B = $(foreach f, &(A), $(f).o)

all:
	@echo B = $(B)

# 执行make时输出
# B = a.o b.o c.o

#2 函数filter/filter-out语法如下：
#$(filter pattern...,text)      在text中取出符合patten格式的值
#$(filter-out pattern...,text)  在text中取出不符合patten格式的值

C = a b c d/

D = $(filter %/, $(C))
E = $(filter-out %/, $(C))

all:
        @echo D = $(D)
        @echo E = $(E)

#执行make时输出
# D = d/
# E = a b c

#3 $(wildcard pattern)   pattern定义了文件名的格式, wildcard取出其中存在的文件
# 在该目录下创建三个文件：a.c b.c c.c
files = $(wildcard *.c)

all:
        @echo files = $(files)

#执行make时输出
# files = a.c b.c c.c

#也可以用wildcard函数来判断，真实存在的文件
files2 = a.c b.c c.c d.c e.c  abc
files3 = $(wildcard $(files2))

all:
        @echo files3 = $(files3)

#执行make时输出
# files3 = a.c b.c c.c

#4 $(patsubst pattern,replacement,$(var))
#patsubst函数是从var变量里面取出每一个值，如果这个符合pattern格式，把它替换成replacement格式

files2  = a.c b.c c.c d.c e.c abc

dep_files = $(patsubst %.c,%.d,$(files2))

all:
        @echo dep_files = $(dep_files)

#执行make时输出
# dep_files = a.d b.d c.d d.d e.d abc

一下面的项目为例子，写一个通用项目的Makefile。项目的文件目录结构。

 

各级子目录的Makefile ，以display目录为例：

obj-y += disp_manager.o
obj-y += fb.o
obj-y += test/


#test 目录下的Makefile为：

obj-y += test.o

顶层目录的Makefile：

CROSS_COMPILE = arm-linux-
AS		= $(CROSS_COMPILE)as
LD		= $(CROSS_COMPILE)ld
CC		= $(CROSS_COMPILE)gcc
CPP		= $(CC) -E
AR		= $(CROSS_COMPILE)ar
NM		= $(CROSS_COMPILE)nm

STRIP		= $(CROSS_COMPILE)strip
OBJCOPY		= $(CROSS_COMPILE)objcopy
OBJDUMP		= $(CROSS_COMPILE)objdump

export AS LD CC CPP AR NM
export STRIP OBJCOPY OBJDUMP

CFLAGS := -Wall -O2 -g
CFLAGS += -I $(shell pwd)/include

LDFLAGS := -lm -lfreetype

export CFLAGS LDFLAGS

TOPDIR := $(shell pwd)
export TOPDIR

TARGET := show_file


obj-y += main.o
obj-y += display/
obj-y += draw/
obj-y += encoding/
obj-y += fonts/


all : 
	make -C ./ -f $(TOPDIR)/Makefile.build
	$(CC) $(LDFLAGS) -o $(TARGET) built-in.o


clean:
	rm -f $(shell find -name "*.o")
	rm -f $(TARGET)

distclean:
	rm -f $(shell find -name "*.o")
	rm -f $(shell find -name "*.d")
	rm -f $(TARGET)
	

 顶层目录的Makefile.build：

PHONY := __build
__build:


obj-y :=
subdir-y :=

include Makefile

# obj-y := a.o b.o c/ d/
# $(filter %/, $(obj-y))   : c/ d/
# __subdir-y  : c d
# subdir-y    : c d
__subdir-y	:= $(patsubst %/,%,$(filter %/, $(obj-y)))
subdir-y	+= $(__subdir-y)

# c/built-in.o d/built-in.o
subdir_objs := $(foreach f,$(subdir-y),$(f)/built-in.o)

# a.o b.o
cur_objs := $(filter-out %/, $(obj-y))
dep_files := $(foreach f,$(cur_objs),.$(f).d)
dep_files := $(wildcard $(dep_files))

ifneq ($(dep_files),)
  include $(dep_files)
endif


PHONY += $(subdir-y)


__build : $(subdir-y) built-in.o

$(subdir-y):
	make -C $@ -f $(TOPDIR)/Makefile.build

built-in.o : $(cur_objs) $(subdir_objs)
	$(LD) -r -o $@ $^

dep_file = .$@.d

%.o : %.c
	$(CC) $(CFLAGS) -Wp,-MD,$(dep_file) -c -o $@ $<
	
.PHONY : $(PHONY)

 说明：

本程序的Makefile分为3类:
1. 顶层目录的Makefile
2. 顶层目录的Makefile.build
3. 各级子目录的Makefile

一、各级子目录的Makefile：
   它最简单，形式如下：
obj-y += file.o
obj-y += subdir/
   
   "obj-y += file.o"表示把当前目录下的file.c编进程序里，
   "obj-y += subdir/"表示要进入subdir这个子目录下去寻找文件来编进程序里，是哪些文件由subdir目录下的Makefile决定。

注意: "subdir/"中的斜杠"/"不可省略

二、顶层目录的Makefile：
   它除了定义obj-y来指定根目录下要编进程序去的文件、子目录外，主要是定义工具链、编译参数、链接参数──就是文件中用export导出的各变量。

三、顶层目录的Makefile.build：
   这是最复杂的部分，它的功能就是把某个目录及它的所有子目录中、需要编进程序去的文件都编译出来，打包为built-in.o。

四、怎么使用这套Makefile：
1．把顶层Makefile, Makefile.build放入程序的顶层目录
2．修改顶层Makefile
2.1 修改工具链
2.2 修改编译选项、链接选项
2.3 修改obj-y决定顶层目录下哪些文件、哪些子目录被编进程序
2.4 修改TARGET，这是用来指定编译出来的程序的名字

3. 在各一个子目录下都建一个Makefile，形式为：
obj-y += file1.o
obj-y += file2.o
obj-y += subdir1/
obj-y += subdir2/

4. 执行"make"来编译，执行"make clean"来清除，执行"make distclean"来彻底清除