Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation

[Max Reitz]

On 2018-07-30 23:22, John Arbuckle wrote:
> When the user uses the --help option in qemu-img, the output for the commands 
> is very hard to read due to being so close to each other. With this patch the 
> help for the commands is double spaced making things easier to read.
> 
> Signed-off-by: John Arbuckle <address@hidden>
> ---
>  qemu-img.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/qemu-img.c b/qemu-img.c
> index 9b7506b8ae..6a7e63435e 100644
> --- a/qemu-img.c
> +++ b/qemu-img.c
> @@ -120,7 +120,7 @@ static void QEMU_NORETURN help(void)
>             "\n"
>             "Command syntax:\n"
>  #define DEF(option, callback, arg_string)        \
> -           "  " arg_string "\n"
> +           "  " arg_string "\n\n"
>  #include "qemu-img-cmds.h"
>  #undef DEF
>             "\n"

Ah, hm, so much for that.  Hm...  I don't quite know what to think of
this.  It does indeed improve legibility.  But the question is whether
--help should be as condensed as possible, and if the user finds it hard
to read, whether they should not just open the man page...

Then again, our --help text already has 102 lines.

Let me just think about it for a bit longer. :-)
(And see whether others have opinions.)

Max

signature.asc
Description: OpenPGP digital signature