1.. SPDX-License-Identifier: GPL-2.0 2 3.. include:: ../disclaimer-zh_CN.rst 4 5:Original: Documentation/kbuild/kbuild.rst 6:Translator: 慕冬亮 Dongliang Mu <dzm91@hust.edu.cn> 7 8====== 9Kbuild 10====== 11 12 13输出文件 14======== 15 16modules.order 17------------- 18该文件记录模块在 Makefile 中出现的顺序。modprobe 使用该文件来确定性 19解析匹配多个模块的别名。 20 21modules.builtin 22--------------- 23该文件列出了所有内置到内核中的模块。modprobe 使用该文件来避免尝试加载 24内置模块时出错。 25 26modules.builtin.modinfo 27----------------------- 28该文件包含所有内置模块的 modinfo。与单独模块的 modinfo 不同，所有字段 29都带有模块名称前缀。 30 31modules.builtin.ranges 32---------------------- 33该文件包含所有内核内置模块的地址偏移范围（每个 ELF 节）。结合 System.map 34文件，它可以用来将模块名称与符号关联起来。 35 36环境变量 37======== 38 39KCPPFLAGS 40--------- 41在预处理时传递的额外选项。kbuild 进行所有预处理（包括构建 C 文件和汇编文件） 42时，都会使用这些预处理选项。 43 44KAFLAGS 45------- 46传递给汇编器的额外选项（适用于内置模块和外部模块）。 47 48AFLAGS_MODULE 49------------- 50外部模块的额外汇编选项。 51 52AFLAGS_KERNEL 53------------- 54内置模块的额外汇编选项。 55 56KCFLAGS 57------- 58传递给 C 编译器的额外选项（适用于内置模块和外部模块）。 59 60KRUSTFLAGS 61---------- 62传递给 Rust 编译器的额外选项（适用于内置模块和外部模块）。 63 64CFLAGS_KERNEL 65------------- 66在编译内置代码时，传递给 $(CC) 的额外选项。 67 68CFLAGS_MODULE 69------------- 70编译外部模块时，传递给 $(CC) 的额外模块特定选项。 71 72RUSTFLAGS_KERNEL 73---------------- 74在编译内置代码时，传递给 $(RUSTC) 的额外选项。 75 76RUSTFLAGS_MODULE 77---------------- 78用于 $(RUSTC) 的额外模块特定选项。 79 80LDFLAGS_MODULE 81-------------- 82用于 $(LD) 链接模块时的额外选项。 83 84HOSTCFLAGS 85---------- 86在构建主机程序时传递给 $(HOSTCC) 的额外标志。 87 88HOSTCXXFLAGS 89------------ 90在构建主机程序时传递给 $(HOSTCXX) 的额外标志。 91 92HOSTRUSTFLAGS 93------------- 94在构建主机程序时传递给 $(HOSTRUSTC) 的额外标志。 95 96HOSTLDFLAGS 97----------- 98链接主机程序时传递的额外选项。 99 100HOSTLDLIBS 101---------- 102在构建主机程序时链接的额外库。 103 104.. _zh_cn_userkbuildflags: 105 106USERCFLAGS 107---------- 108用于 $(CC) 编译用户程序（userprogs）时的额外选项。 109 110USERLDFLAGS 111----------- 112用于 $(LD) 链接用户程序时的额外选项。用户程序（userprogs）是使用 CC 链接的， 113因此 $(USERLDFLAGS) 应该根据需要包含 "-Wl," 前缀。 114 115KBUILD_KCONFIG 116-------------- 117将顶级 Kconfig 文件设置为此环境变量的值。默认名称为 "Kconfig"。 118 119KBUILD_VERBOSE 120-------------- 121设置 kbuild 的详细程度。可以分配与 "V=..." 相同的值。 122 123有关完整列表，请参见 `make help`。 124 125设置 "V=..." 优先于 KBUILD_VERBOSE。 126 127KBUILD_EXTMOD 128------------- 129在构建外部模块时设置内核源代码的搜索目录。 130 131设置 "M=..." 优先于 KBUILD_EXTMOD。 132 133KBUILD_OUTPUT 134------------- 135指定内核构建的输出目录。 136 137在单独的构建目录中为预构建内核构建外部模块时，这个变量也可以指向内核输出目录。请注意， 138这并不指定外部模块本身的输出目录。 139 140输出目录也可以使用 "O=..." 指定。 141 142设置 "O=..." 优先于 KBUILD_OUTPUT。 143 144KBUILD_EXTRA_WARN 145----------------- 146指定额外的构建检查。也可以通过在命令行传递 "W=..." 来设置相同的值。 147 148请参阅 `make help` 了解支持的值列表。 149 150设置 "W=..." 优先于 KBUILD_EXTRA_WARN。 151 152KBUILD_DEBARCH 153-------------- 154对于 deb-pkg 目标，允许覆盖 deb-pkg 部署的正常启发式方法。通常 deb-pkg 尝试根据 155UTS_MACHINE 变量（在某些架构中还包括内核配置）来猜测正确的架构。KBUILD_DEBARCH 156的值假定（不检查）为有效的 Debian 架构。 157 158KDOCFLAGS 159--------- 160指定在构建过程中用于 kernel-doc 检查的额外（警告/错误）标志，查看 161scripts/kernel-doc 了解支持的标志。请注意，这目前不适用于文档构建。 162 163ARCH 164---- 165设置 ARCH 为要构建的架构。 166 167在大多数情况下，架构的名称与 arch/ 目录中的子目录名称相同。 168 169但某些架构（如 x86 和 sparc）有别名。 170 171- x86: i386 表示 32 位，x86_64 表示 64 位 172- parisc: parisc64 表示 64 位 173- sparc: sparc32 表示 32 位，sparc64 表示 64 位 174 175CROSS_COMPILE 176------------- 177指定 binutils 文件名的可选固定部分。CROSS_COMPILE 可以是文件名的一部分或完整路径。 178 179在某些设置中，CROSS_COMPILE 也用于 ccache。 180 181CF 182-- 183用于 sparse 的额外选项。 184 185CF 通常在命令行中如下所示使用:: 186 187 make CF=-Wbitwise C=2 188 189INSTALL_PATH 190------------ 191INSTALL_PATH 指定放置更新后的内核和系统映像的路径。默认值是 /boot，但你可以设置 192为其他值。 193 194INSTALLKERNEL 195------------- 196使用 "make install" 时调用的安装脚本。 197默认名称是 "installkernel"。 198 199该脚本将会以以下参数调用： 200 201 - $1 - 内核版本 202 - $2 - 内核映像文件 203 - $3 - 内核映射文件 204 - $4 - 默认安装路径（如果为空，则使用根目录） 205 206"make install" 的实现是架构特定的，可能与上述有所不同。 207 208提供 INSTALLKERNEL 以便在交叉编译内核时可以指定自定义安装程序。 209 210MODLIB 211------ 212指定模块的安装位置。 213默认值为:: 214 215 $(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE) 216 217该值可以被覆盖，在这种情况下将忽略默认值。 218 219INSTALL_MOD_PATH 220---------------- 221INSTALL_MOD_PATH 指定了模块目录重定位时 MODLIB 的前缀，通常由构建根 222（build roots）所需。它没有在 makefile 中定义，但如果需要，可以作为 223参数传递给 make。 224 225INSTALL_MOD_STRIP 226----------------- 227如果 INSTALL_MOD_STRIP 被定义，内核模块在安装后会被剥离。如果 228INSTALL_MOD_STRIP 的值为 '1'，则会使用默认选项 --strip-debug。否则， 229INSTALL_MOD_STRIP 的值将作为 strip 命令的选项。 230 231INSTALL_HDR_PATH 232---------------- 233INSTALL_HDR_PATH 指定了执行 "make headers_*" 时，用户空间头文件的安装位置。 234 235默认值为:: 236 237 $(objtree)/usr 238 239$(objtree) 是保存输出文件的目录。 240输出目录通常使用命令行中的 "O=..." 进行设置。 241 242该值可以被覆盖，在这种情况下将忽略默认值。 243 244INSTALL_DTBS_PATH 245----------------- 246INSTALL_DTBS_PATH 指定了设备树二进制文件的安装位置，通常由构建根（build roots）所需。 247它没有在 makefile 中定义，但如果需要，可以作为参数传递给 make。 248 249KBUILD_ABS_SRCTREE 250-------------------------------------------------- 251Kbuild 在可能的情况下使用相对路径指向源代码树。例如，在源代码树中构建时，源代码树路径是 252'.'。 253 254设置该标志请求 Kbuild 使用源代码树的绝对路径。 255在某些情况下这是有用的，例如在生成带有绝对路径条目的标签文件时等。 256 257KBUILD_SIGN_PIN 258--------------- 259当签署内核模块时，如果私钥需要密码或 PIN，此变量允许将密码或 PIN 传递给 sign-file 工具。 260 261KBUILD_MODPOST_WARN 262------------------- 263KBUILD_MODPOST_WARN 可以设置为在最终模块链接阶段出现未定义符号时避免错误。它将这些错误 264转为警告。 265 266KBUILD_MODPOST_NOFINAL 267---------------------- 268KBUILD_MODPOST_NOFINAL 可以设置为跳过模块的最终链接。这仅在加速编译测试时有用。 269 270KBUILD_EXTRA_SYMBOLS 271-------------------- 272用于依赖其他模块符号的模块。详见 modules.rst。 273 274ALLSOURCE_ARCHS 275--------------- 276对于 tags/TAGS/cscope 目标，可以指定包含在数据库中的多个架构，用空格分隔。例如:: 277 278 $ make ALLSOURCE_ARCHS="x86 mips arm" tags 279 280要获取所有可用架构，也可以指定 all。例如:: 281 282 $ make ALLSOURCE_ARCHS=all tags 283 284IGNORE_DIRS 285----------- 286对于 tags/TAGS/cscope 目标，可以选择不包含在数据库中的目录，用空格分隔。例如:: 287 288 $ make IGNORE_DIRS="drivers/gpu/drm/radeon tools" cscope 289 290KBUILD_BUILD_TIMESTAMP 291---------------------- 292将该环境变量设置为日期字符串，可以覆盖在 UTS_VERSION 定义中使用的时间戳 293（运行内核时的 uname -v）。该值必须是一个可以传递给 date -d 的字符串。默认值是 294内核构建某个时刻的 date 命令输出。 295 296KBUILD_BUILD_USER, KBUILD_BUILD_HOST 297------------------------------------ 298这两个变量允许覆盖启动时显示的 user@host 字符串以及 /proc/version 中的信息。 299默认值分别是 whoami 和 host 命令的输出。 300 301LLVM 302---- 303如果该变量设置为 1，Kbuild 将使用 Clang 和 LLVM 工具，而不是 GCC 和 GNU 304binutils 来构建内核。 305