Documentation/kbuild/kbuild.rst

10 -------------
11 This file records the order in which modules appear in Makefiles. This
16 ---------------
17 This file lists all modules that are built into the kernel. This is used
21 -----------------------
22 This file contains modinfo from all modules that are built into the kernel.
26 ----------------------
28 that are built into the kernel. Together with System.map, it can be used
35 ---------
37 will be used in all cases where kbuild does preprocessing including
41 -------
42 Additional options to the assembler (for built-in and modules).
45 -------------
49 -------------
50 Additional assembler options for built-in.
53 -------
54 Additional options to the C compiler (for built-in and modules).
57 ----------
58 Additional options to the Rust compiler (for built-in and modules).
61 -------------
63 code that is compiled as built-in.
66 -------------
70 ----------------
72 code that is compiled as built-in.
75 ----------------
79 --------------
83 ----------
87 ------------
91 -------------
95 -----------
99 ----------
105 ----------
109 -----------
111 with CC, so $(USERLDFLAGS) should include "-Wl," prefix as applicable.
114 --------------
115 Set the top-level Kconfig file to the value of this environment
119 --------------
127 -------------
134 -------------
138 building external modules against a pre-built kernel in a separate build
147 -----------------
156 --------------
157 For the deb-pkg target, allows overriding the normal heuristics deployed by
158 deb-pkg. Normally deb-pkg attempts to guess the right architecture based on
164 ---------
165 Specify extra (warning/error) flags for kernel-doc checks during the build,
166 see scripts/kernel-doc for which flags are supported. Note that this doesn't
170 ----
171 Set ARCH to the architecture to be built.
173 In most cases the name of the architecture is the same as the
174 directory name found in the arch/ directory.
178 - x86: i386 for 32 bit, x86_64 for 64 bit
179 - parisc: parisc64 for 64 bit
180 - sparc: sparc32 for 32 bit, sparc64 for 64 bit
183 -------------
187 CROSS_COMPILE is also used for ccache in some setups.
190 --
193 CF is often used on the command-line like this::
195     make CF=-Wbitwise C=2
198 ------------
203 -------------
209    - $1 - kernel version
210    - $2 - kernel image file
211    - $3 - kernel map file
212    - $4 - default install path (use root directory if blank)
221 ------
227 The value can be overridden in which case the default value is ignored.
230 ----------------
232 relocations required by build roots.  This is not defined in the
236 -----------------
239 the default option --strip-debug will be used.  Otherwise,
243 ----------------
254 The value can be overridden in which case the default value is ignored.
257 -----------------
259 relocations required by build roots.  This is not defined in the
263 --------------------------------------------------
265 when building in the source tree, the source tree path is '.'
272 ---------------
273 This variable allows a passphrase or PIN to be passed to the sign-file
277 -------------------
278 KBUILD_MODPOST_WARN can be set to avoid errors in case of undefined
279 symbols in the final module linking stage. It changes such errors
283 ----------------------
288 --------------------
290 See more details in modules.rst.
293 ---------------
295 to be included in the databases, separated by blank space. E.g.::
304 -----------
306 be included in the databases, separated by blank space. E.g.::
311 ----------------------
312 Setting this to a date string overrides the timestamp used in the
313 UTS_VERSION definition (uname -v in the running kernel). The value has to
314 be a string that can be passed to date -d. The default value
318 ------------------------------------
320 boot and in /proc/version. The default value is the output of the commands
324 ----