常用的C/C++工程Makefile模板

转帖：一辉的文章

在Linux下做开发难免要接触makefile，整个项目的构建都依赖于它。100个developer有100种makefile的写法，在一个较大的项目中，各种各样的makefile无论在开发、后期维护还是整个系统的持续集成都是一个负担。

有幸参与重构一个遗留系统的makefile，以下是一些心得和一个makefile模板。
重构目的：
1.清晰易懂、容易维护
2.方便系统的持续集成
重构原则：
1.子模块makefile模板化
2.外部依赖、通用宏定义集中化
3.中间和最终输出集中，便于系统构建

下面是总结出的一个makefile模板，我在日常的开发中都用它，其中加入了详细的注释。

view plain copy to clipboard print ?

1. #Get the ROOT_PATH which common files located, assuming this makefile located in $(ROOT_PATH)/src/sub_module
2. ROOT_PATH = $(shell cd ../..; pwd)
4. #Where define the path of third party modules
5. include $(ROOT_PATH)/path
7. #Where define common macros such as CC=gcc, CXX=g++ and so on
8. include $(ROOT_PATH)/common
10. #Set target output path and the path of intermidiate object
11. #The path macros should include in $(ROOT_PATH)/path
12. OUT_PATH = $(OUTPUT_PATH)/submodule
13. OBJ_PATH = $(TMPOBJ_PATH)/submodule
14. TARGET = $(OUT_PATH)/targe
16. #If the targe is share object then set corresponding flags
17. #which should define in $(ROOT_PATH)/common
18. CFLAGS += $(CFLAGS_SO)
19. LDFLAGS += $(LDFLAGS_SO)
20. #Custom Predefines
21. CFLAGS += -DXXXXXXXX
22. CFLAGS += -DYYYYYYYY
23. #Dependent header files
24. #The path macros should include in $(ROOT_PATH)/path
25. CFLAGS += -I. /
26. -I$(XXXX_INC) /
27. -I$(YYYY_INC) /
28. -I$(ZZZZ_INC)
29. #Dependent libraries
30. #The path macros should include in $(ROOT_PATH)/path
31. LDFLAGS += -L$(XXXX_LIB) -lxxxx /
32. -L$(YYYY_LIB) -lyyyy
34. #Set CPP source directory
35. CPP_SRCDIR = .
36. #Or set specific CPP Source files
37. ADDITIONAL_CPP_SOURCES = /
38. $(PATH_A)/a.cpp /
39. $(PATH_B)/b.cpp
41. #Traverse every directory in $(CPP_SRCDIR), and find every cpp file
42. CPP_SOURCES = $(foreach d,$(CPP_SRCDIR),$(wildcard $(d)/*.cpp) ) $(ADDITIONAL_CPP_SOURCES)
43. #Traverse every cpp file in $(CPP_SOURCES) and get corresponding object file(.o)
44. CPP_OBJFILES = $(patsubst %.cpp,$(OBJ_PATH)/%.o,$(notdir $(CPP_SOURCES)))
46. #Set C source directory
47. C_SRCDIR =
48. #Or set specific C Source files
49. ADDITIONAL_C_SOURCES = /
50. $(PATH_A)/a.c /
51. $(PATH_B)/b.c
53. #C Source files
54. C_SOURCES = $(foreach d,$(C_SRCDIR),$(wildcard $(d)/*.c) ) $(ADDITIONAL_C_SOURCES)
55. C_OBJFILES = $(patsubst %.c,$(OBJ_PATH)/%.o,$(notdir $(C_SOURCES)))
57. #Set vpath where to find these types of files
58. vpath %.cpp $(dir $(CPP_SOURCES))
59. vpath %.c $(dir $(C_SOURCES))
60. vpath %.o $(OBJ_PATH)
62. #The first target to be executed
63. all: target
65. target: $(TARGET)
67. #Static dependecy pattern
68. #$(OBJ_PATH)/%.o define the pattern of target and %.c or %.cpp is the final dependency
69. $(C_OBJFILES): $(OBJ_PATH)/%.o: %.c
70. -mkdir -p $(OBJ_PATH)
71. $(CXX) -c $(CFLAGS) -o $@ $<
73. $(CPP_OBJFILES): $(OBJ_PATH)/%.o: %.cpp
74. -mkdir -p $(OBJ_PATH)
75. $(CXX) -c $(CFLAGS) -o $@ $<
77. $(TARGET): $(CPP_OBJFILES) $(C_OBJFILES)
78. -mkdir -p $(OUT_PATH)
79. $(CXX) -o $@ $^ $(LDFLAGS)
81. clean:
82. -rm -rf $(OBJ_PATH)
83. -rm -f $(TARGET)