[Linux]详细的Makefile使用教程（每一步都有例子）

古月_方源

10935人浏览 · 2024-07-12 15:13:51

古月_方源 · 2024-07-12 15:13:51 发布

一、Makefile的基本结构

二、Makefile的工作原理

三、Makefile的常用命令和选项

四、Makefile中的变量：$(变量名) $@，$<，$^

多个个不同的.cc文件形成多个不同的可执行文件例子（以两个为例）

七、Makefile的常用函数wildcard 和 patsubst

wildcard

patsubst

八、常用的Makefile的示例

一个test.cc文件形成对应的test可执行文件

多个.cc文件形成对应的可执行文件（以两个为例）

Makefile是软件开发中用于自动化编译的工具，它定义了一系列的规则来指定哪些文件需要先编译，哪些文件需要后编译，哪些文件需要重新编译等。Makefile的使用极大地提高了软件开发的效率。以下是Makefile使用的基本介绍：

一、Makefile的基本结构

Makefile文件包含了一系列的“规则”，每个规则的基本结构如下：

目标(target)…: 依赖(prerequisites)… 
<tab>命令(command)

目标(target)：通常是要生成的文件的名称，也可以是执行的动作名称，如“clean”。
依赖(prerequisites)：生成目标所需要的文件或中间过程生成的目标。
命令(command)：通过执行命令对依赖操作生成目标。命令前必须是一个Tab字符，不能是空格。

例子（有些东西如 $@ 、$^、.PHONY后面都会讲.）：

test:test.cc
	g++ -o $@ $^
.PHONY:clean
clean:
	rm -f test

备注：

在Linux中 .cpp 等价于 .cc 等价于 .cxx
g++是一个编译c++语法的编译器，gcc是一个编译c语音语法的编译器

使用前：

使用make后，形成可执行文件test:

使用make clean后删除可执行文件test:

二、Makefile的工作原理

检查依赖：在生成目标之前，make会检查规则中的依赖是否存在。如果不存在，则寻找是否有规则用来生成该依赖文件。
检查更新：如果依赖存在，make会检查依赖的时间戳是否比目标的时间戳新。如果依赖的时间戳更新，则执行命令更新目标。
执行命令：如果目标需要更新，则按照规则中的命令执行操作。

三、Makefile的常用命令和选项

make命令

功能： 默认执行Makefile文件中的第一个目标。

例子：

Makefile:
test1:test1.cc
	g++ -o test1 test1.cc
test2:test2.cc
	g++ -o test2 test2.cc
执行执行g++ -o test1 test1.cc而不会执行g++ -o test2 test2.cc，如果你想同时执行两后面会讲。

只会形成可执行文件test1,而不会形成可执行文件test2

make clean

功能：通常用于清除编译过程中产生的中间文件和最终生成的目标文件。

make -f file

功能：指定一个非标准名称的Makefile文件，不使用Makefile的默认标准名称：Makefile或makefile。

例子：

假设你有一个名为 alt_makefile 的 Makefile 文件，你可以通过以下命令来使用它：
make -f alt_makefile
使用 -f 选项时，make 不会查找当前目录下的 Makefile、makefile 或 GNUmakefile 文件，除非你显式地通过 -f指定它们。
你可以指定多个 -f 选项来包含多个 Makefile 文件。make 会按照指定的顺序读取这些文件，并合并它们的规则。如果多个文件中定义了相同的规则，后面的文件会覆盖前面的文件中的定义。
在一些复杂的项目中，可能会有多个 Makefile 文件，分别用于不同的构建目标或环境。使用 -f 选项可以灵活地选择使用哪个 Makefile 文件。

make -C dir

功能：在读取Makefile之前改变工作目录至dir目录。

例子：

假设你的项目结构如下，并且你想要在 src 目录下构建项目：
	project/ 

	├── Makefile 

	└── src/ 
        
    	├── Makefile 

	    └── ... (源文件)
