[PATCH v3 00/14] doc: mkimage: Rework and refactor the man page; add long options

[Sean Anderson]

This gives a facelift for the mkimage man page, bringing it in line with the
style perscribed by man-pages(7) and groff_man_style(7). I have tried to remove
typographical and grammatical errors and inconsistencies wherever possible. The
man page now both looks and feels closer to other Linux man pages. As a bonus, I
also added a man page for dumpimage in the same style.

To address the impending exhaustion of short options, this also adds long
options for each short option.

Changes in v3:
- Clarify intent in commit message
- Document option defaults
- Document the various content changes in the commit message
- Fix typo in commit message
- 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."
- Remove "legacy" wording from synopsis
- Remove usage of "legacy" in section headings
- Reorder "legacy" synopsis first
- Use multiple .BRs for the -f auto option list

Changes in v2:
- Add long options
- Better document multi images
- Document -h and -V
- Ensure comments are requests
- Escape minus signs in examples
- Fix -B not being bolded in the description for -R
- Fix extra quote in -E synopsis
- Fix spacing for -F
- Further document -o and -R
- Indent things more robustly
- Italicize parameter for -d
- Make lists of valid algos bold
- Rearrange more options
- Remove spaces around pipes
- Rename first subsection to "General options"
- Use escape-sequences for options width all three of B/I/R. This renders
  better with mandoc.
- Use paired quotation marks

Sean Anderson (14):
  doc: mkimage: Use standard style for synopsis
  doc: mkimage: Use empty request instead of blank lines
  doc: mkimage: Reformat examples
  doc: mkimage: Regularize option documentation
  doc: mkimage: Use subsection macro
  doc: mkimage: Rearrange/remove some options
  doc: mkimage: Use correct capitalization for NAME
  doc: mkimage: Edit options for style and consistency
  doc: mkimage: Add BUGS section
  doc: mkimage: Add SEE ALSO section
  doc: mkimage: Remove AUTHORS section
  mkimage: Add long options
  doc: mkimage: Further document -o and -R
  doc: Add man page for dumpimage

 doc/dumpimage.1 | 103 +++++
 doc/mkimage.1   | 977 +++++++++++++++++++++++++++++++++++-------------
 tools/mkimage.c |  45 ++-
 3 files changed, 854 insertions(+), 271 deletions(-)
 create mode 100644 doc/dumpimage.1

-- 
2.35.1