创建 linux make/build 文件

Question

我正在将一个 C++ 项目从 Windows 迁移到 Linux，现在需要创建一个构建/make 文件。我以前从未创建过构建/生成文件。我还需要包含 Boost 库以使其更加复杂。 它也必须是一个 makefile，无论如何我都需要学习如何创建 makefile，所以 CMake 和 SCON 已经淘汰了。由于使用了 Boost，IDE 也被淘汰了，我所有的 IDE（Eclipse、VS 等）都只能在 Windows 上运行。我必须从头开始生成一个 makefile。

那么创建 Linux c++ make 文件的基础知识是什么以及如何将 Boost 库合并到其中以使其正确链接？

到目前为止，我的 makefile 看起来像这样。我认为 CFLAGS 和 LDFLAGS 是编译器和优化选项，但不完全确定。

CC = g++
CFLAGS = -wall -o3 - c
LDFLAGS = -03 -mfp-rounding-mode=n

---

我提供赏金，因为我仍然很迷失。如果有人喜欢冒险，我需要在 linux

• simple_ls.h
• simple_ls.cpp
• 2dquicksort.h
• rawr.h
• rawr.cpp
• converter.cpp

中编译以下内容 simple_ls.h 中的标头：

#include "boost/filesystem/operations.hpp"
#include "boost/filesystem/path.hpp"
#include "boost/lexical_cast.hpp"

#include <iostream>
#include <vector>
#include <string>
#include <algorithm>

2dquicksort.h 中的标头： 2dquicksort.h

#include <stdio.h>
#include <ctype.h>
#include <iostream>

中的标头 ： rawr.h：

#include <iostream> // not required by most systems
#include <fstream>
#include <iomanip>
#include <cstdlib> // or (stdlib.h) for exit()

#include <cmath> 
#include <vector>
#include <limits>
#include <string>

一个可接受的答案是逐步解释 makefile 如何工作以及如何在没有 IDE 的 Linux 中使用 Boost 构建它们。

Answer 1

什么是Makefile？ （应用于 Boost 项目）

根递归 Makefile 背后的想法是：

要构建目标，我们需要先决条件（其他目标！）和构建说明

先决条件

它们是文件、文件夹或假目标（通常在.PHONY）。测试文件/文件夹的存在性和修改日期。

如果目标没有先决条件或者比任何先决条件都旧，则需要重建目标。

指令

指令是shell 命令，从一个选项卡开始。每条指令行都是一个 shell 实例。当当前命令以反斜杠 \ 结尾时，shell 命令可以在下一行继续。

目标定义

目标可以是依赖项，也可以是规则。

依赖性：

target : prerequisite1 prerequisite2 prerequisiteN

规则：

target : prerequisite1 prerequisite2 prerequisiteN
    instructions1
    @hidden_batch1 ; \
  hidden_batch2  

指令开始前有制表符。

调试

Makefile 的调试可能会变得非常令人头疼。
请尝试在 Makefile 中执行以下操作来显示跟踪（包含警告的文件和行位置）：

$(info Shell: $(SHELL))
$(warning CXX: $(CXX))

当您的 Makefile 包含大量嵌套的 if/else/endif 并且您不确定
现在的路径是什么？

Makefile 结构

理想的 makefile 结构是：

1. 变量设置
2. 目标/依赖项声明

一旦整个 Makefile 及其包含文件完成，真正的目标指令处理就会开始
已被理解（存储在 make 内部数据库中）。

示例

最后，使用 Boost 将理论应用到这个特定示例并创建假源文件
来说明。

rawr.cpp

#include "rawr.h"

simple_ls.cpp

#include "rawr.h"

converter.cpp

#include <iostream>

#include "rawr.h"
#include "simple_ls.h"
#include "2dquicksort.h"

#include <boost/array.hpp>   // Boost! 

int main(int argc, char **argv)
{
    boost::array<int,4> a = { { 1, 2, 3, 4} };
    std::cout << a[1] << std::endl;
    return 0;
}

Makefile

如果您从 *stack***overflow** 复制 Makefile 源，请不要忘记用真正的制表符替换空格：

sed -i~ -e 's/^    /\t/' Makefile

Makefile 源：

## Makefile for C++ project using Boost
#
# @author Cedric "levif" Le Dillau
#
# Some notes:
# - Using ':=' instead of '=' assign the value at Makefile parsing time,
#   others are evaluated at usage time. This discards
# - Use ':set list' in Vi/Vim to show tabs (Ctrl-v-i force tab insertion)
#

