Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d87e47e1 authored by Cao jin's avatar Cao jin Committed by Masahiro Yamada
Browse files

kbuild doc: a bundle of fixes on makefiles.txt 



It does several fixes:
1. move the displaced ld example to its reasonable place.
2. add new example for command gzip.
3. fix 2 number errors.
4. fix format of chapter 7.x, make it looks the same as other chapters.

Signed-off-by: default avatarCao jin <caoj.fnst@cn.fujitsu.com>
Signed-off-by: default avatarMasahiro Yamada <yamada.masahiro@socionext.com>
parent bbfe63b6

Documentation/kbuild/makefiles.txt

+18 −13
Original line number Original line Diff line number Diff line
@@ -1108,14 +1108,6 @@ When kbuild executes, the following steps are followed (roughly): 
    ld

    ld

	Link target. Often, LDFLAGS_$@ is used to set specific options to ld.

	Link target. Often, LDFLAGS_$@ is used to set specific options to ld.





    objcopy

	Copy binary. Uses OBJCOPYFLAGS usually specified in

	arch/$(ARCH)/Makefile.

	OBJCOPYFLAGS_$@ may be used to set additional options.



    gzip

	Compress target. Use maximum compression to compress target.



	Example:

	Example:

		#arch/x86/boot/Makefile

		#arch/x86/boot/Makefile

		LDFLAGS_bootsect := -Ttext 0x0 -s --oformat binary

		LDFLAGS_bootsect := -Ttext 0x0 -s --oformat binary
@@ -1139,6 +1131,19 @@ When kbuild executes, the following steps are followed (roughly): 
	      resulting in the target file being recompiled for no

	      resulting in the target file being recompiled for no

	      obvious reason.

	      obvious reason.





    objcopy

	Copy binary. Uses OBJCOPYFLAGS usually specified in

	arch/$(ARCH)/Makefile.

	OBJCOPYFLAGS_$@ may be used to set additional options.



    gzip

	Compress target. Use maximum compression to compress target.



	Example:

		#arch/x86/boot/compressed/Makefile

		$(obj)/vmlinux.bin.gz: $(vmlinux.bin.all-y) FORCE

			$(call if_changed,gzip)



    dtc

    dtc

	Create flattened device tree blob object suitable for linking

	Create flattened device tree blob object suitable for linking

	into vmlinux. Device tree blobs linked into vmlinux are placed

	into vmlinux. Device tree blobs linked into vmlinux are placed
@@ -1219,7 +1224,7 @@ When kbuild executes, the following steps are followed (roughly): 
	that may be shared between individual architectures.

	that may be shared between individual architectures.

	The recommended approach how to use a generic header file is

	The recommended approach how to use a generic header file is

	to list the file in the Kbuild file.

	to list the file in the Kbuild file.

	See "7.3 generic-y" for further info on syntax etc.

	See "7.2 generic-y" for further info on syntax etc.





--- 6.11 Post-link pass

--- 6.11 Post-link pass
@@ -1299,7 +1304,7 @@ See subsequent chapter for the syntax of the Kbuild file. 
			#arch/x86/include/asm/Kbuild

			#arch/x86/include/asm/Kbuild

			generated-y += syscalls_32.h

			generated-y += syscalls_32.h





	--- 7.5 mandatory-y

--- 7.4 mandatory-y





	mandatory-y is essentially used by include/uapi/asm-generic/Kbuild.asm

	mandatory-y is essentially used by include/uapi/asm-generic/Kbuild.asm

	to define the minimum set of headers that must be exported in

	to define the minimum set of headers that must be exported in