[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [Qemu-block] [PATCH 1/5] option: Make option help nicer
From: |
Max Reitz |
Subject: |
Re: [Qemu-devel] [Qemu-block] [PATCH 1/5] option: Make option help nicer to read |
Date: |
Fri, 19 Oct 2018 12:00:22 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.0 |
On 16.10.18 14:12, Kevin Wolf wrote:
> Am 15.10.2018 um 19:28 hat Max Reitz geschrieben:
>> This adds some whitespace into the option help (including indentation)
>> and replaces '=' by ': ' (not least because '=' should be used for
>> values, not types). Furthermore, the list name is no longer printed as
>> part of every line, but only once in advance, and only if the caller did
>> not print a caption already.
>>
>> Signed-off-by: Max Reitz <address@hidden>
>
> If this isn't a bike shedding series, then what is? So...
Sure it is.
>> --- a/tests/qemu-iotests/082.out
>> +++ b/tests/qemu-iotests/082.out
>> @@ -44,171 +44,171 @@ cluster_size: 8192
>>
>> Testing: create -f qcow2 -o help TEST_DIR/t.qcow2 128M
>> Supported options:
>> -size Virtual disk size
>> -compat Compatibility level (0.10 or 1.1)
>> -backing_file File name of a base image
>> -backing_fmt Image format of the base image
>> -encryption Encrypt the image with format 'aes'. (Deprecated in favor
>> of encrypt.format=aes)
>> -encrypt.format Encrypt the image, format choices: 'aes', 'luks'
>> -encrypt.key-secret ID of secret providing qcow AES key or LUKS passphrase
>> -encrypt.cipher-alg Name of encryption cipher algorithm
>> -encrypt.cipher-mode Name of encryption cipher mode
>> -encrypt.ivgen-alg Name of IV generator algorithm
>> -encrypt.ivgen-hash-alg Name of IV generator hash algorithm
>> -encrypt.hash-alg Name of encryption hash algorithm
>> -encrypt.iter-time Time to spend in PBKDF in milliseconds
>> -cluster_size qcow2 cluster size
>> -preallocation Preallocation mode (allowed values: off, metadata, falloc,
>> full)
>> -lazy_refcounts Postpone refcount updates
>> -refcount_bits Width of a reference count entry in bits
>> -nocow Turn off copy-on-write (valid only on btrfs)
>> + backing_file: str - File name of a base image
>> + backing_fmt: str - Image format of the base image
>> + cluster_size: size - qcow2 cluster size
>> + compat: str - Compatibility level (0.10 or 1.1)
>> + encrypt.cipher-alg: str - Name of encryption cipher algorithm
>> + encrypt.cipher-mode: str - Name of encryption cipher mode
>> + encrypt.format: str - Encrypt the image, format choices: 'aes', 'luks'
>> + encrypt.hash-alg: str - Name of encryption hash algorithm
>> + encrypt.iter-time: num - Time to spend in PBKDF in milliseconds
>> + encrypt.ivgen-alg: str - Name of IV generator algorithm
>> + encrypt.ivgen-hash-alg: str - Name of IV generator hash algorithm
>> + encrypt.key-secret: str - ID of secret providing qcow AES key or LUKS
>> passphrase
>> + encryption: bool (on/off) - Encrypt the image with format 'aes'.
>> (Deprecated in favor of encrypt.format=aes)
>> + lazy_refcounts: bool (on/off) - Postpone refcount updates
>> + nocow: bool (on/off) - Turn off copy-on-write (valid only on btrfs)
>> + preallocation: str - Preallocation mode (allowed values: off, metadata,
>> falloc, full)
>> + refcount_bits: num - Width of a reference count entry in bits
>> + size: size - Virtual disk size
>
> I like the result of this series better than what we have in current
> master. Looking at this patch, however, I must also say that I like the
> original state better than both.
I don't disagree. But having the types is indeed a worthy improvement.
> How about aligning the description to the same column again to combine
> the best of both worlds?
That sounds good to me.
Max
signature.asc
Description: OpenPGP digital signature
- [Qemu-devel] [PATCH 0/5] Various option help readability improvement suggestions, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 2/5] chardev: Indent list of chardevs, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 4/5] object: Make option help nicer to read, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 3/5] qdev-monitor: Make device options help nicer, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 5/5] fw_cfg: Drop newline in @file description, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 1/5] option: Make option help nicer to read, Max Reitz, 2018/10/15