Makefile 是组织代码编译的一种简单办法。make 工具和 makefile 是比较复杂且强大的,本教程甚至还没有触及到 make 工具的皮毛,但是作为入门指南,它可以帮助你快速又轻松地为中小型项目创建自己的 Makefile。
1. 一个简单的例子
让我们从一个简单例子开始,首先我们需要准备三个文件。这三个文件分别代表主程序,工具函数的实现和声明。
void myPrintHelloMake();
#include<hellomake.h>
int main()
{
// call a func in another file.
myPrintHelloMake();
return 0;
}
#include<stdio.h>
#include<hellomake.h>
void myPrintHelloMake()
{
printf("Hello, makefiles!\n");
return;
}
有了这三个文件,我们可以用下面的指令来编译
gcc -o hellomake hellomake.c hellofunc.c -I.
这条指令编译两个 c 文件,并且生成可执行文件 hellomake。-I.
参数告诉工 gcc 从当前目录寻找头文件 hellomake.h。如果没有 makefile 的话,我们在测试 / 修改 / 调试代码的时候一般可以在 terminal 上用上下键切换编译指令,这样就不用每编译一次都要敲一次编译指令了。
但是不幸的是,这种方法有两个缺点:1, 如果你不小心丢掉了编译指令(比如不小心关掉了 terminal)或者换了一个电脑,你就得重新敲一遍编译指令;2,就算你只修改了某一个 c 文件,你也必须把所有的源文件全部重新编译一次,这个是非常耗时间的,也是完全没有必要的。
这两个问题都可以通过写一个 makefile 来解决。
2. Makefile version1
最简单的 Makefile 文件长这样:
hellomake: hellomake.c hellofun.c
gcc -o hellomake hellomake,c hellofun.c -I.
把这两行写入到一个名为 Makefile 或 makefile 的文件中,然后在 terminal 输入make
,系统就会按照 makefile 文件中定义的规则编译你的代码。注意,make
命令不带参数的话,会默认执行 makefile 文件中的第一条规则。此外,通过将命令依赖的文件列表放在:
之后的第一行,make 就知道如果其中的任何文件发生更改,就需要执行 hellomake 规则。这样就马上解决了第一个问题,不需要在 terminal 中上下翻找最后一个编译命令了。但是这样写,make 仍然不能有效的只编译最新的更改。
有一点需要特别注意的是,在 gcc 命令之前有一个 tab 字符。事实上,在任何指令之前,都必须加一个 tab 字符,这是 make 的要求,不加 tab, make 会不开心的:)
3. Makefile version2
我们更进一步,让 makefile 更加高效一点。
CC=gcc
CFLAG=-I.
hellomake:hellomake.o hellofunc.o
$(CC) -o hellomake hellomake.o hellofunc.o
现在,我们在 makefile 中定义了一些常量,CC 和 CFLAG,这些常量告诉 make 如何编译 hellomake.c 和 hellofunc.c 文件。CC 宏定义了要使用哪个编译器,CFLAG 是一些编译标志。通过将目标文件 hellomake.o 和 hellofunc.o 放在依赖列表中,make 就知道首先需要编译 c 文件得到目标文件,然后链接得到可执行文件 hellomake。对于大多数小型项目来说,这种 makefile 已经足够了。
4. Makefile version3
但是上个版本的 makefile 还忽略了一点:对头文件的依赖。如果你修改了 hellomake.h 文件,然后重新执行 make,这时候即使需要重新编译 c 文件,make 也不会重编的。为了解决这个问题,我们得告诉 make,c 文件依赖哪些 h 文件。
CC=gcc
CFLAG=-I.
DEPS = hellomake.h
%.o:%.c $(DEPS)
$(CC) -c -o $@ $< $(CFLAGS)
hellomake: hellomake.o hellofunc.o
$(CC) -o hellomake hellomake.o hellofunc.o
在这个版本中,我们新加了一个常量 DEPS,这是 c 文件依赖的头文件集合。然后,我们又定义了一个适用于所有*.o 文件的规则,这个规则说明. o 文件依赖于同名的. c 文件和 DEPS 中包含的头文件。为了产生. o 文件,make 需要使用 CC 常量定义的编译器编译. c 文件。-c
标志表示产生目标文件, -o $@
表示将输出文件命名为:
左边的文件名, $<
表示依赖列表中的第一个项。
5. makefile version4
最后使用特殊的宏$@ $^
做最后一次简化,让编译规则更加通用。$@ $^
分别表示:
左边和右边。在下面的例子中,所有的头文件都应该作为 DEPS 宏的一部分,所有的目标文件*.o 都应该作为 OBJ 宏的一部分。
CC=gcc
CFLAGS=-I.
DEPS = hellomake.h
OBJ = hellomake.o hellofunc.o
%.o:%.c $(DEPS)
$(CC) -c -o $@ $< $(CFLAGS)
hellomake: $(OBJ)
$(CC) -o $@ $^ $(CFLAGS)
6. makefile version5
如果我们想把头文件,源文件和其他库文件分别放在不同的文件夹,那么 makefile 该怎么写呢?
另外,我们可以隐藏那些烦人的中间文件(目标文件)吗?当然可以!
下面的 makefile 定义了 include 文件夹,lib 文件夹路径,并且把目标文件放到 src 文件夹的子文件夹 obj 里面。同时,还定义了一个宏,用于包含任何你想要包含的库,比如 math 库-lm
。这个 makefile 文件应该位于 src 目录,注意,这个 makefile 还包含了一个规则用于清理 source 和 obj 文件夹,只需要输入make clean
即可。.PHONY
规则可以让 make 不去改动任何名为 clean 的文件(如果有的话)。
IDIR = ../include
CC=gcc
CFLAGS=-I$(IDIR)
ODIR=obj
LDIR=../lib
LIBS=-lm
_DEPS=hellomake.h
DEPS=$(pathsubst %,$(IDIR)/%,$(_DEPS))
_OBJ= hellomake.o hellofunc.o
OBJ = $(pathsubst %,$(ODIR)/%,$(_OBJ))
$(ODIR)/%.o:%.c $(DEPS)
$(CC -c -o $@ $< $(CFLAGS
hellomake:$(OBJS)
$(CC) -o $@ $^ $(CFLAGS) $(LIBS)
.PHONY:clean
clean:
rm -f $(ODIR)/*.o *~ core $(INCDIR)/*~
现在,我们有了一个非常不错的 makefile,你可以对其进行简单的修改来管理中小型软件项目了。你也可以将多个规则写到一个 makefile 里面,甚至可以在一个规则中调用其他规则。
有关 make 和 makefile 的更多资料,敬请参考《GNU make 手册》。