[PATCH v2 05/14] doc: mkimage: Use subsection macro

[Heinrich Schuchardt]

On 6/13/22 00:14, Sean Anderson wrote:
> The options are divided up into several subsections. Use the appropriate
> macro. While we're at it, rename the headings to better reflect the
> contents of their sections.
>
> Signed-off-by: Sean Anderson <seanga2 at gmail.com>
> ---
>
> Changes in v2:
> - Rename first subsection to "General options"
> - Use paired quotation marks
>
>   doc/mkimage.1 | 8 +++-----
>   1 file changed, 3 insertions(+), 5 deletions(-)
>
> diff --git a/doc/mkimage.1 b/doc/mkimage.1
> index 4074715fe5..8b96011f90 100644
> --- a/doc/mkimage.1
> +++ b/doc/mkimage.1
> @@ -51,7 +51,7 @@ supports verified boot.
>   .
>   .SH OPTIONS
>   .
> -.B List image information:
> +.SS General options
>   .
>   .TP
>   .BI \-l " uimage-file-name"
> @@ -67,8 +67,7 @@ Without this option image type is autodetected.
>   .B \-q
>   Quiet. Don't print the image header on successful verification.
>   .
> -.P
> -.B Create old legacy image:
> +.SS Options for creating legacy or \(lqauto\(rq images
An image type (IH_TYPE_SUNXI_TOC0) introduced in 2022 cannot be legacy.
Please, remove this misleading and derogatory term. I guess you mean
anything but FIT. Should the whole paragraph be move down below the
descriptions of the creation of FIT images? Then you could say "Options
for creating other image types".

I have no clue what an "auto" image might refer to. The man-page is not
of any help here.

Best regards

Heinrich

>   .
>   .TP
>   .BI \-A " architecture"
> @@ -151,8 +150,7 @@ just the header, everything but the image data, or nothing at all.
>   .B \-v
>   Verbose. Print file names as they are added to the image.
>   .
> -.P
> -.B Create FIT image:
> +.SS Options for creating FIT images
>   .
>   .TP
>   .BI \-b " device-tree-file"