doc: mkimage: Rearrange/remove some options
This moves some options which work in any mode to the general options
section. -p is moved to after -E/-B since those options are related. This
also adds documentation for -h and -V.
The -F, -l, and -G options are documented twice. Remove the second
documentation in each case. The synopsis for -l also suggests an implied
second uimage-file-name parameter. E.g.
mkimage [-l uimage-file-name] uimage-file-name
This is misleading, so remove it. Wrap a few lines to 80 characters as
well.
Signed-off-by: Sean Anderson <seanga2@gmail.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
diff --git a/doc/mkimage.1 b/doc/mkimage.1
index 025ebc0..34c0c20 100644
--- a/doc/mkimage.1
+++ b/doc/mkimage.1
@@ -55,10 +55,20 @@
.SS General options
.
.TP
-.BI \-l " uimage-file-name"
-mkimage lists the information contained in the header of an existing U-Boot image.
+.B \-h
+Print a help message and exit.
.
.TP
+.B \-l
+mkimage lists the information contained in the header of an existing U-Boot
+image.
+.
+.TP
+.B \-s
+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"
Parse image file as type.
Pass \-h as the image to see the list of supported image type.
@@ -66,13 +76,22 @@
.
.TP
.B \-q
-Quiet. Don't print the image header on successful verification.
+Quiet. Don't print the image header.
+.
+.TP
+.B \-v
+Verbose. Print file names as they are added to the image.
+.
+.TP
+.B \-V
+Print version information and exit.
.
.SS General image-creation options
.
.TP
.BI \-A " architecture"
-Set architecture. Pass \-h as the architecture to see the list of supported architectures.
+Set architecture. Pass \-h as the architecture to see the list of supported
+architectures.
.
.TP
.BI \-O " os"
@@ -80,11 +99,6 @@
Pass \-h as the OS to see the list of supported OS.
.
.TP
-.BI \-T " image-type"
-Set image type.
-Pass \-h as the image to see the list of supported image type.
-.
-.TP
.BI \-C " compression-type"
Set compression type.
Pass \-h as the compression to see the list of supported compression type.
@@ -98,10 +112,6 @@
Set entry point with a hex number.
.
.TP
-.B \-l
-List the contents of an image.
-.
-.TP
.BI \-n " image-name"
Set image name to 'image name'.
.
@@ -142,15 +152,6 @@
.B \-x
Set XIP (execute in place) flag.
.
-.TP
-.B \-s
-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
-.B \-v
-Verbose. Print file names as they are added to the image.
-.
.SS Options for creating FIT images
.
.TP
@@ -183,6 +184,12 @@
option only has an effect when \-E is specified.
.
.TP
+.BI \-p " external-position"
+Place external data at a static external position. See \-E. Instead of writing
+a 'data-offset' property defining the offset from the end of the FIT, \-p will
+use 'data-position' as the absolute position from the base of the FIT.
+.
+.TP
.BI \-f " image-tree-source-file"
Image tree source file that describes the structure and contents of the
FIT image.
@@ -223,11 +230,6 @@
CONFIG_OF_CONTROL in U-Boot.
.
.TP
-.BI \-G " key-file"
-Specifies the private key file to use when signing. This option may be used
-instead of \-k.
-.
-.TP
.BI \-g " key-name-hint"
Sets the key-name-hint property when used with \-f auto. This is the <name>
part of the key. The directory part is set by \-k. This option also indicates
@@ -240,12 +242,6 @@
taken from the signature node's 'algo' property.
.
.TP
-.BI \-p " external-position"
-Place external data at a static external position. See \-E. Instead of writing
-a 'data-offset' property defining the offset from the end of the FIT, \-p will
-use 'data-position' as the absolute position from the base of the FIT.
-.
-.TP
.B \-r
Specifies that keys used to sign the FIT are required. This means that they
must be verified for the image to boot. Without this option, the verification