[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH for-2.9 17/47] qapi: The #optional tag is redund
Re: [Qemu-devel] [PATCH for-2.9 17/47] qapi: The #optional tag is redundant, drop
Wed, 15 Mar 2017 08:22:54 +0100
Gnus/5.13 (Gnus v5.13) Emacs/25.1 (gnu/linux)
Eric Blake <address@hidden> writes:
> On 03/13/2017 01:18 AM, Markus Armbruster wrote:
>> We traditionally mark optional members #optional in the doc comment.
>> Before commit 3313b61, this was entirely manual.
>> Commit 3313b61 added some automation because its qapi2texi.py relied
>> on #optional to determine whether a member is optional. This is no
>> longer the case since the previous commit: the only thing qapi2texi.py
>> still does with #optional is stripping it out. We still reject bogus
>> qapi-schema.json and six places for qga/qapi-schema.json.
>> Thus, you can't actually rely on #optional to see whether something is
>> optional. Yet we still make people add it manually. That's just
> Yay! Let the computer do the work for us!
>> Drop the code to check, fix up and strip out #optional, along with all
>> instances of #optional. To keep it out, add code to reject it, to be
>> dropped again once the dust settles.
>> No change to generated documentation.
>> Signed-off-by: Markus Armbruster <address@hidden>
>> @@ -150,10 +148,10 @@ For example:
>> # Statistics of a virtual block device or a block backing device.
>> -# @device: #optional If the stats are for a virtual block device, the name
>> -# corresponding to the virtual block device.
>> +# @device: If the stats are for a virtual block device, the name
>> +# corresponding to the virtual block device.
> This loses the hanging indentation in the example, but I don't see you
> making that change in the actual .json files. It shouldn't matter in
> the long run, and is certainly easier if the way you generated this
> patch was with sed scripts (where computing correct hanging indentation
> after rewrapping is a lot harder than omitting it).
Obvious sed job.
> I don't have any
> strong opinions about the change (less typing, but slightly harder to
> visually see that the following lines belong to the same parameter doc,
> if you don't have blank lines between distinct parameter docs). I'm not
> even sure if it you want to call it out in the commit message as an
> intentional reformat, particularly since you didn't do it everywhere.
I'll touch up this patch to change qapi-code-gen.txt exactly like the
>> +++ b/qapi-schema.json
>> @@ -150,10 +150,10 @@
>> # @fdname: file descriptor name previously passed via 'getfd' command
>> -# @skipauth: #optional whether to skip authentication. Only applies
>> +# @skipauth: whether to skip authentication. Only applies
>> # to "vnc" and "spice" protocols
>> -# @tls: #optional whether to perform TLS. Only applies to the "spice"
>> +# @tls: whether to perform TLS. Only applies to the "spice"
>> # protocol
> Again, whitespace changes shouldn't affect generated output, so
> rewrapping lines like this would be more busy-work than necessary, even
> though this particular example would now fit on one line.
>> @@ -667,45 +667,45 @@
>> -# @setup-time: #optional amount of setup time in milliseconds _before_ the
>> +# @setup-time: amount of setup time in milliseconds _before_ the
>> # iterations begin but _after_ the QMP command is issued. This is
>> # to provide an accounting of any activities (such as RDMA pinning)
>> # may be expensive, but do not actually occur during the iterative
>> # migration rounds themselves. (since 1.6)
> Here's another place where wrapping now looks odd (short, followed by
> multiple longer lines). Again, the effort of rewrapping lines is not
> worth the churn (and it's actually easier to read diffs that _don't_
> reflow text). So I'll just overlook wrapping oddities in the rest of
> the patch, as inconsequential to the end result.
A sufficiently clever Emacs macro could give us more pleasantly wrapped
lines, at the cost of a messier diff. I'll experiment if time permits.
> Reviewed-by: Eric Blake <address@hidden>
- [Qemu-devel] [PATCH for-2.9 26/47] qapi2texi: Generate reference to base type members, (continued)
- [Qemu-devel] [PATCH for-2.9 26/47] qapi2texi: Generate reference to base type members, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 46/47] qapi: Make pylint a bit happier, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 27/47] qapi2texi: Generate documentation for variant members, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 17/47] qapi: The #optional tag is redundant, drop, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 37/47] qapi: Fix detection of bogus member documentation, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 03/47] qapi: Back out doc comments added just to please qapi.py, Markus Armbruster, 2017/03/13