20.02.2024 21:48, Daniel P. Berrangé:
...
$ ./build/qemu-img check --help
Check basic image integrity.
Usage:
qemu-img check [-f FMT | --image-opts] [-T CACHE_MODE] [-r] [-u]
[--output human|json] [--object OBJDEF] FILENAME
Arguments:
$ ./build/qemu-img check --help
Check basic image integrity. Usage:
qemu-img check [-f FMT | --image-opts] [-T CACHE_MODE] [-r] [-u]
[--output human|json] [--object OBJDEF] FILENAME
Arguments:
...
Or just:
Check basic image integrity:
qemu-img check...
In all cases I tried to make the whole thing as compact as possible,
to (almost) fit on a standard terminal. The extra empty lines between
different arguments makes it almost impossible.
I think if indentation will be larger, it will be easier to read.
Let me experiment a bit..
"Arguments:\n"
" -h|--help - print this help and exit\n"
btw, the common way is to use comma here, not "|", --
-h,--help - ...
Again, I especially omitted space after "|" to make it
more compact. Maybe for no good.
We've really big amount of options here, conflicting and illogical
in some cases, which's been added without much thinking. All this
makes me think it will be difficult to automate generation of all
this text for both code and docs..
Thanks!
/mjt
