Documentation/kbuild/kbuild.rst

   1 ======
   2 Kbuild
   3 ======
   4
   5
   6 Output files
   7 ============
   8
   9 modules.order
  10 -------------
  11 This file records the order in which modules appear in Makefiles. This
  12 is used by modprobe to deterministically resolve aliases that match
  13 multiple modules.
  14
  15 modules.builtin
  16 ---------------
  17 This file lists all modules that are built into the kernel. This is used
  18 by modprobe to not fail when trying to load something builtin.
  19
  20 modules.builtin.modinfo
  21 -----------------------
  22 This file contains modinfo from all modules that are built into the kernel.
  23 Unlike modinfo of a separate module, all fields are prefixed with module name.
  24
  25
  26 Environment variables
  27 =====================
  28
  29 KCPPFLAGS
  30 ---------
  31 Additional options to pass when preprocessing. The preprocessing options
  32 will be used in all cases where kbuild does preprocessing including
  33 building C files and assembler files.
  34
  35 KAFLAGS
  36 -------
  37 Additional options to the assembler (for built-in and modules).
  38
  39 AFLAGS_MODULE
  40 -------------
  41 Additional assembler options for modules.
  42
  43 AFLAGS_KERNEL
  44 -------------
  45 Additional assembler options for built-in.
  46
  47 KCFLAGS
  48 -------
  49 Additional options to the C compiler (for built-in and modules).
  50
  51 KRUSTFLAGS
  52 ----------
  53 Additional options to the Rust compiler (for built-in and modules).
  54
  55 CFLAGS_KERNEL
  56 -------------
  57 Additional options for $(CC) when used to compile
  58 code that is compiled as built-in.
  59
  60 CFLAGS_MODULE
  61 -------------
  62 Additional module specific options to use for $(CC).
  63
  64 RUSTFLAGS_KERNEL
  65 ----------------
  66 Additional options for $(RUSTC) when used to compile
  67 code that is compiled as built-in.
  68
  69 RUSTFLAGS_MODULE
  70 ----------------
  71 Additional module specific options to use for $(RUSTC).
  72
  73 LDFLAGS_MODULE
  74 --------------
  75 Additional options used for $(LD) when linking modules.
  76
  77 HOSTCFLAGS
  78 ----------
  79 Additional flags to be passed to $(HOSTCC) when building host programs.
  80
  81 HOSTCXXFLAGS
  82 ------------
  83 Additional flags to be passed to $(HOSTCXX) when building host programs.
  84
  85 HOSTRUSTFLAGS
  86 -------------
  87 Additional flags to be passed to $(HOSTRUSTC) when building host programs.
  88
  89 HOSTLDFLAGS
  90 -----------
  91 Additional flags to be passed when linking host programs.
  92
  93 HOSTLDLIBS
  94 ----------
  95 Additional libraries to link against when building host programs.
  96
  97 .. _userkbuildflags:
  98
  99 USERCFLAGS
 100 ----------
 101 Additional options used for $(CC) when compiling userprogs.
 102
 103 USERLDFLAGS
 104 -----------
 105 Additional options used for $(LD) when linking userprogs. userprogs are linked
 106 with CC, so $(USERLDFLAGS) should include "-Wl," prefix as applicable.
 107
 108 KBUILD_KCONFIG
 109 --------------
 110 Set the top-level Kconfig file to the value of this environment
 111 variable.  The default name is "Kconfig".
 112
 113 KBUILD_VERBOSE
 114 --------------
 115 Set the kbuild verbosity. Can be assigned same values as "V=...".
 116
 117 See make help for the full list.
 118
 119 Setting "V=..." takes precedence over KBUILD_VERBOSE.
 120
 121 KBUILD_EXTMOD
 122 -------------
 123 Set the directory to look for the kernel source when building external
 124 modules.
 125
 126 Setting "M=..." takes precedence over KBUILD_EXTMOD.
 127
 128 KBUILD_OUTPUT
 129 -------------
 130 Specify the output directory when building the kernel.
 131
 132 The output directory can also be specified using "O=...".
 133
 134 Setting "O=..." takes precedence over KBUILD_OUTPUT.
 135
 136 KBUILD_EXTRA_WARN
 137 -----------------
 138 Specify the extra build checks. The same value can be assigned by passing
 139 W=... from the command line.
 140
 141 See `make help` for the list of the supported values.
 142
 143 Setting "W=..." takes precedence over KBUILD_EXTRA_WARN.
 144
 145 KBUILD_DEBARCH
 146 --------------
 147 For the deb-pkg target, allows overriding the normal heuristics deployed by
 148 deb-pkg. Normally deb-pkg attempts to guess the right architecture based on
 149 the UTS_MACHINE variable, and on some architectures also the kernel config.
 150 The value of KBUILD_DEBARCH is assumed (not checked) to be a valid Debian
 151 architecture.
 152
 153 KDOCFLAGS
 154 ---------
 155 Specify extra (warning/error) flags for kernel-doc checks during the build,
 156 see scripts/kernel-doc for which flags are supported. Note that this doesn't
 157 (currently) apply to documentation builds.
 158
 159 ARCH
 160 ----
 161 Set ARCH to the architecture to be built.
 162
 163 In most cases the name of the architecture is the same as the
 164 directory name found in the arch/ directory.
 165
 166 But some architectures such as x86 and sparc have aliases.
 167
 168 - x86: i386 for 32 bit, x86_64 for 64 bit
 169 - parisc: parisc64 for 64 bit
 170 - sparc: sparc32 for 32 bit, sparc64 for 64 bit
 171
 172 CROSS_COMPILE
 173 -------------
 174 Specify an optional fixed part of the binutils filename.
 175 CROSS_COMPILE can be a part of the filename or the full path.
 176
 177 CROSS_COMPILE is also used for ccache in some setups.
 178
 179 CF
 180 --
 181 Additional options for sparse.
 182
 183 CF is often used on the command-line like this::
 184
 185     make CF=-Wbitwise C=2
 186
 187 INSTALL_PATH
 188 ------------
 189 INSTALL_PATH specifies where to place the updated kernel and system map
 190 images. Default is /boot, but you can set it to other values.
 191
 192 INSTALLKERNEL
 193 -------------
 194 Install script called when using "make install".
 195 The default name is "installkernel".
 196
 197 The script will be called with the following arguments:
 198
 199    - $1 - kernel version
 200    - $2 - kernel image file
 201    - $3 - kernel map file
 202    - $4 - default install path (use root directory if blank)
 203
 204 The implementation of "make install" is architecture specific
 205 and it may differ from the above.
 206
 207 INSTALLKERNEL is provided to enable the possibility to
 208 specify a custom installer when cross compiling a kernel.
 209
 210 MODLIB
 211 ------
 212 Specify where to install modules.
 213 The default value is::
 214
 215      $(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE)
 216
 217 The value can be overridden in which case the default value is ignored.
 218
 219 INSTALL_MOD_PATH
 220 ----------------
 221 INSTALL_MOD_PATH specifies a prefix to MODLIB for module directory
 222 relocations required by build roots.  This is not defined in the
 223 makefile but the argument can be passed to make if needed.
 224
 225 INSTALL_MOD_STRIP
 226 -----------------
 227 INSTALL_MOD_STRIP, if defined, will cause modules to be
 228 stripped after they are installed.  If INSTALL_MOD_STRIP is '1', then
 229 the default option --strip-debug will be used.  Otherwise,
 230 INSTALL_MOD_STRIP value will be used as the options to the strip command.
 231
 232 INSTALL_HDR_PATH
 233 ----------------
 234 INSTALL_HDR_PATH specifies where to install user space headers when
 235 executing "make headers_*".
 236
 237 The default value is::
 238
 239     $(objtree)/usr
 240
 241 $(objtree) is the directory where output files are saved.
 242 The output directory is often set using "O=..." on the commandline.
 243
 244 The value can be overridden in which case the default value is ignored.
 245
 246 KBUILD_ABS_SRCTREE
 247 --------------------------------------------------
 248 Kbuild uses a relative path to point to the tree when possible. For instance,
 249 when building in the source tree, the source tree path is '.'
 250
 251 Setting this flag requests Kbuild to use absolute path to the source tree.
 252 There are some useful cases to do so, like when generating tag files with
 253 absolute path entries etc.
 254
 255 KBUILD_SIGN_PIN
 256 ---------------
 257 This variable allows a passphrase or PIN to be passed to the sign-file
 258 utility when signing kernel modules, if the private key requires such.
 259
 260 KBUILD_MODPOST_WARN
 261 -------------------
 262 KBUILD_MODPOST_WARN can be set to avoid errors in case of undefined
 263 symbols in the final module linking stage. It changes such errors
 264 into warnings.
 265
 266 KBUILD_MODPOST_NOFINAL
 267 ----------------------
 268 KBUILD_MODPOST_NOFINAL can be set to skip the final link of modules.
 269 This is solely useful to speed up test compiles.
 270
 271 KBUILD_EXTRA_SYMBOLS
 272 --------------------
 273 For modules that use symbols from other modules.
 274 See more details in modules.rst.
 275
 276 ALLSOURCE_ARCHS
 277 ---------------
 278 For tags/TAGS/cscope targets, you can specify more than one arch
 279 to be included in the databases, separated by blank space. E.g.::
 280
 281     $ make ALLSOURCE_ARCHS="x86 mips arm" tags
 282
 283 To get all available archs you can also specify all. E.g.::
 284
 285     $ make ALLSOURCE_ARCHS=all tags
 286
 287 IGNORE_DIRS
 288 -----------
 289 For tags/TAGS/cscope targets, you can choose which directories won't
 290 be included in the databases, separated by blank space. E.g.::
 291
 292     $ make IGNORE_DIRS="drivers/gpu/drm/radeon tools" cscope
 293
 294 KBUILD_BUILD_TIMESTAMP
 295 ----------------------
 296 Setting this to a date string overrides the timestamp used in the
 297 UTS_VERSION definition (uname -v in the running kernel). The value has to
 298 be a string that can be passed to date -d. The default value
 299 is the output of the date command at one point during build.
 300
 301 KBUILD_BUILD_USER, KBUILD_BUILD_HOST
 302 ------------------------------------
 303 These two variables allow to override the user@host string displayed during
 304 boot and in /proc/version. The default value is the output of the commands
 305 whoami and host, respectively.
 306
 307 LLVM
 308 ----
 309 If this variable is set to 1, Kbuild will use Clang and LLVM utilities instead
 310 of GCC and GNU binutils to build the kernel.