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 00/14] doc: mkimage: Rework and refactor the man page; add long options
Date: Sun, 12 Jun 2022 18:13:57 -0400	[thread overview]
Message-ID: <20220612221411.1608406-1-seanga2@gmail.com> (raw)

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 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   | 933 ++++++++++++++++++++++++++++++++++--------------
 tools/mkimage.c |  45 ++-
 3 files changed, 811 insertions(+), 270 deletions(-)
 create mode 100644 doc/dumpimage.1

-- 
2.35.1


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

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-12 22:13 Sean Anderson [this message]
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 ` [PATCH v2 06/14] doc: mkimage: Rearrange/remove some options Sean Anderson
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-1-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).