On Tue, Feb 20, 2024 at 10:02:32PM +0300, Michael Tokarev wrote: > 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.
IMHO fitting on a "standard" terminal is OK in terms of width, but should be a non-goal in terms of height. Readability is more important than avoiding vertical scroll. > > > "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. Yes, a comma with a space would look nicer. If we have the description on the following line, then there's no width limit problems there. With regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
