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 00/12] doc: mkimage: Rework and refactor the man page
Date: Sun, 12 Jun 2022 00:19:47 -0400 [thread overview]
Message-ID: <20220612041959.1538628-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.
Sean Anderson (12):
doc: mkimage: Use standard style for synopsis
doc: mkimage: Use empty request instead of blank lines
doc: mkimage: Add vertical/horizontal space to examples
doc: mkimage: Regularize option documentation
doc: mkimage: Use subsection macro
doc: mkimage: Remove duplicate docs for -l
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
doc: Add man page for dumpimage
doc/dumpimage.1 | 103 ++++++++++
doc/mkimage.1 | 509 ++++++++++++++++++++++++++++++------------------
2 files changed, 425 insertions(+), 187 deletions(-)
create mode 100644 doc/dumpimage.1
--
2.35.1
next reply other threads:[~2022-06-12 4:20 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-12 4:19 Sean Anderson [this message]
2022-06-12 4:19 ` [PATCH 01/12] doc: mkimage: Use standard style for synopsis Sean Anderson
2022-06-12 4:41 ` Sean Anderson
2022-06-12 4:19 ` [PATCH 02/12] doc: mkimage: Use empty request instead of blank lines Sean Anderson
2022-06-12 4:19 ` [PATCH 03/12] doc: mkimage: Add vertical/horizontal space to examples Sean Anderson
2022-06-12 4:19 ` [PATCH 04/12] doc: mkimage: Regularize option documentation Sean Anderson
2022-06-12 4:19 ` [PATCH 05/12] doc: mkimage: Use subsection macro Sean Anderson
2022-06-12 4:19 ` [PATCH 06/12] doc: mkimage: Remove duplicate docs for -l Sean Anderson
2022-06-12 4:19 ` [PATCH 07/12] doc: mkimage: Use correct capitalization for NAME Sean Anderson
2022-06-12 4:19 ` [PATCH 08/12] doc: mkimage: Edit options for style and consistency Sean Anderson
2022-06-12 4:19 ` [PATCH 09/12] doc: mkimage: Add BUGS section Sean Anderson
2022-06-12 4:19 ` [PATCH 10/12] doc: mkimage: Add SEE ALSO section Sean Anderson
2022-06-12 4:19 ` [PATCH 11/12] doc: mkimage: Remove AUTHORS section Sean Anderson
2022-06-12 4:19 ` [PATCH 12/12] doc: Add man page for dumpimage 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=20220612041959.1538628-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.