Question

我正在尝试学习项目的“最佳实践”makefile。

请查看我下面的Makefile文件并提出更改以加强它。

目录布局：

root dir
---  Makefile
deps
---  deps
bin
---  binary
objs
---  all .o files
include
---  all .h files
src
---  all .c .cc files

makefile：

#
# Generic makefile
#

all: tengine test2

#
# Include files for compiling, and libraries for linking.
#

INC=-I /usr/include -I /usr/local/include -I /usr/include/hiredis

LIB=-lhiredis

#
# Debug or not debug?
#

DEBUG=1

ifdef DEBUG
    CFLAGS=-Wall -Winline -pipe -g -DDEBUG #-pedantic -pg 
else
    CFLAGS=-Wall -Winline -pipe -O3 -march=native -funroll-all-loops \
           -finline-functions #-pedantic 
endif

#CXXFLAGS=$(CFLAGS)


# Rules for creating dependency files

deps/%.d: src/%.cc
    @echo Generating $@
    @mkdir -p $(dir $@)
    $(CXX) $(CXXFLAGS) $(INC) -MM -MT '$(patsubst src/%,obj/%,%(patsubst %.cc,%.o,$<))' $< > $@

deps/%.d: src/%.c
    @echo Generating $@
    @mkdir -p $(dir $@)
    $(CXX) $(CXXFLAGS) $(INC) -MM -MT '$(patsubst src/%,obj/%,%(patsubst %.c,%.o,$<))' $< > $@


# Rules for compilation
#
# C source with header and no c++ code

obj/%.o: src/%.c src/%.h deps/%.d
    @echo Compiling $@
    @mkdir -p $(dir $@)
    $(CC) $(CFLAGS) $(INC) -o $@ -c $<

# C++ source with header.

obj/%.o: src/%.cc src/%.h deps/%.d 
    @echo Compiling $@
    @mkdir -p $(dir $@)
    $(CXX) $(CXXFLAGS) $(INC) -o $@ -c $<

# C source without header and no c++ code

obj/%.o: src/%.c deps/%.d
    @echo Compiling $@
    @mkdir -p $(dir $@)
    $(CC) $(CFLAGS) $(INC) -o $@ -c $<

# C++ source without header.

obj/%.o: src/%.cc deps/%.d 
    @echo Compiling $@
    @mkdir -p $(dir $@)
    $(CXX) $(CXXFLAGS) $(INC) -o $@ -c $<

# ##############################################################
#
# TARGET: tengine
#
# ##############################################################

OBJS= obj/main.o obj/tengine.o 

tengine: $(OBJS)
    $(CXX) -pipe $(CXXFLAGS) -o bin/tengine $(OBJS) $(LIB)

# ##############################################################
#
# TARGET: test2
#
# ##############################################################

OBJS= obj/main.o obj/test2.o 

test2: $(OBJS)
    $(CXX) -pipe $(CXXFLAGS) -o bin/test2 $(OBJS) $(LIB)

# ##############################################################
#
# Cleanup
#
# ##############################################################

clean:
    rm -f *~ bin/* obj/* deps/* src/*~ gmon.out

help:

@echo ""
@echo "make     - builds tengine"
@echo "make test2   - builds test2"
@echo "make all     - builds tengine test2"
@echo "make clean   - deletes prior build"

Answer 1

如果您希望其他人使用您的Makefile，请始终包含一个help目标，该目标会打印出一条消息，详细说明从命令行调用的各种目标，以及可以合理调用的各种环境变量准备做各种事情......

Answer 2

以下是修改后的makefile的建议，在7岁版本的Linux（RHEL 5）上稍作测试：

# Generic makefile

TARGETS=tengine test2

all: ${TARGETS}

help:
        @echo ""
        @echo "make         - builds ${TARGETS}"
        @echo "make tengine - builds tengine"
        @echo "make test2   - builds test2"
        @echo "make clean   - deletes prior build"
        @echo "make help    - prints this help"

# Switches:

INC=-I/usr/include/hiredis
LIB=-lhiredis
SUBDIRS=obj deps bin
LNK=gcc -g -Wl,--warn-common
DEBUG=1

ifdef DEBUG
        CFLAGS=-Wall -Winline -pipe -g -DDEBUG #-pedantic -pg 
else
        CFLAGS=-Wall -Winline -pipe -O3 -march=native -funroll-all-loops \
                   -finline-functions #-pedantic 
endif

#CXXFLAGS=$(CFLAGS)

# Generic rules:

obj/%.o: src/%.c
        @echo Compiling $@
        @mkdir -p $(SUBDIRS)
        $(CC) $(CFLAGS) $(INC) -MMD -MF '$(patsubst src/%.c,deps/%.d,$<)' -o $@ -c $< 

obj/%.o: src/%.cc 
        @echo Compiling $@
        @mkdir -p $(SUBDIRS)
        $(CXX) $(CXXFLAGS) $(INC) -MMD -MF '$(patsubst src/%.c,deps/%.d,$<)' -o $@ -c $<

${TARGETS}: %:bin/%

# Specific target rules:

bin/tengine: obj/main.o obj/tengine.o
        $(LNK) $^ $(LIB) -o $@ 

bin/test2: obj/main.o obj/test2.o
        $(LNK) $^ $(LIB) -o $@ 

clean:
        rm -f *~ src/*~ gmon.out
        rm -fr $(SUBDIRS)

-include deps/*.d

一些注意事项：

原始版本的一个关键问题是生成了依赖项，但未使用。这已使用-include deps/*.d（最后）修复。
现在使用了deps / * .d，makefile不需要src/%.h个案例。
原作也将垃圾放入这些文件中：在$(patsubst src/%,obj/%,%(patsubst %.cc,%.o,$<))中，第三个%应该是$。
在修订版中，使用-MMD与对象同时生成依赖项。这样更快，缩短了makefile，并添加了一些DRY。
缩短INC：为什么还要包括标准系统包括目录呢？事实上，gcc显然会忽略你的-I /usr/include -I /usr/local/include。
删除了两个 OBJS的不同定义。不需要，也可能令人困惑。使用$^代替。
make clean完全撤消所做的一切总是一个好主意，所以你留下了你的开始。但子目录obj /和deps /正在创建，并且从未删除过。此外，bin /之前应该存在。
对于链接，添加了$(LNK)和LNK=gcc -g -Wl,--warn-common（但您可能不需要警告）。 AFAIK，其他所有常用$(CFLAGS)都会被忽略。
删除了评论，这些评论（主要）令人分心。
重复两次make;make现在提供make: Nothing to be done for ...。

另见gcc dependency generation for a different output directory。

Answer 3

有关Makefile的示例，请参阅this和that个答案。同时运行make -p以了解 GNU make 中的内置规则，因此请使用$(LINK.cc)进行操作你的bin/tengine目标。

对于复杂构建，请考虑升级到GNU make 4.0并使用其Guile能力。

您可能希望自动生成依赖项。阅读automatic prerequisites和autodependencies;另请阅读GCC preprocessor options，例如-M或-MD等等....

如何让Makefile变得更好？

3 个答案: