u-boot.lists.denx.de archive mirror
 help / color / mirror / Atom feed
From: Sean Anderson <seanga2@gmail.com>
To: u-boot@lists.denx.de, Heinrich Schuchardt <xypron.glpk@gmx.de>
Cc: Simon Glass <sjg@chromium.org>, Sean Anderson <seanga2@gmail.com>
Subject: [PATCH v2 06/14] doc: mkimage: Rearrange/remove some options
Date: Sun, 12 Jun 2022 18:14:03 -0400	[thread overview]
Message-ID: <20220612221411.1608406-7-seanga2@gmail.com> (raw)
In-Reply-To: <20220612221411.1608406-1-seanga2@gmail.com>

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>
---

Changes in v2:
- Document -h and -V
- Rearrange more options

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

diff --git a/doc/mkimage.1 b/doc/mkimage.1
index 8b96011f90..6c649f6cbf 100644
--- a/doc/mkimage.1
+++ b/doc/mkimage.1
@@ -54,8 +54,18 @@ supports verified boot.
 .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"
@@ -65,13 +75,22 @@ Without this option image type is autodetected.
 .
 .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 Options for creating legacy or \(lqauto\(rq images
 .
 .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"
@@ -79,11 +98,6 @@ Set operating system. bootm command of u-boot changes boot method by os type.
 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.
@@ -97,10 +111,6 @@ Set load address with a hex number.
 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'.
 .
@@ -141,15 +151,6 @@ Use image data from 'image data file'.
 .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
@@ -182,6 +183,12 @@ 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"
+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.
@@ -222,11 +229,6 @@ verification. Typically the file here is the device tree binary used by
 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
@@ -239,12 +241,6 @@ Specifies the algorithm to be used for signing a FIT image. The default is
 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
-- 
2.35.1


  parent reply	other threads:[~2022-06-12 22:15 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-12 22:13 [PATCH v2 00/14] doc: mkimage: Rework and refactor the man page; add long options Sean Anderson
2022-06-12 22:13 ` [PATCH v2 01/14] doc: mkimage: Use standard style for synopsis Sean Anderson
2022-06-16  9:45   ` Heinrich Schuchardt
2022-06-16 13:40     ` Sean Anderson
2022-06-12 22:13 ` [PATCH v2 02/14] doc: mkimage: Use empty request instead of blank lines Sean Anderson
2022-06-12 22:14 ` [PATCH v2 03/14] doc: mkimage: Reformat examples Sean Anderson
2022-06-12 22:14 ` [PATCH v2 04/14] doc: mkimage: Regularize option documentation Sean Anderson
2022-06-16 10:00   ` Heinrich Schuchardt
2022-06-16 13:42     ` Sean Anderson
2022-06-12 22:14 ` [PATCH v2 05/14] doc: mkimage: Use subsection macro Sean Anderson
2022-06-16 10:08   ` Heinrich Schuchardt
2022-06-16 13:45     ` Sean Anderson
2022-06-12 22:14 ` Sean Anderson [this message]
2022-06-12 22:14 ` [PATCH v2 07/14] doc: mkimage: Use correct capitalization for NAME Sean Anderson
2022-06-12 22:14 ` [PATCH v2 08/14] doc: mkimage: Edit options for style and consistency Sean Anderson
2022-06-12 22:14 ` [PATCH v2 09/14] doc: mkimage: Add BUGS section Sean Anderson
2022-06-12 22:14 ` [PATCH v2 10/14] doc: mkimage: Add SEE ALSO section Sean Anderson
2022-06-12 22:14 ` [PATCH v2 11/14] doc: mkimage: Remove AUTHORS section Sean Anderson
2022-06-12 22:14 ` [PATCH v2 12/14] mkimage: Add long options Sean Anderson
2022-06-12 22:14 ` [PATCH v2 13/14] doc: mkimage: Further document -o and -R Sean Anderson
2022-06-12 22:14 ` [PATCH v2 14/14] doc: Add man page for dumpimage Sean Anderson
2022-06-16 11:50   ` Heinrich Schuchardt
2022-06-16 13:47     ` Sean Anderson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220612221411.1608406-7-seanga2@gmail.com \
    --to=seanga2@gmail.com \
    --cc=sjg@chromium.org \
    --cc=u-boot@lists.denx.de \
    --cc=xypron.glpk@gmx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).