# List to '.PHONY' all fake targets, those that are neither files nor folders.
# "all" and "clean" are good candidates.
.PHONY: all, clean

# Define the final program name
PROGNAME := converter

# Pre-processor flags to be used for includes (-I) and defines (-D) 
CPPFLAGS := -DUSE_BOOST

# CFLAGS is used for C compilation options.
CFLAGS := -Wall -O0

# CXXFLAGS is used for C++ compilation options.
CXXFLAGS += -Wall -O0

# LDFLAGS is used for linker (-g enables debug symbols)
LDFLAGS  += -g

# Which Boost modules to use (all)
BOOST_MODULES = \
  date_time     \
  filesystem    \
  graph         \
  iostreams     \
  math_c99      \
  system        \
  serialization \
  regex

# Boost libraries' type (a suffix)
BOOST_MODULES_TYPE := -mt

# Define library names with their type
BOOST_MODULES_LIBS := $(addsuffix $(BOOT_MODULES_TYPE),$(BOOST_MODULES))

# Define the linker argument to use the Boost libraries.
BOOST_LDFLAGS := $(addprefix -lboost_,$(BOOST_MODULES_LIBS))

# Feed compiler/linker flags with Boost's
CPPFLAGS += $(BOOST_CPPFLAGS)
LDFLAGS += $(BOOST_LDFLAGS)

# List the project' sources to compile or let the Makefile recognize
# them for you using 'wildcard' function.
#
#SOURCES = simple_ls.cpp rawr.cpp converter.cpp
SOURCES = $(wildcard *.cpp)

# List the project' headers or let the Makefile recognize
# them for you using 'wildcard' function.
#
#HEADERS = simple_ls.h 2dquicksort.h rawr.h
HEADERS = $(wildcard %.h)

# Construct the list of object files based on source files using
# simple extension substitution.
OBJECTS = $(SOURCES:%.cpp=%.o)

#
# Now declare the dependencies rules and targets
#
# Starting with 'all' make it  becomes the default target when none 
# is specified on 'make' command line.
all : $(PROGNAME)

# Declare that the final program depends on all objects and the Makfile
$(PROGNAME) : $(OBJECTS) Makefile
    $(CXX) -o $@ $(LDFLAGS) $(OBJECTS)

# Now the choice of using implicit rules or not (my choice)...
#
# Choice 1: use implicit rules and then we only need to add some dependencies
#           to each object.
#
## Tells make that each object file depends on all headers and this Makefile.
#$(OBJECTS) : $(HEADERS) Makefile
#
# Choice 2: don't use implicit rules and specify our will
%.o: %.cpp $(HEADERS) Makefile
    $(CXX) $(CXXFLAGS) $(CPPFLAGS) -c $(OUTPUT_OPTION) 
lt;

# Simple clean-up target
# notes:
# - the '@' before 'echo' informs make to hide command invocation.
# - the '-' before 'rm' command to informs make to ignore errors.
clean :
    @echo "Clean."
    -rm -f *.o $(PROGNAME)

文件列表

2dquicksort.h
converter.cpp
Makefile
rawr.cpp
rawr.h
simple_ls.cpp
simple_ls.h

编译

make clean all
Clean.
rm -f *.o converter
g++ -Wall -O0 -DUSE_BOOST  -c -o converter.o converter.cpp
g++ -Wall -O0 -DUSE_BOOST  -c -o rawr.o rawr.cpp
g++ -Wall -O0 -DUSE_BOOST  -c -o simple_ls.o simple_ls.cpp
g++ -o converter -g -lboost_date_time -lboost_filesystem -lboost_graph -lboost_iostreams -lboost_math_c99 -lboost_system -lboost_serialization -lboost_regex converter.o rawr.o simple_ls.o

结果

和现在，几乎最小的 Boost 程序的结果：

./converter
2

没有理由不使用它！ Boost 确实是一个特色 C++ 工具箱:)

Answer 2

一个非常简单的 GNU makefile 如下：

CPPFLAGS += -Isome_include_path
CXXFLAGS += -O3
LDFLAGS  += -Lsome_link_path -lsome_lib -lboost_filesystem

all: binary_name
binary_name: foo.o bar.o john.o

