Re: [PATCH 15/16] qapi: Format since information the conventional way: (since X.Y)

[Markus Armbruster]

Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru> writes:

> On 04.04.23 14:59, Markus Armbruster wrote:
>> @@ -2741,7 +2741,7 @@
>>   #
>>   # @on-error: the action to take on an error (default report).
>>   #            'stop' and 'enospc' can only be used if the block device
>> -#            supports io-status (see BlockInfo).  Since 1.3.
>> +#            supports io-status (see BlockInfo).  (Since 1.3)
>>   #
>>   # @filter-node-name: the node name that should be assigned to the
>>   #                    filter driver that the stream job inserts into the 
>> graph
>> diff --git a/qapi/stats.json b/qapi/stats.json
>> index f17495ee65..36d5f4dc94 100644
>> --- a/qapi/stats.json
>> +++ b/qapi/stats.json
>> @@ -69,7 +69,7 @@
>>   #
>>   # @vcpu: statistics that apply to a single virtual CPU.
>>   #
>> -# @cryptodev: statistics that apply to a crypto device. since 8.0
>> +# @cryptodev: statistics that apply to a crypto device (since 8.0)
>>   #
>>   # Since: 7.1
>>   ##
>> diff --git a/qapi/tpm.json b/qapi/tpm.json
>> index 4e2ea9756a..eac87d30b2 100644
>> --- a/qapi/tpm.json
>> +++ b/qapi/tpm.json
>> @@ -44,8 +44,7 @@
>>   # An enumeration of TPM types
>>   #
>>   # @passthrough: TPM passthrough type
>> -# @emulator: Software Emulator TPM type
>> -#            Since: 2.11
>> +# @emulator: Software Emulator TPM type (since 2.11)
>
> Seems, we don't have any preference between "some text (since VER)" vs "some 
> text. (Since VER)" ?

I personally use (Since VER) after a full sentence ending in
punctuation, and (since VER) after something that doesn't end in
punctuation.