[PATCH] x86, boot: document intermediates more clearly

[PATCH] x86, boot: document intermediates more clearly

[Kees Cook]

This adds a comment detailing the various intermediate files used to build
the bootable decompression image for the x86 kernel.

Signed-off-by: Kees Cook <keescook@chromium.org>
---
 arch/x86/boot/compressed/Makefile | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/arch/x86/boot/compressed/Makefile b/arch/x86/boot/compressed/Makefile
index be1e07d4b596..44a866b85c6f 100644
--- a/arch/x86/boot/compressed/Makefile
+++ b/arch/x86/boot/compressed/Makefile
@@ -3,6 +3,18 @@
 #
 # create a compressed vmlinux image from the original vmlinux
 #
+# vmlinuz is:
+#	decompression code (*.o)
+#	asm globals (piggy.S), including:
+#		vmlinux.bin.(gz|bz2|lzma|...)
+#
+# vmlinux.bin is:
+#	vmlinux stripped of debugging and comments
+# vmlinux.bin.all is:
+#	vmlinux.bin + vmlinux.relocs
+# vmlinux.bin.(gz|bz2|lzma|...) is:
+#	(see scripts/Makefile.lib size_append)
+#	compressed vmlinux.bin.all + u32 size of vmlinux.bin.all
 
 targets := vmlinux vmlinux.bin vmlinux.bin.gz vmlinux.bin.bz2 vmlinux.bin.lzma \
 	vmlinux.bin.xz vmlinux.bin.lzo vmlinux.bin.lz4
-- 
1.9.1


-- 
Kees Cook
Chrome OS Security

Re: [PATCH] x86, boot: document intermediates more clearly

[josh]

On Fri, Oct 31, 2014 at 09:22:04AM -0700, Kees Cook wrote:
> This adds a comment detailing the various intermediate files used to build
> the bootable decompression image for the x86 kernel.
> 
> Signed-off-by: Kees Cook <keescook@chromium.org>

Definitely the documentation I wish I had long ago when trying to figure
out the twisty maze of binaries.

Reviewed-by: Josh Triplett <josh@joshtriplett.org>

>  arch/x86/boot/compressed/Makefile | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/arch/x86/boot/compressed/Makefile b/arch/x86/boot/compressed/Makefile
> index be1e07d4b596..44a866b85c6f 100644
> --- a/arch/x86/boot/compressed/Makefile
> +++ b/arch/x86/boot/compressed/Makefile
> @@ -3,6 +3,18 @@
>  #
>  # create a compressed vmlinux image from the original vmlinux
>  #
> +# vmlinuz is:
> +#	decompression code (*.o)
> +#	asm globals (piggy.S), including:
> +#		vmlinux.bin.(gz|bz2|lzma|...)
> +#
> +# vmlinux.bin is:
> +#	vmlinux stripped of debugging and comments
> +# vmlinux.bin.all is:
> +#	vmlinux.bin + vmlinux.relocs
> +# vmlinux.bin.(gz|bz2|lzma|...) is:
> +#	(see scripts/Makefile.lib size_append)
> +#	compressed vmlinux.bin.all + u32 size of vmlinux.bin.all
>  
>  targets := vmlinux vmlinux.bin vmlinux.bin.gz vmlinux.bin.bz2 vmlinux.bin.lzma \
>  	vmlinux.bin.xz vmlinux.bin.lzo vmlinux.bin.lz4
> -- 
> 1.9.1
> 
> 
> -- 
> Kees Cook
> Chrome OS Security

[tip:x86/boot] x86, boot: Document intermediates more clearly

[tip-bot for Kees Cook]

Commit-ID:  fb7183ef3c016d9067ff83f3ff2455be1818f902
Gitweb:     http://git.kernel.org/tip/fb7183ef3c016d9067ff83f3ff2455be1818f902
Author:     Kees Cook <keescook@chromium.org>
AuthorDate: Fri, 31 Oct 2014 09:22:04 -0700
Committer:  Thomas Gleixner <tglx@linutronix.de>
CommitDate: Sat, 1 Nov 2014 22:46:02 +0100

x86, boot: Document intermediates more clearly

This adds a comment detailing the various intermediate files used to build
the bootable decompression image for the x86 kernel.

Signed-off-by: Kees Cook <keescook@chromium.org>
Reviewed-by: Josh Triplett <josh@joshtriplett.org>
Cc: Matt Fleming <matt.fleming@intel.com>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Junjie Mao <eternal.n08@gmail.com>
Link: http://lkml.kernel.org/r/20141031162204.GA26268@www.outflux.net
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
---
 arch/x86/boot/compressed/Makefile | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/arch/x86/boot/compressed/Makefile b/arch/x86/boot/compressed/Makefile
index 704f58a..8a39181 100644
--- a/arch/x86/boot/compressed/Makefile
+++ b/arch/x86/boot/compressed/Makefile
@@ -3,6 +3,18 @@
 #
 # create a compressed vmlinux image from the original vmlinux
 #
+# vmlinuz is:
+#	decompression code (*.o)
+#	asm globals (piggy.S), including:
+#		vmlinux.bin.(gz|bz2|lzma|...)
+#
+# vmlinux.bin is:
+#	vmlinux stripped of debugging and comments
+# vmlinux.bin.all is:
+#	vmlinux.bin + vmlinux.relocs
+# vmlinux.bin.(gz|bz2|lzma|...) is:
+#	(see scripts/Makefile.lib size_append)
+#	compressed vmlinux.bin.all + u32 size of vmlinux.bin.all
 
 targets := vmlinux vmlinux.bin vmlinux.bin.gz vmlinux.bin.bz2 vmlinux.bin.lzma \
 	vmlinux.bin.xz vmlinux.bin.lzo vmlinux.bin.lz4