• CPPFLAGS 是应用于 C 预处理器的标志。诸如包含路径之类的东西。
• CXXFLAGS 是应用于 C++ 编译器的标志。诸如优化级别之类的事情。
• LDFLAGS 是应用于链接器的标志。诸如外部库（boost_filesystem）和其他库之类的东西。另外，还有这些库的路径。
• 惯例表明应该有一个 make all 规则，这是默认规则。在 make 中，第一条规则是默认的。
• binary_name 是二进制文件的名称。
• binary_name 取决于 3 个文件：foo.o、bar.o、john.o。
• 我们不包含 *.o 的规则，因为 gnu make 对这些规则有隐式规则。

要使用 make，您需要创建一个名为 Makefile 的文件，其中包含上面列出的内容。要构建，您需要在该目录中运行 make 。

顺便说一句（正如其他人提到的），我建议如果可能的话，不要使用 make。那里有更好的系统。 make 的主要好处是它无处不在。然而，如果管理层需要它，那么管理层就需要它。

（请注意，GNU Make += 表示法并不总是可移植到其他版本的 Make。但是，Linux 上的 make 是 GNU Make。）

---

根据您的编辑，这里有一个示例与您记下的文件。需要注意的是，以 $(CXX) 开头的行应该以 TAB 字符开头！

LDFLAGS  := -lboost_filesystem
CXXFLAGS := -O3 -Wall
CPPFLAGS :=

all: program
program: simple_ls.o converter.o rawr.o
    $(CXX) -o 
lt; $^ $(LDFLAGS)

simple_ls.o: simple_ls.cpp rawr.h simple_ls.h 2dquicksort.h
converter.o: converter.cpp rawr.h simple_ls.h 2dquicksort.h
rawr.o: rawr.cpp rawr.h simple_ls.h 2dquicksort.h

Answer 3

我不建议编写您自己的 Makefile。相反，请使用 CMake 或 SCons.

值得注意的是，这些工具是跨平台的。因此您可以在 Linux 和 Windows 上使用相同的构建系统。

Answer 4

当然，您应该阅读 The Fine Manual（特别是 gcc 和 make）。不过，以下是 gcc 的基础知识：

编译源文件：

g++ -c file.cpp

这将创建 file.o。然后您可能想要链接它们：

g++ -o app_name file.o main.o other_file.o

这将创建一个名为app_name的可执行文件。但由于您使用的是 boost 并且头文件可能遍布各处，因此您可能需要其他选项。在编译期间使用 -I 将目录添加到包含路径：

g++ -I/usr/local/more_includes/ -c file.cpp

您可能还需要链接到一些库。链接期间：

g++ -L/usr/local/more_libraries/ file.o main.o other_file.o -lsome_library

现在进入 makefile。 makefile 的基础知识是：

target: dependencies
    command

例如：

my_app: file.o
    g++ -o my_app file.o

file.o: file.cpp file.h
    g++ -o file.cpp

clean:
    rm file.o my_app

如果您键入“make”，它将默认尝试创建第一个目标。 my_app 依赖于目标 file.o，因此它将检查自上次修改 my_app 以来 file.o 是否已被修改。如果是这样，它将重新链接。在检查 file.o 时，它注意到 file.o 依赖于 file.cpp 和 file.h。如果自上次创建 file.o 以来这些文件中的任何一个已被修改，它将重新编译该文件。

目标也不必总是实际文件。最后一个称为 clean，它不依赖任何东西，只是删除 file.o 和 my_app。如果您输入“make clean”，它将运行该命令。

当然还有很多其他选择，但这应该可以帮助您入门。

Answer 5

至少尝试阅读您要使用的产品的官方文档： 这里。它确实解释了几乎所有的基础知识。

特别是，阅读第 2 章和第 3 章，这些将使您 99% 达到有效使用 gmake 所需的程度。此外，请仔细阅读 隐式规则目录。这将告诉您大多数“特殊变量”是什么。

我给您的一个提示是在您的项目目录中尝试 gcc -M *.cpp 。这将以 Makefile 格式输出每个 .cpp 文件的先决条件标头列表。事实上，对于初学者 makefile，您可以这样做：

gcc -M *.cpp > Makefile

编辑此文件，或多或少地在前面添加 shath 的答案，然后您就拥有了一个可用的 Makefile。我可能会建议您删除 gcc -M 将添加到每个构建规则中的大量系统标头，但您实际上不必这样做。

FWIW，如果您开始处理一个大型项目（多个源目录是一个很好的线索），那么是时候开发一种现代构建管理工具（这里是 cmake 粉丝）。但对于小型项目来说，raw make 非常容易使用。

Answer 6

