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 CFLAGS_KERNEL
  52 -------------
  53 Additional options for $(CC) when used to compile
  54 code that is compiled as built-in.
  55
  56 CFLAGS_MODULE
  57 -------------
  58 Additional module specific options to use for $(CC).
  59
  60 LDFLAGS_MODULE
  61 --------------
  62 Additional options used for $(LD) when linking modules.
  63
  64 HOSTCFLAGS
  65 ----------
  66 Additional flags to be passed to $(HOSTCC) when building host programs.
  67
  68 HOSTCXXFLAGS
  69 ------------
  70 Additional flags to be passed to $(HOSTCXX) when building host programs.
  71
  72 HOSTLDFLAGS
  73 -----------
  74 Additional flags to be passed when linking host programs.
  75
  76 HOSTLDLIBS
  77 ----------
  78 Additional libraries to link against when building host programs.
  79
  80 KBUILD_KCONFIG
  81 --------------
  82 Set the top-level Kconfig file to the value of this environment
  83 variable.  The default name is "Kconfig".
  84
  85 KBUILD_VERBOSE
  86 --------------
  87 Set the kbuild verbosity. Can be assigned same values as "V=...".
  88
  89 See make help for the full list.
  90
  91 Setting "V=..." takes precedence over KBUILD_VERBOSE.
  92
  93 KBUILD_EXTMOD
  94 -------------
  95 Set the directory to look for the kernel source when building external
  96 modules.
  97
  98 Setting "M=..." takes precedence over KBUILD_EXTMOD.
  99
 100 KBUILD_OUTPUT
 101 -------------
 102 Specify the output directory when building the kernel.
 103
 104 The output directory can also be specified using "O=...".
 105
 106 Setting "O=..." takes precedence over KBUILD_OUTPUT.
 107
 108 KBUILD_EXTRA_WARN
 109 -----------------
 110 Specify the extra build checks. The same value can be assigned by passing
 111 W=... from the command line.
 112
 113 See `make help` for the list of the supported values.
 114
 115 Setting "W=..." takes precedence over KBUILD_EXTRA_WARN.
 116
 117 KBUILD_DEBARCH
 118 --------------
 119 For the deb-pkg target, allows overriding the normal heuristics deployed by
 120 deb-pkg. Normally deb-pkg attempts to guess the right architecture based on
 121 the UTS_MACHINE variable, and on some architectures also the kernel config.
 122 The value of KBUILD_DEBARCH is assumed (not checked) to be a valid Debian
 123 architecture.
 124
 125 ARCH
 126 ----
 127 Set ARCH to the architecture to be built.
 128
 129 In most cases the name of the architecture is the same as the
 130 directory name found in the arch/ directory.
 131
 132 But some architectures such as x86 and sparc have aliases.
 133
 134 - x86: i386 for 32 bit, x86_64 for 64 bit
 135 - sh: sh for 32 bit, sh64 for 64 bit
 136 - sparc: sparc32 for 32 bit, sparc64 for 64 bit
 137
 138 CROSS_COMPILE
 139 -------------
 140 Specify an optional fixed part of the binutils filename.
 141 CROSS_COMPILE can be a part of the filename or the full path.
 142
 143 CROSS_COMPILE is also used for ccache in some setups.
 144
 145 CF
 146 --
 147 Additional options for sparse.
 148
 149 CF is often used on the command-line like this::
 150
 151     make CF=-Wbitwise C=2
 152
 153 INSTALL_PATH
 154 ------------
 155 INSTALL_PATH specifies where to place the updated kernel and system map
 156 images. Default is /boot, but you can set it to other values.
 157
 158 INSTALLKERNEL
 159 -------------
 160 Install script called when using "make install".
 161 The default name is "installkernel".
 162
 163 The script will be called with the following arguments:
 164
 165    - $1 - kernel version
 166    - $2 - kernel image file
 167    - $3 - kernel map file
 168    - $4 - default install path (use root directory if blank)
 169
 170 The implementation of "make install" is architecture specific
 171 and it may differ from the above.
 172
 173 INSTALLKERNEL is provided to enable the possibility to
 174 specify a custom installer when cross compiling a kernel.
 175
 176 MODLIB
 177 ------
 178 Specify where to install modules.
 179 The default value is::
 180
 181      $(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE)
 182
 183 The value can be overridden in which case the default value is ignored.
 184
 185 INSTALL_MOD_PATH
 186 ----------------
 187 INSTALL_MOD_PATH specifies a prefix to MODLIB for module directory
 188 relocations required by build roots.  This is not defined in the
 189 makefile but the argument can be passed to make if needed.
 190
 191 INSTALL_MOD_STRIP
 192 -----------------
 193 INSTALL_MOD_STRIP, if defined, will cause modules to be
 194 stripped after they are installed.  If INSTALL_MOD_STRIP is '1', then
 195 the default option --strip-debug will be used.  Otherwise,
 196 INSTALL_MOD_STRIP value will be used as the options to the strip command.
 197
 198 INSTALL_HDR_PATH
 199 ----------------
 200 INSTALL_HDR_PATH specifies where to install user space headers when
 201 executing "make headers_*".
 202
 203 The default value is::
 204
 205     $(objtree)/usr
 206
 207 $(objtree) is the directory where output files are saved.
 208 The output directory is often set using "O=..." on the commandline.
 209
 210 The value can be overridden in which case the default value is ignored.
 211
 212 KBUILD_ABS_SRCTREE
 213 --------------------------------------------------
 214 Kbuild uses a relative path to point to the tree when possible. For instance,
 215 when building in the source tree, the source tree path is '.'
 216
 217 Setting this flag requests Kbuild to use absolute path to the source tree.
 218 There are some useful cases to do so, like when generating tag files with
 219 absolute path entries etc.
 220
 221 KBUILD_SIGN_PIN
 222 ---------------
 223 This variable allows a passphrase or PIN to be passed to the sign-file
 224 utility when signing kernel modules, if the private key requires such.
 225
 226 KBUILD_MODPOST_WARN
 227 -------------------
 228 KBUILD_MODPOST_WARN can be set to avoid errors in case of undefined
 229 symbols in the final module linking stage. It changes such errors
 230 into warnings.
 231
 232 KBUILD_MODPOST_NOFINAL
 233 ----------------------
 234 KBUILD_MODPOST_NOFINAL can be set to skip the final link of modules.
 235 This is solely useful to speed up test compiles.
 236
 237 KBUILD_EXTRA_SYMBOLS
 238 --------------------
 239 For modules that use symbols from other modules.
 240 See more details in modules.rst.
 241
 242 ALLSOURCE_ARCHS
 243 ---------------
 244 For tags/TAGS/cscope targets, you can specify more than one arch
 245 to be included in the databases, separated by blank space. E.g.::
 246
 247     $ make ALLSOURCE_ARCHS="x86 mips arm" tags
 248
 249 To get all available archs you can also specify all. E.g.::
 250
 251     $ make ALLSOURCE_ARCHS=all tags
 252
 253 KBUILD_BUILD_TIMESTAMP
 254 ----------------------
 255 Setting this to a date string overrides the timestamp used in the
 256 UTS_VERSION definition (uname -v in the running kernel). The value has to
 257 be a string that can be passed to date -d. The default value
 258 is the output of the date command at one point during build.
 259
 260 KBUILD_BUILD_USER, KBUILD_BUILD_HOST
 261 ------------------------------------
 262 These two variables allow to override the user@host string displayed during
 263 boot and in /proc/version. The default value is the output of the commands
 264 whoami and host, respectively.
 265
 266 LLVM
 267 ----
 268 If this variable is set to 1, Kbuild will use Clang and LLVM utilities instead
 269 of GCC and GNU binutils to build the kernel.