Re: [PATCH v2 08/30] qapi: Use ':' after @argument in doc comments

[Markus Armbruster <armbru@redhat.com>]

Markus Armbruster <armbru@redhat.com> writes:

> Peter Maydell <peter.maydell@linaro.org> writes:
>
>> Some qapi doc comments have forgotten the ':' after the
>> @argument, like this:
>>
>> # @filename         Filename for the new image file
>> # @size             Size of the virtual disk in bytes
>>
>> The result is that these are parsed as part of the body
>> text and appear as a run-on line:
>>   filename Filename for the new image file size Size of the virtual disk in bytes"
>> followed by
>>   filename: string
>>     Not documented
>>   size: int
>>     Not documented
>>
>> in the 'Members' section.
>>
>> Correct the formatting.
>>
>> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
>> Reviewed-by: Markus Armbruster <armbru@redhat.com>
>
> The title sounds like it's just a tweak, but it actually fixes bugs in
> the generated documentation.  Suggest to change the title to
>
>     qapi: Fix incorrect "Not documented" claims in QMP documentation
>
> R-by stands regardless.

Forgot to mention:

[...]
>> @@ -4645,17 +4645,17 @@
>>  #
>>  # Driver specific image creation options for vhdx.
>>  #
>> -# @file             Node to create the image format on
>> -# @size             Size of the virtual disk in bytes
>> -# @log-size         Log size in bytes, must be a multiple of 1 MB
>> -#                   (default: 1 MB)
>> -# @block-size       Block size in bytes, must be a multiple of 1 MB and not
>> -#                   larger than 256 MB (default: automatically choose a block
>> -#                   size depending on the image size)
>> -# @subformat        vhdx subformat (default: dynamic)
>> -# @block-state-zero Force use of payload blocks of type 'ZERO'. Non-standard,
>> -#                   but default.  Do not set to 'off' when using 'qemu-img
>> -#                   convert' with subformat=dynamic.
>> +# @file: Node to create the image format on
>> +# @size: Size of the virtual disk in bytes
>> +# @log-size: Log size in bytes, must be a multiple of 1 MB
>> +#            (default: 1 MB)
>> +# @block-size: Block size in bytes, must be a multiple of 1 MB and not
>> +#              larger than 256 MB (default: automatically choose a block
>> +#              size depending on the image size)
>> +# @subformat: vhdx subformat (default: dynamic)
>> +# @block-state-zero: Force use of payload blocks of type 'ZERO'. Non-standard,
>> +#                    but default.  Do not set to 'off' when using 'qemu-img
>> +#                    convert' with subformat=dynamic.
>>  #
>>  # Since: 2.12
>>  ##

Kevin dislikes the loss of visual alignment here.  I dislike the
formatting before and after the patch.  I suggested a new style:

    # @file:
    # Node to create the image format on
    #
    # @size:
    # Size of the virtual disk in bytes
    #
    # @log-size:
    # Log size in bytes, must be a multiple of 1 MB (default: 1 MB)
    #
    # @block-size:
    # Block size in bytes, must be a multiple of 1 MB and not larger
    # than 256 MB (default: automatically choose a block size depending
    # on the image size)
    #
    # @subformat:
    # vhdx subformat (default: dynamic)
    #
    # @block-state-zero:
    # Force use of payload blocks of type 'ZERO'.  Non-standard, but
    # default.  Do not set to 'off' when using 'qemu-img convert' with
    # subformat=dynamic.

Nobody disliked this style.  Peter reports his code already supports it,
but objects to converting to it in his series.  Okay; we can convert
later.  More churn, but the individual patches / series are simpler.