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_DEBARCH
 109 --------------
 110 For the deb-pkg target, allows overriding the normal heuristics deployed by
 111 deb-pkg. Normally deb-pkg attempts to guess the right architecture based on
 112 the UTS_MACHINE variable, and on some architectures also the kernel config.
 113 The value of KBUILD_DEBARCH is assumed (not checked) to be a valid Debian
 114 architecture.
 115
 116 ARCH
 117 ----
 118 Set ARCH to the architecture to be built.
 119
 120 In most cases the name of the architecture is the same as the
 121 directory name found in the arch/ directory.
 122
 123 But some architectures such as x86 and sparc have aliases.
 124
 125 - x86: i386 for 32 bit, x86_64 for 64 bit
 126 - sh: sh for 32 bit, sh64 for 64 bit
 127 - sparc: sparc32 for 32 bit, sparc64 for 64 bit
 128
 129 CROSS_COMPILE
 130 -------------
 131 Specify an optional fixed part of the binutils filename.
 132 CROSS_COMPILE can be a part of the filename or the full path.
 133
 134 CROSS_COMPILE is also used for ccache in some setups.
 135
 136 CF
 137 --
 138 Additional options for sparse.
 139
 140 CF is often used on the command-line like this::
 141
 142     make CF=-Wbitwise C=2
 143
 144 INSTALL_PATH
 145 ------------
 146 INSTALL_PATH specifies where to place the updated kernel and system map
 147 images. Default is /boot, but you can set it to other values.
 148
 149 INSTALLKERNEL
 150 -------------
 151 Install script called when using "make install".
 152 The default name is "installkernel".
 153
 154 The script will be called with the following arguments:
 155
 156    - $1 - kernel version
 157    - $2 - kernel image file
 158    - $3 - kernel map file
 159    - $4 - default install path (use root directory if blank)
 160
 161 The implementation of "make install" is architecture specific
 162 and it may differ from the above.
 163
 164 INSTALLKERNEL is provided to enable the possibility to
 165 specify a custom installer when cross compiling a kernel.
 166
 167 MODLIB
 168 ------
 169 Specify where to install modules.
 170 The default value is::
 171
 172      $(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE)
 173
 174 The value can be overridden in which case the default value is ignored.
 175
 176 INSTALL_MOD_PATH
 177 ----------------
 178 INSTALL_MOD_PATH specifies a prefix to MODLIB for module directory
 179 relocations required by build roots.  This is not defined in the
 180 makefile but the argument can be passed to make if needed.
 181
 182 INSTALL_MOD_STRIP
 183 -----------------
 184 INSTALL_MOD_STRIP, if defined, will cause modules to be
 185 stripped after they are installed.  If INSTALL_MOD_STRIP is '1', then
 186 the default option --strip-debug will be used.  Otherwise,
 187 INSTALL_MOD_STRIP value will be used as the options to the strip command.
 188
 189 INSTALL_HDR_PATH
 190 ----------------
 191 INSTALL_HDR_PATH specifies where to install user space headers when
 192 executing "make headers_*".
 193
 194 The default value is::
 195
 196     $(objtree)/usr
 197
 198 $(objtree) is the directory where output files are saved.
 199 The output directory is often set using "O=..." on the commandline.
 200
 201 The value can be overridden in which case the default value is ignored.
 202
 203 KBUILD_ABS_SRCTREE
 204 --------------------------------------------------
 205 Kbuild uses a relative path to point to the tree when possible. For instance,
 206 when building in the source tree, the source tree path is '.'
 207
 208 Setting this flag requests Kbuild to use absolute path to the source tree.
 209 There are some useful cases to do so, like when generating tag files with
 210 absolute path entries etc.
 211
 212 KBUILD_SIGN_PIN
 213 ---------------
 214 This variable allows a passphrase or PIN to be passed to the sign-file
 215 utility when signing kernel modules, if the private key requires such.
 216
 217 KBUILD_MODPOST_WARN
 218 -------------------
 219 KBUILD_MODPOST_WARN can be set to avoid errors in case of undefined
 220 symbols in the final module linking stage. It changes such errors
 221 into warnings.
 222
 223 KBUILD_MODPOST_NOFINAL
 224 ----------------------
 225 KBUILD_MODPOST_NOFINAL can be set to skip the final link of modules.
 226 This is solely useful to speed up test compiles.
 227
 228 KBUILD_EXTRA_SYMBOLS
 229 --------------------
 230 For modules that use symbols from other modules.
 231 See more details in modules.txt.
 232
 233 ALLSOURCE_ARCHS
 234 ---------------
 235 For tags/TAGS/cscope targets, you can specify more than one arch
 236 to be included in the databases, separated by blank space. E.g.::
 237
 238     $ make ALLSOURCE_ARCHS="x86 mips arm" tags
 239
 240 To get all available archs you can also specify all. E.g.::
 241
 242     $ make ALLSOURCE_ARCHS=all tags
 243
 244 KBUILD_ENABLE_EXTRA_GCC_CHECKS
 245 ------------------------------
 246 If enabled over the make command line with "W=1", it turns on additional
 247 gcc -W... options for more extensive build-time checking.
 248
 249 KBUILD_BUILD_TIMESTAMP
 250 ----------------------
 251 Setting this to a date string overrides the timestamp used in the
 252 UTS_VERSION definition (uname -v in the running kernel). The value has to
 253 be a string that can be passed to date -d. The default value
 254 is the output of the date command at one point during build.
 255
 256 KBUILD_BUILD_USER, KBUILD_BUILD_HOST
 257 ------------------------------------
 258 These two variables allow to override the user@host string displayed during
 259 boot and in /proc/version. The default value is the output of the commands
 260 whoami and host, respectively.
 261
 262 KBUILD_LDS
 263 ----------
 264 The linker script with full path. Assigned by the top-level Makefile.
 265
 266 KBUILD_VMLINUX_OBJS
 267 -------------------
 268 All object files for vmlinux. They are linked to vmlinux in the same
 269 order as listed in KBUILD_VMLINUX_OBJS.
 270
 271 KBUILD_VMLINUX_LIBS
 272 -------------------
 273 All .a "lib" files for vmlinux. KBUILD_VMLINUX_OBJS and KBUILD_VMLINUX_LIBS
 274 together specify all the object files used to link vmlinux.