[PATCH 03/12] doc: mkimage: Add vertical/horizontal space to examples

Sean Anderson seanga2 at gmail.com
Sun Jun 12 06:19:50 CEST 2022


This puts each example in a new paragraph and uses a hanging indent for
continued lines to increase clarity.

Signed-off-by: Sean Anderson <seanga2 at gmail.com>
---

 doc/mkimage.1 | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/doc/mkimage.1 b/doc/mkimage.1
index 5ae3d92508..b9ca416101 100644
--- a/doc/mkimage.1
+++ b/doc/mkimage.1
@@ -269,76 +269,111 @@ using the -f flag. But if the original input to mkimage is a binary file
 .SH EXAMPLES
 .
 List image information:
+.P
 .nf
+.in +4n
 .B mkimage -l uImage
 .fi
+.in
 .P
 Create legacy image with compressed PowerPC Linux kernel:
+.P
 .nf
+.in +4n
 .B mkimage -A powerpc -O linux -T kernel -C gzip \\\\
 .br
+.in +4n
 .B -a 0 -e 0 -n Linux -d vmlinux.gz uImage
 .fi
+.in
 .P
 Create FIT image with compressed PowerPC Linux kernel:
+.P
 .nf
+.in +4n
 .B mkimage -f kernel.its kernel.itb
 .fi
+.in
 .P
 Create FIT image with compressed kernel and sign it with keys in the
 /public/signing-keys directory. Add corresponding public keys into u-boot.dtb,
 skipping those for which keys cannot be found. Also add a comment.
+.P
 .nf
+.in +4n
 .B mkimage -f kernel.its -k /public/signing-keys -K u-boot.dtb \\\\
 .br
+.in +4n
 .B -c """Kernel 3.8 image for production devices""" kernel.itb
 .fi
+.in
 .
 .P
 Add public keys to u-boot.dtb without needing a FIT to sign. This will also
 create a FIT containing an images node with no data named unused.itb.
+.P
 .nf
+.in +4n
 .B mkimage -f auto -d /dev/null -k /public/signing-keys -g dev \\\\
 .br
+.in +4n
 .B -o sha256,rsa2048 -K u-boot.dtb unused.itb
 .fi
+.in
 .
 .P
 Update an existing FIT image, signing it with additional keys.
 Add corresponding public keys into u-boot.dtb. This will resign all images
 with keys that are available in the new directory. Images that request signing
 with unavailable keys are skipped.
+.P
 .nf
+.in +4n
 .B mkimage -F -k /secret/signing-keys -K u-boot.dtb \\\\
 .br
+.in +4n
 .B -c """Kernel 3.8 image for production devices""" kernel.itb
 .fi
+.in
 .
 .P
 Create a FIT image containing a kernel, using automatic mode. No .its file
 is required.
+.P
 .nf
+.in +4n
 .B mkimage -f auto -A arm -O linux -T kernel -C none -a 43e00000 -e 0 \\\\
 .br
+.in +4n
 .B -c """Kernel 4.4 image for production devices""" -d vmlinuz kernel.itb
 .fi
+.in
 .P
 Create a FIT image containing a kernel and some device tree files, using
 automatic mode. No .its file is required.
+.P
 .nf
+.in +4n
 .B mkimage -f auto -A arm -O linux -T kernel -C none -a 43e00000 -e 0 \\\\
 .br
+.in +4n
 .B -c """Kernel 4.4 image for production devices""" -d vmlinuz \\\\
+.br
 .B -b /path/to/rk3288-firefly.dtb -b /path/to/rk3288-jerry.dtb kernel.itb
 .fi
+.in
 .P
 Create a FIT image containing a signed kernel, using automatic mode. No .its
 file is required.
+.P
 .nf
+.in +4n
 .B mkimage -f auto -A arm -O linux -T kernel -C none -a 43e00000 -e 0 \\\\
 .br
+.in +4n
 .B -d vmlinuz -k /secret/signing-keys -g dev -o sha256,rsa2048 kernel.itb
 .fi
+.in
 .
 .SH HOMEPAGE
 http://www.denx.de/wiki/U-Boot/WebHome
-- 
2.35.1



More information about the U-Boot mailing list