在GNU make管理的项目中萌萌地处理头文件依赖

以下要说的显然是C语言的项目。

当然可以考虑用其他工具替代make，比如SCons和CMake，或者auto tools什么的，但很多时候手写Makefile还是非常干净利索，爽快好用的，尤其在项目比较小的时候。

规模一旦扩大，确实写Makefile就有点费劲了。比较突出的一个问题是对头文件的依赖。make自己是没有办法处理的，必须要借助编译器。

以下会列举三种常见的Makefile写法。后两种处理了对头文件的依赖，推荐使用最后一种。

项目结构

说下演示用的项目，只包含三个代码文件，结构如下：

.
├── bar.c
├── bar.h
├── foo.c
└── Makefile

bar.h

#ifndef _BAR_H_
#define _BAR_H_

void bar(void);

#endif

bar.c

#include <stdio.h>

void bar(void)
{
    printf("bar!\n");
}

foo.c

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

int main()
{
    printf("foo -> ");
    bar();
    return 0;
}

1. 不考虑头文件依赖的Makefile

如果不处理对头文件的依赖，可以写出类似下面这样的“万能Makefile”，做做小东西无往不利。
缺陷是头文件修改了以后不能自动重新编译，需要不断make clean && make。

TARGET := foo
CC := gcc
LDLIBS := -lm

SRCS := $(wildcard *.c)
OBJS := $(SRCS:.c=.o)

.PHONY: all clean

all: $(TARGET)

$(TARGET): $(OBJ)

clean:
    rm -f $(OBJ) $(TARGET)

2. gcc + sed

这是一种应该抛弃的方案，详细的步骤分解可以看这篇文章：Autodependencies with GNU make。

简要概括下，就是利用gcc的选项-M或-MM，来生成依赖文件。（-M包括对系统头文件的依赖，-MM不包括。下面要说的-MD和-MMD也是一样的关系。）生成的依赖文件还需要用脚本做一些修改，以保证后期修改了代码之后，依赖文件能够重新生成。

烦人的地方就是用脚本修改依赖文件，有这样改的：

%.o: %.c
    gcc -c $(CFLAGS) $*.c -o $*.o
    gcc -MM $(CFLAGS) $*.c > $*.d
    @cp -f $*.d $*.d.tmp
    @sed -e 's/.*://' -e 's/\\$$//' < $*.d.tmp | fmt -1 | \
      sed -e 's/^ *//' -e 's/$$/:/' >> $*.d
    @rm -f $*.d.tmp

也有这样改的：

%.d: %.c
    @set -e; rm -f $@; \
    $(CC) -M $(CPPFLAGS) $< > $@.$$$$; \
    sed 's,\($*\)\.o[ :]*,\1.o $@ :,g' < $@.$$$$ > $@; \
    rm -f $@.$$$$

需要抛弃的原因不言而喻。。。

3. MMD萌萌的

目前最好的方案，是利用gcc的选项-MMD来自动生成依赖文件。这个早该普及的方法其实没那么多人知道，经常见到有人在死记sed命令。其实gcc早就提供更好的方式了。只要加上萌萌的-MMD选项，会在编译的过程中顺便生成依赖文件。没有手动修改依赖文件的必要，依赖文件总能正确地重新生成。

就是像下面这样写：

TARGET := foo
CC := gcc
LDLIBS := -lm
CFLAGS := -MMD -MP

SRCS := $(wildcard *.c)
OBJS := $(SRCS:.c=.o)
DEPS := $(SRCS:.c=.d)

.PHONY: all clean

all: $(TARGET)

$(TARGET): $(OBJS)

-include $(DEPS)

clean:
    rm -f $(OBJS) $(DEPS) $(TARGET)

可以和前面的“万能Makefile”对比一下：

只是简单添加了几行。要注意-include $(DEPS)不能放在all规则之前，all必须是第一个规则嘛。

还有要提一下的是选项-MP，它的作用是为头文件生成这样的依赖规则：

bar.h:

空的，没有依赖，没有动作，但并不是没有作用。如果没有这个规则，万一误删了bar.h，或者改名了，而foo.c忘了改，make会这样提示：

勉强能接受？可要是加上-MP选项，提前生成了上面那个空的规则，make会继续执行，然后让编译器给出更准确的错误信息：

所以没事还是把-MP加上吧。。。

本文同步自：http://suosuopuo.com/2015/01/01/makefile-dependencies/