qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Michael Tokarev <mjt@tls.msk.ru>
To: qemu-devel@nongnu.org
Cc: Michael Tokarev <mjt@tls.msk.ru>, qemu-block@nongnu.org
Subject: [PATCH v3 00/27] qemu-img: refersh options and --help handling, cleanups
Date: Wed, 24 Apr 2024 11:50:08 +0300	[thread overview]
Message-ID: <cover.1713948448.git.mjt@tls.msk.ru> (raw)

Quite big patchset trying to implement normal, readable qemu-img --help
(and qemu-img COMMAND --help) output with readable descriptions, and
adding many long options in the process.

In the end I stopped using qemu-img-opts.hx in qemu-img.c, perhaps
this can be avoided, with only list of commands and their desrciptions
kept there, but I don't see big advantage here.  The same list should
be included in docs/tools/qemu-img.rst, - this is not done now.

Also each command syntax isn't reflected in the doc for now, because
I want to give good names for options first, - and there, we've quite
some inconsistences and questions.  For example, measure --output=OFMT
-O OFMT, - this is priceless :)  I've no idea why we have this ugly
--output=json thing, why not have --json? ;)  I gave the desired
format long name --target-format to avoid clash with --output.

For rebase, src vs tgt probably should be renamed in local variables
too, and I'm not even sure I've got the caches right. For caches,
the thing is inconsistent across commands.

For compare, I used --a-format/--b-format (for -f/-F), - this can
be made --souce-format and --target-format, to compare source (file1)
with target (file2).

For bitmap, things are scary, I'm not sure what -b SRC_FILENAME
really means, - for now I gave it --source option, but this does
not make it more clear, suggestions welcome.

There are many other inconsistencies, I can't fix them all in one go.

Changes since v2:

 - added Dan's R-Bs
 - refined couple cvtnum conversions
 - dropped "stop printing error twice in a few places"

Michael Tokarev (27):
  qemu-img: measure: convert img_size to signed, simplify handling
  qemu-img: create: convert img_size to signed, simplify handling
  qemu-img: global option processing and error printing
  qemu-img: pass current cmd info into command handlers
  qemu-img: create: refresh options/--help
  qemu-img: factor out parse_output_format() and use it in the code
  qemu-img: check: refresh options/--help
  qemu-img: simplify --repair error message
  qemu-img: commit: refresh options/--help
  qemu-img: compare: refresh options/--help
  qemu-img: convert: refresh options/--help
  qemu-img: info: refresh options/--help
  qemu-img: map: refresh options/--help
  qemu-img: snapshot: allow specifying -f fmt
  qemu-img: snapshot: make -l (list) the default, simplify option
    handling
  qemu-img: snapshot: refresh options/--help
  qemu-img: rebase: refresh options/--help
  qemu-img: resize: do not always eat last argument
  qemu-img: resize: refresh options/--help
  qemu-img: amend: refresh options/--help
  qemu-img: bench: refresh options/--help
  qemu-img: bitmap: refresh options/--help
  qemu-img: dd: refresh options/--help
  qemu-img: measure: refresh options/--help
  qemu-img: implement short --help, remove global help() function
  qemu-img: inline list of supported commands, remove qemu-img-cmds.h
    include
  qemu-img: extend cvtnum() and use it in more places

 docs/tools/qemu-img.rst    |    4 +-
 qemu-img-cmds.hx           |    4 +-
 qemu-img.c                 | 1311 ++++++++++++++++++++++--------------
 tests/qemu-iotests/049.out |    9 +-
 4 files changed, 821 insertions(+), 507 deletions(-)

-- 
2.39.2



             reply	other threads:[~2024-04-24  8:51 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-24  8:50 Michael Tokarev [this message]
2024-04-24  8:50 ` [PATCH 01/27] qemu-img: measure: convert img_size to signed, simplify handling Michael Tokarev
2024-04-24  8:50 ` [PATCH 02/27] qemu-img: create: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 03/27] qemu-img: global option processing and error printing Michael Tokarev
2024-04-24  8:50 ` [PATCH 04/27] qemu-img: pass current cmd info into command handlers Michael Tokarev
2024-04-24  8:50 ` [PATCH 05/27] qemu-img: create: refresh options/--help Michael Tokarev
2024-04-24  8:50 ` [PATCH 06/27] qemu-img: factor out parse_output_format() and use it in the code Michael Tokarev
2024-04-24  8:50 ` [PATCH 07/27] qemu-img: check: refresh options/--help Michael Tokarev
2024-04-24  8:50 ` [PATCH 08/27] qemu-img: simplify --repair error message Michael Tokarev
2024-04-24  8:50 ` [PATCH 09/27] qemu-img: commit: refresh options/--help Michael Tokarev
2024-04-24  8:50 ` [PATCH 10/27] qemu-img: compare: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 11/27] qemu-img: convert: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 12/27] qemu-img: info: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 13/27] qemu-img: map: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 14/27] qemu-img: snapshot: allow specifying -f fmt Michael Tokarev
2024-04-24  8:50 ` [PATCH 15/27] qemu-img: snapshot: make -l (list) the default, simplify option handling Michael Tokarev
2024-04-24  8:50 ` [PATCH 16/27] qemu-img: snapshot: refresh options/--help Michael Tokarev
2024-04-24  8:50 ` [PATCH 17/27] qemu-img: rebase: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 18/27] qemu-img: resize: do not always eat last argument Michael Tokarev
2024-04-24  8:50 ` [PATCH 19/27] qemu-img: resize: refresh options/--help Michael Tokarev
2024-04-24  8:50 ` [PATCH 20/27] qemu-img: amend: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 21/27] qemu-img: bench: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 22/27] qemu-img: bitmap: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 23/27] qemu-img: dd: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 24/27] qemu-img: measure: " Michael Tokarev
2024-04-24  8:50 ` [PATCH 25/27] qemu-img: implement short --help, remove global help() function Michael Tokarev
2024-04-24  8:50 ` [PATCH 26/27] qemu-img: inline list of supported commands, remove qemu-img-cmds.h include Michael Tokarev
2024-04-24  8:50 ` [PATCH 27/27] qemu-img: extend cvtnum() and use it in more places Michael Tokarev
2024-05-31 15:11 ` [PATCH v3 00/27] qemu-img: refersh options and --help handling, cleanups Michael Tokarev
2024-07-16 21:28 ` Michael Tokarev

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=cover.1713948448.git.mjt@tls.msk.ru \
    --to=mjt@tls.msk.ru \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    /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).