[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands i
From: |
Max Reitz |
Subject: |
Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation |
Date: |
Mon, 13 Aug 2018 18:56:39 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 |
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
- Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation,
Max Reitz <=
- Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation, Eric Blake, 2018/08/13
- Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation, Kevin Wolf, 2018/08/14
- Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation, Programmingkid, 2018/08/16
- Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation, Eric Blake, 2018/08/17
- Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation, Programmingkid, 2018/08/17
- Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation, Eric Blake, 2018/08/17
- Re: [Qemu-devel] [PATCH] qemu-img.c: increase spacing between commands in documentation, Programmingkid, 2018/08/18