你可以在项目的根目录（project）下运行以下命令来执行 src 目录中的 Makefile：
make -C src

make -n

功能：只打印要执行的命令但不执行。

例子：

只显示执行内容，但不执行，没有形成可执行文件test

make -s

功能：执行命令但不显示执行的命令。

例子：

没有显示执行内容，但执行命令了，形成了可执行文件test

四、Makefile中的变量：`$(变量名) $@`，`$<`，`$^`

Makefile中可以使用变量来简化规则的编写。变量可以在Makefile的任何地方定义和使用，引用变量时需要用$(变量名)的形式。

赋值：= 和 :=

使用 = 进行赋值时，Makefile 会进行延迟展开（lazy evaluation 或 recursive expansion）。这意味着变量的值不会立即确定，而是在每次变量被引用时根据变量的当前值重新计算。

使用 := 进行赋值时，Makefile 会进行直接展开（immediate evaluation 或 simple expansion）。这意味着变量的值在赋值时立即确定，并且之后不会改变（除非使用其他机制，如 override 指令）。override:在 Makefile 中使用 override 指令来声明一个变量，我们就可以告诉 make 命令：在执行时，即使命令行中指定了这个变量的新值，也不要去替换 Makefile 中原来定义的那个值。

`$(变量名)`

自定义变量：如G=g++，定义了一个变量G，其值为g++。

例子：

G=g++
test:test.cc
    $(G) -o test test.cc

等价于

test:test.cc
    g++ -o test test.cc

`$@`，`$<`，`$^`

自动变量：如$@表示规则中的目标，$<表示第一个依赖文件，$^表示所有的依赖文件。

例子1：

test:test.cc
    g++ -o $@ $^

等价于：

test:test.cc
    g++ -o test test.cc

例子2：

test:test1.o test2.o test3.o
    g++ -o $@ $^

等价于

test:test1.o test2.o test3.o
    g++ -o test test1.o test2.o test3.o

例子3：

test:test.cc
    g++ -o $@ $<

等价于

test:test.cc
    g++ -o test test.cc

五、%的使用

模式规则允许使用%通配符来匹配文件名，从而可以为一组文件定义相同的编译规则。例如：

CC=gcc
%.o: %.c  
	$(CC) -c $< -o $@

这条规则表示对于所有的.c文件，都使用$(CC) -c命令编译成对应的.o文件。

六、.PHONY的使用

在 Makefile 中，.PHONY 是一个特殊的指令，用于声明一些“伪目标”（phony targets）。伪目标并不是实际要生成的文件名，而是用来执行一些命令或作为依赖关系的标签。通过使用 .PHONY，你可以告诉 make 这些目标不应该被当作文件名来处理，即使它们与当前目录中的文件名相同。

执行伪目标：

在命令行中，通过 make 命令后跟伪目标名称来执行它。如果 make 不带任何参数运行，它通常会尝试构建 Makefile 中的第一个目标（但这取决于 make 的实现和 Makefile 的结构，因此使用 .PHONY 和明确的默认目标如 all 是更好的做法）。

tips：

all 是 Makefile 中一个常见的默认目标名称。它通常被用作一个集合目标，依赖于其他需要构建或执行的目标。当你在 Makefile 中定义了 all 目标，并为其指定了依赖项时，运行 make（不带任何参数）通常会尝试构建 all 目标及其所有依赖项。

使用例子：

# Makefile代码：

.PHONY:all
all:

       xxxxx


.PHONY:output
output:

       xxxxx

.PHONY:clean
clean:

       xxxxx

命令行执行伪目标：

make all;make output;make clean;

具体例子

例子1：:清理文件

Makefile代码：

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

