[coreboot-gerrit] Change in coreboot[master]: Documentation: Improve payload fit

[Patrick Rudolph (Code Review)]

Patrick Rudolph has uploaded this change for review. ( https://review.coreboot.org/29319


Change subject: Documentation: Improve payload fit
......................................................................

Documentation: Improve payload fit

* Convert '' to `
* Add example how to use mkimage

Change-Id: Id83db3db51582cb0d6ded7f3152b5549fba1f2e7
Signed-off-by: Patrick Rudolph <siro at das-labor.org>
---
M Documentation/lib/payloads/fit.md
1 file changed, 16 insertions(+), 5 deletions(-)



  git pull ssh://review.coreboot.org:29418/coreboot refs/changes/19/29319/1

diff --git a/Documentation/lib/payloads/fit.md b/Documentation/lib/payloads/fit.md
index ac7b3e6..53be92e 100644
--- a/Documentation/lib/payloads/fit.md
+++ b/Documentation/lib/payloads/fit.md
@@ -25,7 +25,7 @@
 
 The FIT parser needs architecure support.
 ### aarch64
-The source code can be found in ''src/arch/arm64/fit.c''.
+The source code can be found in `src/arch/arm64/fit.c`.
 
 On aarch64 the kernel (a section named 'kernel') must be in **Image**
 format and it needs a devicetree (a section named 'fdt') to boot.
@@ -83,7 +83,7 @@
 
 ## Building FIT image
 
-The FIT image has to be built by calling ''mkimage''. You can use
+The FIT image has to be built by calling `mkimage`. You can use
 the following example configuration:
 
 ```
@@ -148,9 +148,20 @@
 };
 ```
 
-It includes a compressed initrd **initramfs.cpio.xz**, which will be
-decompressed by the Linux kernel, a compressed kernel **Image.lzma**, which will
-be decompressed by the FIT loader and an uncompressed devicetree blob.
+Save it as ITS file `config.its` along with the other files defined here:
+* target.dtb
+* initramfs.cpio.xz
+* Image.lzma
+
+Generate the `uImage` that will be included into the CBFS by calling
+
+```bash
+mkimage -f config.its uImage
+```
+
+The generated file includes a compressed initrd **initramfs.cpio.xz**, which
+will be decompressed by the Linux kernel, a compressed kernel **Image.lzma**,
+which will be decompressed by the FIT loader and an uncompressed devicetree blob.
 
 [uImage.FIT]: https://raw.githubusercontent.com/u-boot/u-boot/master/doc/uImage.FIT/howto.txt
 [U-Boot]: https://www.denx.de/wiki/U-Boot

-- 
To view, visit https://review.coreboot.org/29319
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings

Gerrit-Project: coreboot
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: Id83db3db51582cb0d6ded7f3152b5549fba1f2e7
Gerrit-Change-Number: 29319
Gerrit-PatchSet: 1
Gerrit-Owner: Patrick Rudolph <siro at das-labor.org>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.coreboot.org/pipermail/coreboot-gerrit/attachments/20181029/dbf62df2/attachment.html>