diff mbox series

README: document output files

Message ID 20180228054316.27480-1-joel@jms.id.au
State Accepted
Headers show
Series README: document output files | expand

Commit Message

Joel Stanley Feb. 28, 2018, 5:43 a.m. UTC 
A grumpy BMC developer was wondering which file to flash to the machines
they were testing on. They longed for the old days where the answer was
'skiboot.lid'. Alas, those days are long past.

This updates the readme with a list of the current output formats and
where you might want to use them.

Signed-off-by: Joel Stanley <joel@jms.id.au>
---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

Comments

Joel Stanley Feb. 28, 2018, 5:45 a.m. UTC | #1 
On Wed, Feb 28, 2018 at 4:13 PM, Joel Stanley <joel@jms.id.au> wrote:
> A grumpy BMC developer was wondering which file to flash to the machines
> they were testing on. They longed for the old days where the answer was
> 'skiboot.lid'. Alas, those days are long past.
>
> This updates the readme with a list of the current output formats and
> where you might want to use them.
>
> Signed-off-by: Joel Stanley <joel@jms.id.au>
> ---
>  README.md | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
>
> diff --git a/README.md b/README.md
> index 8d4d9a37aed1..62f924cb6abe 100644
> --- a/README.md
> +++ b/README.md
> @@ -123,6 +123,25 @@ You probably want to read the linux
>  https://kernel.org/doc/html/latest/process/submitting-patches.html as
>  much of it applies to skiboot.
>
> +
> +## Output files
> +
> +The Skiboot build process produces a bunch of different outputs. This is what
> +they are, and where you should use them:
> +
> + skiboot.elf: The output of the linker. Don't flash to a system, but useful when debugging
> +
> + skiboot.lid: The raw binary object, named .lid because IBM. Flash this on
> +             really old P8 systems, the POWER Functional Simulator (mambo), or
> +             FSP systems
> +
> + skiboot.lid.stb: Lid wrapped with secure boot header. Use on FSP systems
> +
> + skiboot.lid.xz: Compressed raw binary. Use this on a OpenPower P8
> +
> + skiboot.lid.xz.stb: Compressed raw binary wrapped with a secure boot header.
> +                     Use this on OpenPower P8 systems

That should say "OpenPower P9 systems"

> +
>  ## License
>
>  See LICENSE
> --
> 2.15.1
>
Stewart Smith March 1, 2018, 4:12 a.m. UTC | #2 
Joel Stanley <joel@jms.id.au> writes:
> A grumpy BMC developer was wondering which file to flash to the machines
> they were testing on. They longed for the old days where the answer was
> 'skiboot.lid'. Alas, those days are long past.
>
> This updates the readme with a list of the current output formats and
> where you might want to use them.
>
> Signed-off-by: Joel Stanley <joel@jms.id.au>
> ---
>  README.md | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)

Cheers, good place to have it. Fixed the p8/p9 thing and merged to
master as of 0df891697d24cf2d9d42253d0a91a9d553b2ede3
diff mbox series

Patch

diff --git a/README.md b/README.md
index 8d4d9a37aed1..62f924cb6abe 100644
--- a/README.md
+++ b/README.md
@@ -123,6 +123,25 @@  You probably want to read the linux
 https://kernel.org/doc/html/latest/process/submitting-patches.html as
 much of it applies to skiboot.
 
+
+## Output files
+
+The Skiboot build process produces a bunch of different outputs. This is what
+they are, and where you should use them:
+
+ skiboot.elf: The output of the linker. Don't flash to a system, but useful when debugging
+
+ skiboot.lid: The raw binary object, named .lid because IBM. Flash this on
+	      really old P8 systems, the POWER Functional Simulator (mambo), or
+	      FSP systems
+
+ skiboot.lid.stb: Lid wrapped with secure boot header. Use on FSP systems
+
+ skiboot.lid.xz: Compressed raw binary. Use this on a OpenPower P8
+
+ skiboot.lid.xz.stb: Compressed raw binary wrapped with a secure boot header.
+                     Use this on OpenPower P8 systems
+
 ## License
 
 See LICENSE