docs: note about select in kconfig-language.txt
[linux-2.6.git] / Documentation / kbuild / makefiles.txt
1 Linux Kernel Makefiles
2
3 This document describes the Linux kernel Makefiles.
4
5 === Table of Contents
6
7         === 1 Overview
8         === 2 Who does what
9         === 3 The kbuild files
10            --- 3.1 Goal definitions
11            --- 3.2 Built-in object goals - obj-y
12            --- 3.3 Loadable module goals - obj-m
13            --- 3.4 Objects which export symbols
14            --- 3.5 Library file goals - lib-y
15            --- 3.6 Descending down in directories
16            --- 3.7 Compilation flags
17            --- 3.8 Command line dependency
18            --- 3.9 Dependency tracking
19            --- 3.10 Special Rules
20            --- 3.11 $(CC) support functions
21
22         === 4 Host Program support
23            --- 4.1 Simple Host Program
24            --- 4.2 Composite Host Programs
25            --- 4.3 Defining shared libraries
26            --- 4.4 Using C++ for host programs
27            --- 4.5 Controlling compiler options for host programs
28            --- 4.6 When host programs are actually built
29            --- 4.7 Using hostprogs-$(CONFIG_FOO)
30
31         === 5 Kbuild clean infrastructure
32
33         === 6 Architecture Makefiles
34            --- 6.1 Set variables to tweak the build to the architecture
35            --- 6.2 Add prerequisites to archprepare:
36            --- 6.3 List directories to visit when descending
37            --- 6.4 Architecture-specific boot images
38            --- 6.5 Building non-kbuild targets
39            --- 6.6 Commands useful for building a boot image
40            --- 6.7 Custom kbuild commands
41            --- 6.8 Preprocessing linker scripts
42
43         === 7 Kbuild Variables
44         === 8 Makefile language
45         === 9 Credits
46         === 10 TODO
47
48 === 1 Overview
49
50 The Makefiles have five parts:
51
52         Makefile                the top Makefile.
53         .config                 the kernel configuration file.
54         arch/$(ARCH)/Makefile   the arch Makefile.
55         scripts/Makefile.*      common rules etc. for all kbuild Makefiles.
56         kbuild Makefiles        there are about 500 of these.
57
58 The top Makefile reads the .config file, which comes from the kernel
59 configuration process.
60
61 The top Makefile is responsible for building two major products: vmlinux
62 (the resident kernel image) and modules (any module files).
63 It builds these goals by recursively descending into the subdirectories of
64 the kernel source tree.
65 The list of subdirectories which are visited depends upon the kernel
66 configuration. The top Makefile textually includes an arch Makefile
67 with the name arch/$(ARCH)/Makefile. The arch Makefile supplies
68 architecture-specific information to the top Makefile.
69
70 Each subdirectory has a kbuild Makefile which carries out the commands
71 passed down from above. The kbuild Makefile uses information from the
72 .config file to construct various file lists used by kbuild to build
73 any built-in or modular targets.
74
75 scripts/Makefile.* contains all the definitions/rules etc. that
76 are used to build the kernel based on the kbuild makefiles.
77
78
79 === 2 Who does what
80
81 People have four different relationships with the kernel Makefiles.
82
83 *Users* are people who build kernels.  These people type commands such as
84 "make menuconfig" or "make".  They usually do not read or edit
85 any kernel Makefiles (or any other source files).
86
87 *Normal developers* are people who work on features such as device
88 drivers, file systems, and network protocols.  These people need to
89 maintain the kbuild Makefiles for the subsystem they are
90 working on.  In order to do this effectively, they need some overall
91 knowledge about the kernel Makefiles, plus detailed knowledge about the
92 public interface for kbuild.
93
94 *Arch developers* are people who work on an entire architecture, such
95 as sparc or ia64.  Arch developers need to know about the arch Makefile
96 as well as kbuild Makefiles.
97
98 *Kbuild developers* are people who work on the kernel build system itself.
99 These people need to know about all aspects of the kernel Makefiles.
100
101 This document is aimed towards normal developers and arch developers.
102
103
104 === 3 The kbuild files
105
106 Most Makefiles within the kernel are kbuild Makefiles that use the
107 kbuild infrastructure. This chapter introduces the syntax used in the
108 kbuild makefiles.
109 The preferred name for the kbuild files are 'Makefile' but 'Kbuild' can
110 be used and if both a 'Makefile' and a 'Kbuild' file exists, then the 'Kbuild'
111 file will be used.
112
113 Section 3.1 "Goal definitions" is a quick intro, further chapters provide
114 more details, with real examples.
115
116 --- 3.1 Goal definitions
117
118         Goal definitions are the main part (heart) of the kbuild Makefile.
119         These lines define the files to be built, any special compilation
120         options, and any subdirectories to be entered recursively.
121
122         The most simple kbuild makefile contains one line:
123
124         Example:
125                 obj-y += foo.o
126
127         This tells kbuild that there is one object in that directory, named
128         foo.o. foo.o will be built from foo.c or foo.S.
129
130         If foo.o shall be built as a module, the variable obj-m is used.
131         Therefore the following pattern is often used:
132
133         Example:
134                 obj-$(CONFIG_FOO) += foo.o
135
136         $(CONFIG_FOO) evaluates to either y (for built-in) or m (for module).
137         If CONFIG_FOO is neither y nor m, then the file will not be compiled
138         nor linked.
139
140 --- 3.2 Built-in object goals - obj-y
141
142         The kbuild Makefile specifies object files for vmlinux
143         in the $(obj-y) lists.  These lists depend on the kernel
144         configuration.
145
146         Kbuild compiles all the $(obj-y) files.  It then calls
147         "$(LD) -r" to merge these files into one built-in.o file.
148         built-in.o is later linked into vmlinux by the parent Makefile.
149
150         The order of files in $(obj-y) is significant.  Duplicates in
151         the lists are allowed: the first instance will be linked into
152         built-in.o and succeeding instances will be ignored.
153
154         Link order is significant, because certain functions
155         (module_init() / __initcall) will be called during boot in the
156         order they appear. So keep in mind that changing the link
157         order may e.g. change the order in which your SCSI
158         controllers are detected, and thus your disks are renumbered.
159
160         Example:
161                 #drivers/isdn/i4l/Makefile
162                 # Makefile for the kernel ISDN subsystem and device drivers.
163                 # Each configuration option enables a list of files.
164                 obj-$(CONFIG_ISDN)             += isdn.o
165                 obj-$(CONFIG_ISDN_PPP_BSDCOMP) += isdn_bsdcomp.o
166
167 --- 3.3 Loadable module goals - obj-m
168
169         $(obj-m) specify object files which are built as loadable
170         kernel modules.
171
172         A module may be built from one source file or several source
173         files. In the case of one source file, the kbuild makefile
174         simply adds the file to $(obj-m).
175
176         Example:
177                 #drivers/isdn/i4l/Makefile
178                 obj-$(CONFIG_ISDN_PPP_BSDCOMP) += isdn_bsdcomp.o
179
180         Note: In this example $(CONFIG_ISDN_PPP_BSDCOMP) evaluates to 'm'
181
182         If a kernel module is built from several source files, you specify
183         that you want to build a module in the same way as above.
184
185         Kbuild needs to know which the parts that you want to build your
186         module from, so you have to tell it by setting an
187         $(<module_name>-objs) variable.
188
189         Example:
190                 #drivers/isdn/i4l/Makefile
191                 obj-$(CONFIG_ISDN) += isdn.o
192                 isdn-objs := isdn_net_lib.o isdn_v110.o isdn_common.o
193
194         In this example, the module name will be isdn.o. Kbuild will
195         compile the objects listed in $(isdn-objs) and then run
196         "$(LD) -r" on the list of these files to generate isdn.o.
197
198         Kbuild recognises objects used for composite objects by the suffix
199         -objs, and the suffix -y. This allows the Makefiles to use
200         the value of a CONFIG_ symbol to determine if an object is part
201         of a composite object.
202
203         Example:
204                 #fs/ext2/Makefile
205                 obj-$(CONFIG_EXT2_FS)        += ext2.o
206                 ext2-y                       := balloc.o bitmap.o
207                 ext2-$(CONFIG_EXT2_FS_XATTR) += xattr.o
208
209         In this example, xattr.o is only part of the composite object
210         ext2.o if $(CONFIG_EXT2_FS_XATTR) evaluates to 'y'.
211
212         Note: Of course, when you are building objects into the kernel,
213         the syntax above will also work. So, if you have CONFIG_EXT2_FS=y,
214         kbuild will build an ext2.o file for you out of the individual
215         parts and then link this into built-in.o, as you would expect.
216
217 --- 3.4 Objects which export symbols
218
219         No special notation is required in the makefiles for
220         modules exporting symbols.
221
222 --- 3.5 Library file goals - lib-y
223
224         Objects listed with obj-* are used for modules, or
225         combined in a built-in.o for that specific directory.
226         There is also the possibility to list objects that will
227         be included in a library, lib.a.
228         All objects listed with lib-y are combined in a single
229         library for that directory.
230         Objects that are listed in obj-y and additionally listed in
231         lib-y will not be included in the library, since they will
232         be accessible anyway.
233         For consistency, objects listed in lib-m will be included in lib.a.
234
235         Note that the same kbuild makefile may list files to be built-in
236         and to be part of a library. Therefore the same directory
237         may contain both a built-in.o and a lib.a file.
238
239         Example:
240                 #arch/i386/lib/Makefile
241                 lib-y    := checksum.o delay.o
242
243         This will create a library lib.a based on checksum.o and delay.o.
244         For kbuild to actually recognize that there is a lib.a being built,
245         the directory shall be listed in libs-y.
246         See also "6.3 List directories to visit when descending".
247
248         Use of lib-y is normally restricted to lib/ and arch/*/lib.
249
250 --- 3.6 Descending down in directories
251
252         A Makefile is only responsible for building objects in its own
253         directory. Files in subdirectories should be taken care of by
254         Makefiles in these subdirs. The build system will automatically
255         invoke make recursively in subdirectories, provided you let it know of
256         them.
257
258         To do so, obj-y and obj-m are used.
259         ext2 lives in a separate directory, and the Makefile present in fs/
260         tells kbuild to descend down using the following assignment.
261
262         Example:
263                 #fs/Makefile
264                 obj-$(CONFIG_EXT2_FS) += ext2/
265
266         If CONFIG_EXT2_FS is set to either 'y' (built-in) or 'm' (modular)
267         the corresponding obj- variable will be set, and kbuild will descend
268         down in the ext2 directory.
269         Kbuild only uses this information to decide that it needs to visit
270         the directory, it is the Makefile in the subdirectory that
271         specifies what is modules and what is built-in.
272
273         It is good practice to use a CONFIG_ variable when assigning directory
274         names. This allows kbuild to totally skip the directory if the
275         corresponding CONFIG_ option is neither 'y' nor 'm'.
276
277 --- 3.7 Compilation flags
278
279     EXTRA_CFLAGS, EXTRA_AFLAGS, EXTRA_LDFLAGS, EXTRA_ARFLAGS
280
281         All the EXTRA_ variables apply only to the kbuild makefile
282         where they are assigned. The EXTRA_ variables apply to all
283         commands executed in the kbuild makefile.
284
285         $(EXTRA_CFLAGS) specifies options for compiling C files with
286         $(CC).
287
288         Example:
289                 # drivers/sound/emu10k1/Makefile
290                 EXTRA_CFLAGS += -I$(obj)
291                 ifdef DEBUG
292                     EXTRA_CFLAGS += -DEMU10K1_DEBUG
293                 endif
294
295
296         This variable is necessary because the top Makefile owns the
297         variable $(CFLAGS) and uses it for compilation flags for the
298         entire tree.
299
300         $(EXTRA_AFLAGS) is a similar string for per-directory options
301         when compiling assembly language source.
302
303         Example:
304                 #arch/x86_64/kernel/Makefile
305                 EXTRA_AFLAGS := -traditional
306
307
308         $(EXTRA_LDFLAGS) and $(EXTRA_ARFLAGS) are similar strings for
309         per-directory options to $(LD) and $(AR).
310
311         Example:
312                 #arch/m68k/fpsp040/Makefile
313                 EXTRA_LDFLAGS := -x
314
315     CFLAGS_$@, AFLAGS_$@
316
317         CFLAGS_$@ and AFLAGS_$@ only apply to commands in current
318         kbuild makefile.
319
320         $(CFLAGS_$@) specifies per-file options for $(CC).  The $@
321         part has a literal value which specifies the file that it is for.
322
323         Example:
324                 # drivers/scsi/Makefile
325                 CFLAGS_aha152x.o =   -DAHA152X_STAT -DAUTOCONF
326                 CFLAGS_gdth.o    = # -DDEBUG_GDTH=2 -D__SERIAL__ -D__COM2__ \
327                                      -DGDTH_STATISTICS
328                 CFLAGS_seagate.o =   -DARBITRATE -DPARITY -DSEAGATE_USE_ASM
329
330         These three lines specify compilation flags for aha152x.o,
331         gdth.o, and seagate.o
332
333         $(AFLAGS_$@) is a similar feature for source files in assembly
334         languages.
335
336         Example:
337                 # arch/arm/kernel/Makefile
338                 AFLAGS_head-armv.o := -DTEXTADDR=$(TEXTADDR) -traditional
339                 AFLAGS_head-armo.o := -DTEXTADDR=$(TEXTADDR) -traditional
340
341 --- 3.9 Dependency tracking
342
343         Kbuild tracks dependencies on the following:
344         1) All prerequisite files (both *.c and *.h)
345         2) CONFIG_ options used in all prerequisite files
346         3) Command-line used to compile target
347
348         Thus, if you change an option to $(CC) all affected files will
349         be re-compiled.
350
351 --- 3.10 Special Rules
352
353         Special rules are used when the kbuild infrastructure does
354         not provide the required support. A typical example is
355         header files generated during the build process.
356         Another example are the architecture-specific Makefiles which
357         need special rules to prepare boot images etc.
358
359         Special rules are written as normal Make rules.
360         Kbuild is not executing in the directory where the Makefile is
361         located, so all special rules shall provide a relative
362         path to prerequisite files and target files.
363
364         Two variables are used when defining special rules:
365
366     $(src)
367         $(src) is a relative path which points to the directory
368         where the Makefile is located. Always use $(src) when
369         referring to files located in the src tree.
370
371     $(obj)
372         $(obj) is a relative path which points to the directory
373         where the target is saved. Always use $(obj) when
374         referring to generated files.
375
376         Example:
377                 #drivers/scsi/Makefile
378                 $(obj)/53c8xx_d.h: $(src)/53c7,8xx.scr $(src)/script_asm.pl
379                         $(CPP) -DCHIP=810 - < $< | ... $(src)/script_asm.pl
380
381         This is a special rule, following the normal syntax
382         required by make.
383         The target file depends on two prerequisite files. References
384         to the target file are prefixed with $(obj), references
385         to prerequisites are referenced with $(src) (because they are not
386         generated files).
387
388 --- 3.11 $(CC) support functions
389
390         The kernel may be built with several different versions of
391         $(CC), each supporting a unique set of features and options.
392         kbuild provide basic support to check for valid options for $(CC).
393         $(CC) is usually the gcc compiler, but other alternatives are
394         available.
395
396     as-option
397         as-option is used to check if $(CC) -- when used to compile
398         assembler (*.S) files -- supports the given option. An optional
399         second option may be specified if the first option is not supported.
400
401         Example:
402                 #arch/sh/Makefile
403                 cflags-y += $(call as-option,-Wa$(comma)-isa=$(isa-y),)
404
405         In the above example, cflags-y will be assigned the option
406         -Wa$(comma)-isa=$(isa-y) if it is supported by $(CC).
407         The second argument is optional, and if supplied will be used
408         if first argument is not supported.
409
410     ld-option
411         ld-option is used to check if $(CC) when used to link object files
412         supports the given option.  An optional second option may be
413         specified if first option are not supported.
414
415         Example:
416                 #arch/i386/kernel/Makefile
417                 vsyscall-flags += $(call ld-option, -Wl$(comma)--hash-style=sysv)
418
419         In the above example, vsyscall-flags will be assigned the option
420         -Wl$(comma)--hash-style=sysv if it is supported by $(CC).
421         The second argument is optional, and if supplied will be used
422         if first argument is not supported.
423
424     as-instr
425         as-instr checks if the assembler reports a specific instruction
426         and then outputs either option1 or option2
427         C escapes are supported in the test instruction
428
429     cc-option
430         cc-option is used to check if $(CC) supports a given option, and not
431         supported to use an optional second option.
432
433         Example:
434                 #arch/i386/Makefile
435                 cflags-y += $(call cc-option,-march=pentium-mmx,-march=i586)
436
437         In the above example, cflags-y will be assigned the option
438         -march=pentium-mmx if supported by $(CC), otherwise -march=i586.
439         The second argument to cc-option is optional, and if omitted,
440         cflags-y will be assigned no value if first option is not supported.
441
442    cc-option-yn
443         cc-option-yn is used to check if gcc supports a given option
444         and return 'y' if supported, otherwise 'n'.
445
446         Example:
447                 #arch/ppc/Makefile
448                 biarch := $(call cc-option-yn, -m32)
449                 aflags-$(biarch) += -a32
450                 cflags-$(biarch) += -m32
451
452         In the above example, $(biarch) is set to y if $(CC) supports the -m32
453         option. When $(biarch) equals 'y', the expanded variables $(aflags-y)
454         and $(cflags-y) will be assigned the values -a32 and -m32,
455         respectively.
456
457     cc-option-align
458         gcc versions >= 3.0 changed the type of options used to specify
459         alignment of functions, loops etc. $(cc-option-align), when used
460         as prefix to the align options, will select the right prefix:
461         gcc < 3.00
462                 cc-option-align = -malign
463         gcc >= 3.00
464                 cc-option-align = -falign
465
466         Example:
467                 CFLAGS += $(cc-option-align)-functions=4
468
469         In the above example, the option -falign-functions=4 is used for
470         gcc >= 3.00. For gcc < 3.00, -malign-functions=4 is used.
471
472     cc-version
473         cc-version returns a numerical version of the $(CC) compiler version.
474         The format is <major><minor> where both are two digits. So for example
475         gcc 3.41 would return 0341.
476         cc-version is useful when a specific $(CC) version is faulty in one
477         area, for example -mregparm=3 was broken in some gcc versions
478         even though the option was accepted by gcc.
479
480         Example:
481                 #arch/i386/Makefile
482                 cflags-y += $(shell \
483                 if [ $(call cc-version) -ge 0300 ] ; then \
484                         echo "-mregparm=3"; fi ;)
485
486         In the above example, -mregparm=3 is only used for gcc version greater
487         than or equal to gcc 3.0.
488
489     cc-ifversion
490         cc-ifversion tests the version of $(CC) and equals last argument if
491         version expression is true.
492
493         Example:
494                 #fs/reiserfs/Makefile
495                 EXTRA_CFLAGS := $(call cc-ifversion, -lt, 0402, -O1)
496
497         In this example, EXTRA_CFLAGS will be assigned the value -O1 if the
498         $(CC) version is less than 4.2.
499         cc-ifversion takes all the shell operators:
500         -eq, -ne, -lt, -le, -gt, and -ge
501         The third parameter may be a text as in this example, but it may also
502         be an expanded variable or a macro.
503
504     cc-fullversion
505         cc-fullversion is useful when the exact version of gcc is needed.
506         One typical use-case is when a specific GCC version is broken.
507         cc-fullversion points out a more specific version than cc-version does.
508
509         Example:
510                 #arch/powerpc/Makefile
511                 $(Q)if test "$(call cc-fullversion)" = "040200" ; then \
512                         echo -n '*** GCC-4.2.0 cannot compile the 64-bit powerpc ' ; \
513                         false ; \
514                 fi
515
516         In this example for a specific GCC version the build will error out explaining
517         to the user why it stops.
518
519 === 4 Host Program support
520
521 Kbuild supports building executables on the host for use during the
522 compilation stage.
523 Two steps are required in order to use a host executable.
524
525 The first step is to tell kbuild that a host program exists. This is
526 done utilising the variable hostprogs-y.
527
528 The second step is to add an explicit dependency to the executable.
529 This can be done in two ways. Either add the dependency in a rule,
530 or utilise the variable $(always).
531 Both possibilities are described in the following.
532
533 --- 4.1 Simple Host Program
534
535         In some cases there is a need to compile and run a program on the
536         computer where the build is running.
537         The following line tells kbuild that the program bin2hex shall be
538         built on the build host.
539
540         Example:
541                 hostprogs-y := bin2hex
542
543         Kbuild assumes in the above example that bin2hex is made from a single
544         c-source file named bin2hex.c located in the same directory as
545         the Makefile.
546
547 --- 4.2 Composite Host Programs
548
549         Host programs can be made up based on composite objects.
550         The syntax used to define composite objects for host programs is
551         similar to the syntax used for kernel objects.
552         $(<executable>-objs) lists all objects used to link the final
553         executable.
554
555         Example:
556                 #scripts/lxdialog/Makefile
557                 hostprogs-y   := lxdialog
558                 lxdialog-objs := checklist.o lxdialog.o
559
560         Objects with extension .o are compiled from the corresponding .c
561         files. In the above example, checklist.c is compiled to checklist.o
562         and lxdialog.c is compiled to lxdialog.o.
563         Finally, the two .o files are linked to the executable, lxdialog.
564         Note: The syntax <executable>-y is not permitted for host-programs.
565
566 --- 4.3 Defining shared libraries
567
568         Objects with extension .so are considered shared libraries, and
569         will be compiled as position independent objects.
570         Kbuild provides support for shared libraries, but the usage
571         shall be restricted.
572         In the following example the libkconfig.so shared library is used
573         to link the executable conf.
574
575         Example:
576                 #scripts/kconfig/Makefile
577                 hostprogs-y     := conf
578                 conf-objs       := conf.o libkconfig.so
579                 libkconfig-objs := expr.o type.o
580
581         Shared libraries always require a corresponding -objs line, and
582         in the example above the shared library libkconfig is composed by
583         the two objects expr.o and type.o.
584         expr.o and type.o will be built as position independent code and
585         linked as a shared library libkconfig.so. C++ is not supported for
586         shared libraries.
587
588 --- 4.4 Using C++ for host programs
589
590         kbuild offers support for host programs written in C++. This was
591         introduced solely to support kconfig, and is not recommended
592         for general use.
593
594         Example:
595                 #scripts/kconfig/Makefile
596                 hostprogs-y   := qconf
597                 qconf-cxxobjs := qconf.o
598
599         In the example above the executable is composed of the C++ file
600         qconf.cc - identified by $(qconf-cxxobjs).
601
602         If qconf is composed by a mixture of .c and .cc files, then an
603         additional line can be used to identify this.
604
605         Example:
606                 #scripts/kconfig/Makefile
607                 hostprogs-y   := qconf
608                 qconf-cxxobjs := qconf.o
609                 qconf-objs    := check.o
610
611 --- 4.5 Controlling compiler options for host programs
612
613         When compiling host programs, it is possible to set specific flags.
614         The programs will always be compiled utilising $(HOSTCC) passed
615         the options specified in $(HOSTCFLAGS).
616         To set flags that will take effect for all host programs created
617         in that Makefile, use the variable HOST_EXTRACFLAGS.
618
619         Example:
620                 #scripts/lxdialog/Makefile
621                 HOST_EXTRACFLAGS += -I/usr/include/ncurses
622
623         To set specific flags for a single file the following construction
624         is used:
625
626         Example:
627                 #arch/ppc64/boot/Makefile
628                 HOSTCFLAGS_piggyback.o := -DKERNELBASE=$(KERNELBASE)
629
630         It is also possible to specify additional options to the linker.
631
632         Example:
633                 #scripts/kconfig/Makefile
634                 HOSTLOADLIBES_qconf := -L$(QTDIR)/lib
635
636         When linking qconf, it will be passed the extra option
637         "-L$(QTDIR)/lib".
638
639 --- 4.6 When host programs are actually built
640
641         Kbuild will only build host-programs when they are referenced
642         as a prerequisite.
643         This is possible in two ways:
644
645         (1) List the prerequisite explicitly in a special rule.
646
647         Example:
648                 #drivers/pci/Makefile
649                 hostprogs-y := gen-devlist
650                 $(obj)/devlist.h: $(src)/pci.ids $(obj)/gen-devlist
651                         ( cd $(obj); ./gen-devlist ) < $<
652
653         The target $(obj)/devlist.h will not be built before
654         $(obj)/gen-devlist is updated. Note that references to
655         the host programs in special rules must be prefixed with $(obj).
656
657         (2) Use $(always)
658         When there is no suitable special rule, and the host program
659         shall be built when a makefile is entered, the $(always)
660         variable shall be used.
661
662         Example:
663                 #scripts/lxdialog/Makefile
664                 hostprogs-y   := lxdialog
665                 always        := $(hostprogs-y)
666
667         This will tell kbuild to build lxdialog even if not referenced in
668         any rule.
669
670 --- 4.7 Using hostprogs-$(CONFIG_FOO)
671
672         A typical pattern in a Kbuild file looks like this:
673
674         Example:
675                 #scripts/Makefile
676                 hostprogs-$(CONFIG_KALLSYMS) += kallsyms
677
678         Kbuild knows about both 'y' for built-in and 'm' for module.
679         So if a config symbol evaluate to 'm', kbuild will still build
680         the binary. In other words, Kbuild handles hostprogs-m exactly
681         like hostprogs-y. But only hostprogs-y is recommended to be used
682         when no CONFIG symbols are involved.
683
684 === 5 Kbuild clean infrastructure
685
686 "make clean" deletes most generated files in the obj tree where the kernel
687 is compiled. This includes generated files such as host programs.
688 Kbuild knows targets listed in $(hostprogs-y), $(hostprogs-m), $(always),
689 $(extra-y) and $(targets). They are all deleted during "make clean".
690 Files matching the patterns "*.[oas]", "*.ko", plus some additional files
691 generated by kbuild are deleted all over the kernel src tree when
692 "make clean" is executed.
693
694 Additional files can be specified in kbuild makefiles by use of $(clean-files).
695
696         Example:
697                 #drivers/pci/Makefile
698                 clean-files := devlist.h classlist.h
699
700 When executing "make clean", the two files "devlist.h classlist.h" will
701 be deleted. Kbuild will assume files to be in same relative directory as the
702 Makefile except if an absolute path is specified (path starting with '/').
703
704 To delete a directory hierarchy use:
705
706         Example:
707                 #scripts/package/Makefile
708                 clean-dirs := $(objtree)/debian/
709
710 This will delete the directory debian, including all subdirectories.
711 Kbuild will assume the directories to be in the same relative path as the
712 Makefile if no absolute path is specified (path does not start with '/').
713
714 Usually kbuild descends down in subdirectories due to "obj-* := dir/",
715 but in the architecture makefiles where the kbuild infrastructure
716 is not sufficient this sometimes needs to be explicit.
717
718         Example:
719                 #arch/i386/boot/Makefile
720                 subdir- := compressed/
721
722 The above assignment instructs kbuild to descend down in the
723 directory compressed/ when "make clean" is executed.
724
725 To support the clean infrastructure in the Makefiles that builds the
726 final bootimage there is an optional target named archclean:
727
728         Example:
729                 #arch/i386/Makefile
730                 archclean:
731                         $(Q)$(MAKE) $(clean)=arch/i386/boot
732
733 When "make clean" is executed, make will descend down in arch/i386/boot,
734 and clean as usual. The Makefile located in arch/i386/boot/ may use
735 the subdir- trick to descend further down.
736
737 Note 1: arch/$(ARCH)/Makefile cannot use "subdir-", because that file is
738 included in the top level makefile, and the kbuild infrastructure
739 is not operational at that point.
740
741 Note 2: All directories listed in core-y, libs-y, drivers-y and net-y will
742 be visited during "make clean".
743
744 === 6 Architecture Makefiles
745
746 The top level Makefile sets up the environment and does the preparation,
747 before starting to descend down in the individual directories.
748 The top level makefile contains the generic part, whereas
749 arch/$(ARCH)/Makefile contains what is required to set up kbuild
750 for said architecture.
751 To do so, arch/$(ARCH)/Makefile sets up a number of variables and defines
752 a few targets.
753
754 When kbuild executes, the following steps are followed (roughly):
755 1) Configuration of the kernel => produce .config
756 2) Store kernel version in include/linux/version.h
757 3) Symlink include/asm to include/asm-$(ARCH)
758 4) Updating all other prerequisites to the target prepare:
759    - Additional prerequisites are specified in arch/$(ARCH)/Makefile
760 5) Recursively descend down in all directories listed in
761    init-* core* drivers-* net-* libs-* and build all targets.
762    - The values of the above variables are expanded in arch/$(ARCH)/Makefile.
763 6) All object files are then linked and the resulting file vmlinux is
764    located at the root of the obj tree.
765    The very first objects linked are listed in head-y, assigned by
766    arch/$(ARCH)/Makefile.
767 7) Finally, the architecture-specific part does any required post processing
768    and builds the final bootimage.
769    - This includes building boot records
770    - Preparing initrd images and the like
771
772
773 --- 6.1 Set variables to tweak the build to the architecture
774
775     LDFLAGS             Generic $(LD) options
776
777         Flags used for all invocations of the linker.
778         Often specifying the emulation is sufficient.
779
780         Example:
781                 #arch/s390/Makefile
782                 LDFLAGS         := -m elf_s390
783         Note: EXTRA_LDFLAGS and LDFLAGS_$@ can be used to further customise
784         the flags used. See chapter 7.
785
786     LDFLAGS_MODULE      Options for $(LD) when linking modules
787
788         LDFLAGS_MODULE is used to set specific flags for $(LD) when
789         linking the .ko files used for modules.
790         Default is "-r", for relocatable output.
791
792     LDFLAGS_vmlinux     Options for $(LD) when linking vmlinux
793
794         LDFLAGS_vmlinux is used to specify additional flags to pass to
795         the linker when linking the final vmlinux image.
796         LDFLAGS_vmlinux uses the LDFLAGS_$@ support.
797
798         Example:
799                 #arch/i386/Makefile
800                 LDFLAGS_vmlinux := -e stext
801
802     OBJCOPYFLAGS        objcopy flags
803
804         When $(call if_changed,objcopy) is used to translate a .o file,
805         the flags specified in OBJCOPYFLAGS will be used.
806         $(call if_changed,objcopy) is often used to generate raw binaries on
807         vmlinux.
808
809         Example:
810                 #arch/s390/Makefile
811                 OBJCOPYFLAGS := -O binary
812
813                 #arch/s390/boot/Makefile
814                 $(obj)/image: vmlinux FORCE
815                         $(call if_changed,objcopy)
816
817         In this example, the binary $(obj)/image is a binary version of
818         vmlinux. The usage of $(call if_changed,xxx) will be described later.
819
820     AFLAGS              $(AS) assembler flags
821
822         Default value - see top level Makefile
823         Append or modify as required per architecture.
824
825         Example:
826                 #arch/sparc64/Makefile
827                 AFLAGS += -m64 -mcpu=ultrasparc
828
829     CFLAGS              $(CC) compiler flags
830
831         Default value - see top level Makefile
832         Append or modify as required per architecture.
833
834         Often, the CFLAGS variable depends on the configuration.
835
836         Example:
837                 #arch/i386/Makefile
838                 cflags-$(CONFIG_M386) += -march=i386
839                 CFLAGS += $(cflags-y)
840
841         Many arch Makefiles dynamically run the target C compiler to
842         probe supported options:
843
844                 #arch/i386/Makefile
845
846                 ...
847                 cflags-$(CONFIG_MPENTIUMII)     += $(call cc-option,\
848                                                 -march=pentium2,-march=i686)
849                 ...
850                 # Disable unit-at-a-time mode ...
851                 CFLAGS += $(call cc-option,-fno-unit-at-a-time)
852                 ...
853
854
855         The first example utilises the trick that a config option expands
856         to 'y' when selected.
857
858     CFLAGS_KERNEL       $(CC) options specific for built-in
859
860         $(CFLAGS_KERNEL) contains extra C compiler flags used to compile
861         resident kernel code.
862
863     CFLAGS_MODULE       $(CC) options specific for modules
864
865         $(CFLAGS_MODULE) contains extra C compiler flags used to compile code
866         for loadable kernel modules.
867
868
869 --- 6.2 Add prerequisites to archprepare:
870
871         The archprepare: rule is used to list prerequisites that need to be
872         built before starting to descend down in the subdirectories.
873         This is usually used for header files containing assembler constants.
874
875                 Example:
876                 #arch/arm/Makefile
877                 archprepare: maketools
878
879         In this example, the file target maketools will be processed
880         before descending down in the subdirectories.
881         See also chapter XXX-TODO that describe how kbuild supports
882         generating offset header files.
883
884
885 --- 6.3 List directories to visit when descending
886
887         An arch Makefile cooperates with the top Makefile to define variables
888         which specify how to build the vmlinux file.  Note that there is no
889         corresponding arch-specific section for modules; the module-building
890         machinery is all architecture-independent.
891
892
893     head-y, init-y, core-y, libs-y, drivers-y, net-y
894
895         $(head-y) lists objects to be linked first in vmlinux.
896         $(libs-y) lists directories where a lib.a archive can be located.
897         The rest list directories where a built-in.o object file can be
898         located.
899
900         $(init-y) objects will be located after $(head-y).
901         Then the rest follows in this order:
902         $(core-y), $(libs-y), $(drivers-y) and $(net-y).
903
904         The top level Makefile defines values for all generic directories,
905         and arch/$(ARCH)/Makefile only adds architecture-specific directories.
906
907         Example:
908                 #arch/sparc64/Makefile
909                 core-y += arch/sparc64/kernel/
910                 libs-y += arch/sparc64/prom/ arch/sparc64/lib/
911                 drivers-$(CONFIG_OPROFILE)  += arch/sparc64/oprofile/
912
913
914 --- 6.4 Architecture-specific boot images
915
916         An arch Makefile specifies goals that take the vmlinux file, compress
917         it, wrap it in bootstrapping code, and copy the resulting files
918         somewhere. This includes various kinds of installation commands.
919         The actual goals are not standardized across architectures.
920
921         It is common to locate any additional processing in a boot/
922         directory below arch/$(ARCH)/.
923
924         Kbuild does not provide any smart way to support building a
925         target specified in boot/. Therefore arch/$(ARCH)/Makefile shall
926         call make manually to build a target in boot/.
927
928         The recommended approach is to include shortcuts in
929         arch/$(ARCH)/Makefile, and use the full path when calling down
930         into the arch/$(ARCH)/boot/Makefile.
931
932         Example:
933                 #arch/i386/Makefile
934                 boot := arch/i386/boot
935                 bzImage: vmlinux
936                         $(Q)$(MAKE) $(build)=$(boot) $(boot)/$@
937
938         "$(Q)$(MAKE) $(build)=<dir>" is the recommended way to invoke
939         make in a subdirectory.
940
941         There are no rules for naming architecture-specific targets,
942         but executing "make help" will list all relevant targets.
943         To support this, $(archhelp) must be defined.
944
945         Example:
946                 #arch/i386/Makefile
947                 define archhelp
948                   echo  '* bzImage      - Image (arch/$(ARCH)/boot/bzImage)'
949                 endif
950
951         When make is executed without arguments, the first goal encountered
952         will be built. In the top level Makefile the first goal present
953         is all:.
954         An architecture shall always, per default, build a bootable image.
955         In "make help", the default goal is highlighted with a '*'.
956         Add a new prerequisite to all: to select a default goal different
957         from vmlinux.
958
959         Example:
960                 #arch/i386/Makefile
961                 all: bzImage
962
963         When "make" is executed without arguments, bzImage will be built.
964
965 --- 6.5 Building non-kbuild targets
966
967     extra-y
968
969         extra-y specify additional targets created in the current
970         directory, in addition to any targets specified by obj-*.
971
972         Listing all targets in extra-y is required for two purposes:
973         1) Enable kbuild to check changes in command lines
974            - When $(call if_changed,xxx) is used
975         2) kbuild knows what files to delete during "make clean"
976
977         Example:
978                 #arch/i386/kernel/Makefile
979                 extra-y := head.o init_task.o
980
981         In this example, extra-y is used to list object files that
982         shall be built, but shall not be linked as part of built-in.o.
983
984
985 --- 6.6 Commands useful for building a boot image
986
987         Kbuild provides a few macros that are useful when building a
988         boot image.
989
990     if_changed
991
992         if_changed is the infrastructure used for the following commands.
993
994         Usage:
995                 target: source(s) FORCE
996                         $(call if_changed,ld/objcopy/gzip)
997
998         When the rule is evaluated, it is checked to see if any files
999         need an update, or the command line has changed since the last
1000         invocation. The latter will force a rebuild if any options
1001         to the executable have changed.
1002         Any target that utilises if_changed must be listed in $(targets),
1003         otherwise the command line check will fail, and the target will
1004         always be built.
1005         Assignments to $(targets) are without $(obj)/ prefix.
1006         if_changed may be used in conjunction with custom commands as
1007         defined in 6.7 "Custom kbuild commands".
1008
1009         Note: It is a typical mistake to forget the FORCE prerequisite.
1010         Another common pitfall is that whitespace is sometimes
1011         significant; for instance, the below will fail (note the extra space
1012         after the comma):
1013                 target: source(s) FORCE
1014         #WRONG!#        $(call if_changed, ld/objcopy/gzip)
1015
1016     ld
1017         Link target. Often, LDFLAGS_$@ is used to set specific options to ld.
1018
1019     objcopy
1020         Copy binary. Uses OBJCOPYFLAGS usually specified in
1021         arch/$(ARCH)/Makefile.
1022         OBJCOPYFLAGS_$@ may be used to set additional options.
1023
1024     gzip
1025         Compress target. Use maximum compression to compress target.
1026
1027         Example:
1028                 #arch/i386/boot/Makefile
1029                 LDFLAGS_bootsect := -Ttext 0x0 -s --oformat binary
1030                 LDFLAGS_setup    := -Ttext 0x0 -s --oformat binary -e begtext
1031
1032                 targets += setup setup.o bootsect bootsect.o
1033                 $(obj)/setup $(obj)/bootsect: %: %.o FORCE
1034                         $(call if_changed,ld)
1035
1036         In this example, there are two possible targets, requiring different
1037         options to the linker. The linker options are specified using the
1038         LDFLAGS_$@ syntax - one for each potential target.
1039         $(targets) are assigned all potential targets, by which kbuild knows
1040         the targets and will:
1041                 1) check for commandline changes
1042                 2) delete target during make clean
1043
1044         The ": %: %.o" part of the prerequisite is a shorthand that
1045         free us from listing the setup.o and bootsect.o files.
1046         Note: It is a common mistake to forget the "target :=" assignment,
1047               resulting in the target file being recompiled for no
1048               obvious reason.
1049
1050
1051 --- 6.7 Custom kbuild commands
1052
1053         When kbuild is executing with KBUILD_VERBOSE=0, then only a shorthand
1054         of a command is normally displayed.
1055         To enable this behaviour for custom commands kbuild requires
1056         two variables to be set:
1057         quiet_cmd_<command>     - what shall be echoed
1058               cmd_<command>     - the command to execute
1059
1060         Example:
1061                 #
1062                 quiet_cmd_image = BUILD   $@
1063                       cmd_image = $(obj)/tools/build $(BUILDFLAGS) \
1064                                                      $(obj)/vmlinux.bin > $@
1065
1066                 targets += bzImage
1067                 $(obj)/bzImage: $(obj)/vmlinux.bin $(obj)/tools/build FORCE
1068                         $(call if_changed,image)
1069                         @echo 'Kernel: $@ is ready'
1070
1071         When updating the $(obj)/bzImage target, the line
1072
1073         BUILD    arch/i386/boot/bzImage
1074
1075         will be displayed with "make KBUILD_VERBOSE=0".
1076
1077
1078 --- 6.8 Preprocessing linker scripts
1079
1080         When the vmlinux image is built, the linker script
1081         arch/$(ARCH)/kernel/vmlinux.lds is used.
1082         The script is a preprocessed variant of the file vmlinux.lds.S
1083         located in the same directory.
1084         kbuild knows .lds files and includes a rule *lds.S -> *lds.
1085
1086         Example:
1087                 #arch/i386/kernel/Makefile
1088                 always := vmlinux.lds
1089
1090                 #Makefile
1091                 export CPPFLAGS_vmlinux.lds += -P -C -U$(ARCH)
1092
1093         The assignment to $(always) is used to tell kbuild to build the
1094         target vmlinux.lds.
1095         The assignment to $(CPPFLAGS_vmlinux.lds) tells kbuild to use the
1096         specified options when building the target vmlinux.lds.
1097
1098         When building the *.lds target, kbuild uses the variables:
1099         CPPFLAGS        : Set in top-level Makefile
1100         EXTRA_CPPFLAGS  : May be set in the kbuild makefile
1101         CPPFLAGS_$(@F)  : Target specific flags.
1102                           Note that the full filename is used in this
1103                           assignment.
1104
1105         The kbuild infrastructure for *lds file are used in several
1106         architecture-specific files.
1107
1108
1109 === 7 Kbuild Variables
1110
1111 The top Makefile exports the following variables:
1112
1113     VERSION, PATCHLEVEL, SUBLEVEL, EXTRAVERSION
1114
1115         These variables define the current kernel version.  A few arch
1116         Makefiles actually use these values directly; they should use
1117         $(KERNELRELEASE) instead.
1118
1119         $(VERSION), $(PATCHLEVEL), and $(SUBLEVEL) define the basic
1120         three-part version number, such as "2", "4", and "0".  These three
1121         values are always numeric.
1122
1123         $(EXTRAVERSION) defines an even tinier sublevel for pre-patches
1124         or additional patches.  It is usually some non-numeric string
1125         such as "-pre4", and is often blank.
1126
1127     KERNELRELEASE
1128
1129         $(KERNELRELEASE) is a single string such as "2.4.0-pre4", suitable
1130         for constructing installation directory names or showing in
1131         version strings.  Some arch Makefiles use it for this purpose.
1132
1133     ARCH
1134
1135         This variable defines the target architecture, such as "i386",
1136         "arm", or "sparc". Some kbuild Makefiles test $(ARCH) to
1137         determine which files to compile.
1138
1139         By default, the top Makefile sets $(ARCH) to be the same as the
1140         host system architecture.  For a cross build, a user may
1141         override the value of $(ARCH) on the command line:
1142
1143             make ARCH=m68k ...
1144
1145
1146     INSTALL_PATH
1147
1148         This variable defines a place for the arch Makefiles to install
1149         the resident kernel image and System.map file.
1150         Use this for architecture-specific install targets.
1151
1152     INSTALL_MOD_PATH, MODLIB
1153
1154         $(INSTALL_MOD_PATH) specifies a prefix to $(MODLIB) for module
1155         installation.  This variable is not defined in the Makefile but
1156         may be passed in by the user if desired.
1157
1158         $(MODLIB) specifies the directory for module installation.
1159         The top Makefile defines $(MODLIB) to
1160         $(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE).  The user may
1161         override this value on the command line if desired.
1162
1163     INSTALL_MOD_STRIP
1164
1165         If this variable is specified, will cause modules to be stripped
1166         after they are installed.  If INSTALL_MOD_STRIP is '1', then the
1167         default option --strip-debug will be used.  Otherwise,
1168         INSTALL_MOD_STRIP will used as the option(s) to the strip command.
1169
1170
1171 === 8 Makefile language
1172
1173 The kernel Makefiles are designed to be run with GNU Make.  The Makefiles
1174 use only the documented features of GNU Make, but they do use many
1175 GNU extensions.
1176
1177 GNU Make supports elementary list-processing functions.  The kernel
1178 Makefiles use a novel style of list building and manipulation with few
1179 "if" statements.
1180
1181 GNU Make has two assignment operators, ":=" and "=".  ":=" performs
1182 immediate evaluation of the right-hand side and stores an actual string
1183 into the left-hand side.  "=" is like a formula definition; it stores the
1184 right-hand side in an unevaluated form and then evaluates this form each
1185 time the left-hand side is used.
1186
1187 There are some cases where "=" is appropriate.  Usually, though, ":="
1188 is the right choice.
1189
1190 === 9 Credits
1191
1192 Original version made by Michael Elizabeth Chastain, <mailto:mec@shout.net>
1193 Updates by Kai Germaschewski <kai@tp1.ruhr-uni-bochum.de>
1194 Updates by Sam Ravnborg <sam@ravnborg.org>
1195 Language QA by Jan Engelhardt <jengelh@gmx.de>
1196
1197 === 10 TODO
1198
1199 - Describe how kbuild supports shipped files with _shipped.
1200 - Generating offset header files.
1201 - Add more variables to section 7?
1202
1203
1204