diff mbox series

[v3,1/2] mkimage: Document more misc options

Message ID 20220516201108.4070444-1-sean.anderson@seco.com
State Accepted
Commit 5920e5c838d1b6647878e51c0b9b8c9e4eaf1928
Delegated to: Tom Rini
Headers show
Series [v3,1/2] mkimage: Document more misc options | expand

Commit Message

Sean Anderson May 16, 2022, 8:11 p.m. UTC
Document -G and the secondary image types which can be used with -R.
Also reword the documentation of -s for clarity.

Signed-off-by: Sean Anderson <sean.anderson@seco.com>
---

Changes in v3:
- Rebased onto u-boot/master, as v1 was applied instead of v2
- Reworded commit message to reflect this

Changes in v2:
- Document secondary image types
- Move -G directly after -k
- Reword documentation for -s

 doc/mkimage.1 | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

Comments

Tom Rini June 7, 2022, 4:46 p.m. UTC | #1
On Mon, May 16, 2022 at 04:11:07PM -0400, Sean Anderson wrote:

> Document -G and the secondary image types which can be used with -R.
> Also reword the documentation of -s for clarity.
> 
> Signed-off-by: Sean Anderson <sean.anderson@seco.com>

Applied to u-boot/next, thanks!
diff mbox series

Patch

diff --git a/doc/mkimage.1 b/doc/mkimage.1
index c92e133732..878db90475 100644
--- a/doc/mkimage.1
+++ b/doc/mkimage.1
@@ -99,6 +99,30 @@  Set image name to 'image name'.
 .BI "\-R [" "secondary image name" "]"
 Some image types support a second image for additional data. For these types,
 use \-R to specify this second image.
+.TS
+allbox;
+lb lbx
+l l.
+Image Type	Secondary Image Description
+pblimage	Additional RCW-style header, typically used for PBI commands.
+zynqimage, zynqmpimage	T{
+Initialization parameters, one per line. Each parameter has the form
+.sp
+.ti 4
+.I address data
+.sp
+where
+.I address
+and
+.I data
+are hexadecimal integers. The boot ROM will write each
+.I data
+to
+.I address
+when loading the image. At most 256 parameters may be specified in this
+manner.
+T}
+.TE
 
 .TP
 .BI "\-d [" "image data file" "]"
@@ -110,8 +134,8 @@  Set XIP (execute in place) flag.
 
 .TP
 .BI "\-s"
-Create an image with no data. The header will be created, but the image itself
-will not contain data (such as U-Boot or any specified kernel).
+Don't copy in the image data. Depending on the image type, this may create
+just the header, everything but the image data, or nothing at all.
 
 .TP
 .BI "\-v"
@@ -176,6 +200,11 @@  Specifies the directory containing keys to use for signing. This directory
 should contain a private key file <name>.key for use with signing and a
 certificate <name>.crt (containing the public key) for use with verification.
 
+.TP
+.BI "\-G [" "key_file" "]"
+Specifies the private key file to use when signing. This option may be used
+instead of \-k.
+
 .TP
 .BI "\-K [" "key_destination" "]"
 Specifies a compiled device tree binary file (typically .dtb) to write