Documentation/kbuild/kbuild.txt

   1 Output files
   2
   3 modules.order
   4 --------------------------------------------------
   5 This file records the order in which modules appear in Makefiles. This
   6 is used by modprobe to deterministically resolve aliases that match
   7 multiple modules.
   8
   9 modules.builtin
  10 --------------------------------------------------
  11 This file lists all modules that are built into the kernel. This is used
  12 by modprobe to not fail when trying to load something builtin.
  13
  14
  15 Environment variables
  16
  17 KCPPFLAGS
  18 --------------------------------------------------
  19 Additional options to pass when preprocessing. The preprocessing options
  20 will be used in all cases where kbuild does preprocessing including
  21 building C files and assembler files.
  22
  23 KAFLAGS
  24 --------------------------------------------------
  25 Additional options to the assembler.
  26
  27 KCFLAGS
  28 --------------------------------------------------
  29 Additional options to the C compiler.
  30
  31 KBUILD_VERBOSE
  32 --------------------------------------------------
  33 Set the kbuild verbosity. Can be assigned same values as "V=...".
  34 See make help for the full list.
  35 Setting "V=..." takes precedence over KBUILD_VERBOSE.
  36
  37 KBUILD_EXTMOD
  38 --------------------------------------------------
  39 Set the directory to look for the kernel source when building external
  40 modules.
  41 The directory can be specified in several ways:
  42 1) Use "M=..." on the command line
  43 2) Environmnet variable KBUILD_EXTMOD
  44 3) Environmnet variable SUBDIRS
  45 The possibilities are listed in the order they take precedence.
  46 Using "M=..." will always override the others.
  47
  48 KBUILD_OUTPUT
  49 --------------------------------------------------
  50 Specify the output directory when building the kernel.
  51 The output directory can also be specificed using "O=...".
  52 Setting "O=..." takes precedence over KBUILD_OUTPUT.
  53
  54 ARCH
  55 --------------------------------------------------
  56 Set ARCH to the architecture to be built.
  57 In most cases the name of the architecture is the same as the
  58 directory name found in the arch/ directory.
  59 But some architectures such as x86 and sparc have aliases.
  60 x86: i386 for 32 bit, x86_64 for 64 bit
  61 sparc: sparc for 32 bit, sparc64 for 64 bit
  62
  63 CROSS_COMPILE
  64 --------------------------------------------------
  65 Specify an optional fixed part of the binutils filename.
  66 CROSS_COMPILE can be a part of the filename or the full path.
  67
  68 CROSS_COMPILE is also used for ccache in some setups.
  69
  70 CF
  71 --------------------------------------------------
  72 Additional options for sparse.
  73 CF is often used on the command-line like this:
  74
  75     make CF=-Wbitwise C=2
  76
  77 INSTALL_PATH
  78 --------------------------------------------------
  79 INSTALL_PATH specifies where to place the updated kernel and system map
  80 images. Default is /boot, but you can set it to other values.
  81
  82 INSTALLKERNEL
  83 --------------------------------------------------
  84 Install script called when using "make install".
  85 The default name is "installkernel".
  86
  87 The script will be called with the following arguments:
  88     $1 - kernel version
  89     $2 - kernel image file
  90     $3 - kernel map file
  91     $4 - default install path (use root directory if blank)
  92
  93 The implmentation of "make install" is architecture specific
  94 and it may differ from the above.
  95
  96 INSTALLKERNEL is provided to enable the possibility to
  97 specify a custom installer when cross compiling a kernel.
  98
  99 MODLIB
 100 --------------------------------------------------
 101 Specify where to install modules.
 102 The default value is:
 103
 104      $(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE)
 105
 106 The value can be overridden in which case the default value is ignored.
 107
 108 INSTALL_MOD_PATH
 109 --------------------------------------------------
 110 INSTALL_MOD_PATH specifies a prefix to MODLIB for module directory
 111 relocations required by build roots.  This is not defined in the
 112 makefile but the argument can be passed to make if needed.
 113
 114 INSTALL_MOD_STRIP
 115 --------------------------------------------------
 116 INSTALL_MOD_STRIP, if defined, will cause modules to be
 117 stripped after they are installed.  If INSTALL_MOD_STRIP is '1', then
 118 the default option --strip-debug will be used.  Otherwise,
 119 INSTALL_MOD_STRIP will used as the options to the strip command.
 120
 121 INSTALL_FW_PATH
 122 --------------------------------------------------
 123 INSTALL_FW_PATH specifies where to install the firmware blobs.
 124 The default value is:
 125
 126     $(INSTALL_MOD_PATH)/lib/firmware
 127
 128 The value can be overridden in which case the default value is ignored.
 129
 130 INSTALL_HDR_PATH
 131 --------------------------------------------------
 132 INSTALL_HDR_PATH specifies where to install user space headers when
 133 executing "make headers_*".
 134 The default value is:
 135
 136     $(objtree)/usr
 137
 138 $(objtree) is the directory where output files are saved.
 139 The output directory is often set using "O=..." on the commandline.
 140
 141 The value can be overridden in which case the default value is ignored.
 142
 143 KBUILD_MODPOST_WARN
 144 --------------------------------------------------
 145 KBUILD_MODPOST_WARN can be set to avoid errors in case of undefined
 146 symbols in the final module linking stage. It changes such errors
 147 into warnings.
 148
 149 KBUILD_MODPOST_NOFINAL
 150 --------------------------------------------------
 151 KBUILD_MODPOST_NOFINAL can be set to skip the final link of modules.
 152 This is solely useful to speed up test compiles.
 153
 154 KBUILD_EXTRA_SYMBOLS
 155 --------------------------------------------------
 156 For modules that use symbols from other modules.
 157 See more details in modules.txt.
 158
 159 ALLSOURCE_ARCHS
 160 --------------------------------------------------
 161 For tags/TAGS/cscope targets, you can specify more than one arch
 162 to be included in the databases, separated by blank space. E.g.:
 163
 164     $ make ALLSOURCE_ARCHS="x86 mips arm" tags
 165
 166 To get all available archs you can also specify all. E.g.:
 167
 168     $ make ALLSOURCE_ARCHS=all tags