The mkimage command has had many options added over the years.
Unfortunately, we are starting to run out of short options. Recent options
don't have any obvious relation to their meaning (e.g. -o/-g). Fortunately,
long options exist. Add long options for each current short option.
For the curious, the remaining short options are HIkLmMPQSuUwWXyYzZ.
Signed-off-by: Sean Anderson
---
(no changes since v2)
Changes in v2:
- New
doc/mkimage.1 | 66 +
tools/mkimage.c | 45 +++--
2 files changed, 109 insertions(+), 2 deletions(-)
diff --git a/doc/mkimage.1 b/doc/mkimage.1
index 8419fa45a9..c310b01bb9 100644
--- a/doc/mkimage.1
+++ b/doc/mkimage.1
@@ -60,20 +60,28 @@ checksums. It also supports verified boot.
.
.TP
.B \-h
+.TQ
+.B \-\-help
Print a help message and exit.
.
.TP
.B \-l
+.TQ
+.B \-\-list
.B mkimage
lists the information contained in the header of an existing U-Boot image.
.
.TP
.B \-s
+.TQ
+.B \-\-no\-copy
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 \-T " image-type"
+.TQ
+.BI \-\-type " image-type"
Parse image file as
.IR image-type .
Pass
@@ -105,20 +113,28 @@ is absent, then the \(oqtype\(cq property will default to
.
.TP
.B \-q
+.TQ
+.B \-\-quiet
Quiet. Don't print the image header.
.
.TP
.B \-v
+.TQ
+.B \-\-verbose
Verbose. Print file names as they are added to the image.
.
.TP
.B \-V
+.TQ
+.B \-\-version
Print version information and exit.
.
.SS General image-creation options
.
.TP
.BI \-A " architecture"
+.TQ
+.BI \-\-architecture " architecture"
Set the architecture. Pass
.B \-h
as the architecture to see the list of supported architectures. If
@@ -128,6 +144,8 @@ is absent, it defaults to
.
.TP
.BI \-O " os"
+.TQ
+.BI \-\-os " os"
Set the operating system. The U-Boot
.I bootm
command changes boot method based on the OS type.
@@ -142,6 +160,8 @@ is absent, it defaults to
.
.TP
.BI \-C " compression-type"
+.TQ
+.BI \-\-compression " compression-type"
Set the compression type. The image data should have already been compressed
using this compression type.
.B mkimage
@@ -157,12 +177,16 @@ is absent, it defaults to
.
.TP
.BI \-a " load-address"
+.TQ
+.BI \-\-load\-address " load-address"
Set the absolute address to load the image data to.
.I load-address
will be interpreted as a hexadecimal number.
.
.TP
.BI \-e " entry-point"
+.TQ
+.BI \-\-entry\-point " entry-point"
Set the absolute address of the image entry point. The U-Boot
.I bootm
command will jump to this address after loading the image.
@@ -171,11 +195,15 @@ will be interpreted as a hexadecimal number.
.
.TP
.BI \-n " image-name"
+.TQ
+.BI \-\-primary\-image " image-name"
Set the image name to
.IR image-name .
.
.TP
.BI \-R " secondary-image-name"
+.TQ
+.BI \-\-secondary\-image " image-name"
Some image types support a second image for additional data. For these types,
use
.B \-R
@@ -207,6 +235,8 @@ T}
.
.TP
.BI \-d " image-data-file"
+.TQ
+.BI \-\-image " image-data-file"
Use image data from
.IR image-data-file .
If the
@@ -221,6 +251,8 @@ then multiple images may be specified, separated by colons:
.
.TP
.B \-x
+.TQ
+.B \-\-xip
Set the
.I XIP
(execute in place) flag. The U-Boot
@@ -232,15 +264,21 @@ accessible at the load address (such as via memory-mapped
flash).
.
.TP
.BI \-b " device-tree-file"
+.TQ
+.BI \-\-device\-tree " device-tree-file"
Appends the device tree binary file (.dtb) to the FIT.
.
.TP
.BI \-c " comment"
+.TQ
+.BI \-\-comment " comment"
Specifies a comment to be added when signing. This is typically a message which
describes how the image was signed or some other useful information.
.
.TP
.BI \-D " dtc-options"
+.TQ
+.BI \-\-dtcopts " dtc-options"
Provide additional options to the device tree compiler when creating the image.
See
.BR dtc (1)
@@ -251,6 +289,8 @@ is absent, it defaults to
.
.TP
.BI \-E
+.TQ
+.BI \-\-external
After processing, move the image data outside the FIT and store a data offset
in the FIT. Images will be placed one after the other immediately after the
FIT,
with each one aligned to a 4-byte boundary. The existing \(oqdata\(cq property
@@ -260,11 +300,15 @@ properties. A \(oqdata-offset\(cq of 0 indicates that it
starts in the first
.
.TP
.BI \-B " alignment"
+.TQ
+.BI \-\-alignment " alignment"
The alignment, in hexadecimal, that external data will be aligned to. This
option only has an effect when \-E is specified.
.
.TP
.BI \-p " external-position"
+.TQ
+.BI \-\-position " external-position"
Place external data at a static external position. Instead of writing a
\(oqdata-offset\(cq property defining the offset from the end of the FIT,
.B \-p
@@ -275,6 +319,8 @@ for details on using external data.
.
.TP
\fB\-f \fIimage-tree-source-file\fR | \fBauto
+.TQ
+\fB\-\-fit