.PHONY: clean：这一行声明了clean是一个伪目标。这意味着，无论何时你运行make clean，make都会执行clean目标下的命令，而不会去检查名为clean的文件是否存在或是否是最新的。这对于那些不生成文件的命令（如清理命令）特别有用。
clean:：这是clean伪目标的开始。它后面跟着的是要在该目标上执行的命令。
rm -f $(shell find -name "*.o")：这是clean目标下要执行的命令。这个命令使用了shell函数和find命令的组合来查找并删除当前目录及其子目录下所有扩展名为.o的文件（通常是编译过程中生成的对象文件）。
- $(shell find -name "*.o")：shell函数会在执行Makefile中的命令之前，在shell中执行括号内的命令（在这个例子中是find -name "*.o"）。这个命令会搜索当前目录及其所有子目录，寻找所有文件名以.o结尾的文件，并返回这些文件的完整路径。然后，这些路径会被rm -f命令接收，用于删除这些文件。
- rm -f：这个命令用于删除文件，-f选项表示“强制”（force），即使文件不存在也不会报错。

例子2：多个个不同的.cc文件形成多个不同的可执行文件例子（以两个为例）

Makefile代码：

all:test1 test2
test1:test1.cc
	g++ -o test1 test1.cc
test2:test2.cc
	g++ -o test2 test2.cc

clean:
	rm -f test1 test2

.PHONY: all clean

小技巧1：

在Linux命令行中，想要清除可执行文件再重新生成，可以用':'(分号)分割两个命令。

例如：

先执行make clean再执行make

make clean;make

小技巧2：

不想命令行显示执行内容可以在第一行加上@

@字符在命令行的开始处有一个特殊的作用：它告诉 make 在执行该命令时不要将其打印到标准输出（即，不要回显该命令）。

例如：

.PHONY:all
all:
	@cd xxx文件;\
	make;\
	cd -;\
	cd yyy文件;\
	make;\
	cd -;

效果：不会在命令行打印你的这些操作内容

七、Makefile的常用函数`wildcard 和 patsubst`

Makefile中提供了许多内置函数，如wildcard、patsubst等，用于对文件名进行匹配、替换等操作。

`wildcard`

$(wildcard pattern)：查找当前目录下所有符合模式pattern的文件。

例如：
SRC=$(wildcard *.cc)  
查找当前目录下所有.cc后缀的文件赋值给SRC,例如当前目录有main.cc test.cc,那么SRC=main.cc test.cc

注意：wildcard只能查找当前目录的文件，如果想要找的文件在当前目录的一个目录中，那么它是找不到的，此时应该使用：SOURCES := $(shell find src -name "*.cc")

`patsubst`

$(patsubst pattern,replacement,text)：将text中符合pattern的部分替换为replacement。

例如：
# 定义一个变量，包含了一些文件名  
FILES = foo.c bar.c baz.h  
  
# 使用patsubst将.c文件扩展名替换为.o  
OBJECTS = $(patsubst %.c,%.o,$(FILES))  

八、常用的Makefile的示例

一个test.cc文件形成对应的test可执行文件


test:test.cc
	g++ -o $@ $^

.PHONY:clean
clean:
    rm -f test

效果：

输入make形成可执行文件test

输入make clean删除可执行文件test

多个.cc文件形成对应的可执行文件（以两个为例）

all:test1 test2
test1:test1.cc
	g++ -o test1 test1.cc
test2:test2.cc
	g++ -o test2 test2.cc

clean:
	rm -f test1 test2

.PHONY: all clean

备注：.PHONY: all clean写在哪都行

完结！！！

GitCode 开源社区

旨在为数千万中国开发者提供一个无缝且高效的云端环境，以支持学习、使用和贡献开源项目。

更多推荐

大学生摸鱼暂停！G-Star 校园开发者计划，喊你上车啦?

GitCode 开源社区

G-Star 校园开发者计划·黑科大｜开源第一课之 Git 入门

GitCode 开源社区

G-Star 校园开发者计划・浙大站圆满落幕：AI 算力与开源生态的创新碰撞

GitCode 开源社区

所有评论(0)

查看更多评论

古月_方源

@2202_75305885

已为社区贡献1条内容