这并不完全是您所要求的，但我强烈建议您使用名为 premake 的构建系统。 premake 和 scons 以及 cmake 之间的好处和区别是它为您生成 makefile。这意味着您可以使用 premake 作为开始，然后查看它生成的文件以了解更多信息。

除了这个预制件之外，它还是一个易于学习且直观的工具，它还有一个额外的好处，即能够从相同的配置生成 Visual Studio 项目文件。

我的建议是，如果您绝对需要 makefile，则使用 premake，它将帮助您学习，并最终成为直接编写自己的 makefile 的灵活替代品（这是一个主要的痛苦是 %*$）。

Answer 7

有一个非常好的教程@ ALP 。

Answer 8

首先，我不是 Makefile 方面的专家。我知道基础知识，但是这个答案中的 Makefile 几乎肯定有改进的空间。有很多技巧和快捷方式可以让您比硬编码所有内容更好地处理依赖项和添加文件。不过，我认为这个例子足以满足您的目的，并且可能更具教育意义。

其次，我想确保您了解构建项目的基本阶段。您可能已经知道这一点，但如果您不知道，下面的内容一开始会有点混乱。本质上有两个步骤：编译和链接。编译会将您的代码转换为目标代码 - 如果成功，它将把 .cpp 文件转换为 .o 文件。下一步是链接。在这里，它将所有目标代码粘在一起以创建可执行文件，并将函数调用从一个文件链接到另一个文件（因此，如果 file1.cpp 调用 file2.cpp 中定义的函数，则在这一步file1.cpp 找出该函数的实际位置）。还有更多内容，但这应该足以阐明以下内容。

此时，您可以使用 g++ 来编译和链接您的项目（您甚至可以“一步”完成）。然而，这是相当麻烦的，尤其是对于任何重要的项目。它还使得跟踪自上次编译以来已更改的文件变得困难。

这就是 Makefile 的用武之地。 Makefile 是以下形式的规则列表：（

target: dependencies
    command

确保使用制表符而不是空格，如果使用空格，make 可能无法工作）。如果运行命令：

make some_target

那么 make 将查找带有 some_target 的规则。如果目标是一个文件，它将检查该文件的“上次修改”时间戳，并将检查您列出的所有依赖项的时间戳。如果任何依赖项具有较晚的时间戳，它将运行该命令。

我将不得不对您的项目做出一些假设（即哪些文件依赖于哪些文件），因此您可能需要修改以下内容，但这是您项目的基本 Makefile（请记住，制表符而不是空格。如果您复制并粘贴此内容，它将不起作用）：

CC = g++
INCLUDE_DIRS = -I/path/to/boost

all: binary_file

clean:
    rm *.o
    rm binary_file

binary_file: simple_ls.o rawr.o converter.o
    $(CC) -o binary_file simple_ls.o rawr.o converter.o

rawr.o: rawr.h rawr.cpp 2dquicksort.h
    $(CC) -c rawr.cpp $(INCLUDE_DIRS)

simple_ls.o: simple_ls.h simple_ls.cpp 2dquicksort.h
    $(CC) -c simple_ls.cpp $(INC*emphasized text*LUDE_DIRS)

运行 make 或 make all 或 make binary_file 将导致编译所有文件如有必要，然后链接以创建名为 binary_file 的可执行文件。您可以进行一些改进，例如：

%.o: %.cpp %.h 2dquicksort.h
    $(CC) -c 
lt;

它将找到所有 .cpp 文件并将它们编译为 .o 文件。 .o 文件将依赖于同名的 .cpp 文件和 .h 文件（以及 2dquicksort.h）。

Answer 9

使用 @Job 的想法，我建议您将其留给某些 IDE 来完成。例如，在 Eclipse CDT 中构建一个项目并使用它自动生成的 make 文件。然后，您可以学习它，并及时更改它以完全满足您的需求。

Answer 10

我更喜欢标准的项目描述，例如这个。换句话说，我认为对 makefile 的关注范围太窄了。

该项目描述的优点是简单。它可以使用 all 目标中的 make -C subdir -f Makefile all 来适应带有子目录的更复杂的项目。 subdir 当然是您的子目录，其中包含应构建的代码。

作者指出，创建和维护构建环境效率不高，因此您需要易于修改且易于理解的东西。我不一定想成为一名 makefile 专家。我认为这并不像许多人想象的那么有用。

我非常喜欢 hiltmon 的想法，所以我将它变成了 shell 脚本。我可能会用Python编写完成的项目，并询问作者是否可以为GitHub做出贡献。