[PATCH v3 08/14] doc: mkimage: Edit options for style and consistency

[Simon Glass]

On Sat, 25 Jun 2022 at 11:12, Sean Anderson <seanga2 at gmail.com> wrote:
>
> This makes a variety of changes for the options to make them
> typographically consistent, clarify their meaning, and fix grammatical (or
> other) errors. Many of the changes here are stylistic, though there are a
> few fixes. The main changes I made across the board were:
>
> - All options are bolded and parameters italicised
> - All single quotes are properly matched (instead of using apostrophes)
> - Minor background info has been added to clarify many underdocumented
>   options
> - Default values for options are documented
>
> Signed-off-by: Sean Anderson <seanga2 at gmail.com>
> ---
>
> Changes in v3:
> - Document option defaults
> - Note that "legacy" images are only legacy for U-Boot. In particular, mkimage
>   supports many other image formats using the same syntax which are decidedly
>   not "legacy."
> - Use multiple .BRs for the -f auto option list
>
> Changes in v2:
> - Better document multi images
> - Fix -B not being bolded in the description for -R
> - Italicize parameter for -d
> - Make lists of valid algos bold
> - Remove spaces around pipes
> - Use escape-sequences for options width all three of B/I/R. This renders
>   better with mandoc.
>
>  doc/mkimage.1 | 273 +++++++++++++++++++++++++++++++++++++-------------
>  1 file changed, 205 insertions(+), 68 deletions(-)

Reviewed-by: Simon Glass <sjg at chromium.org>