All of lore.kernel.org
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Cc: qemu-devel@nongnu.org,  michael.roth@amd.com,  eblake@redhat.com,
	kwolf@redhat.com,  hreitz@redhat.com,  pbonzini@redhat.com,
	marcandre.lureau@redhat.com,  arei.gonglei@huawei.com,
	pizhenwei@bytedance.com,  jsnow@redhat.com,  eduardo@habkost.net,
	marcel.apfelbaum@gmail.com,  wangyanan55@huawei.com,
	quintela@redhat.com,  jasowang@redhat.com,
	 yuval.shaia.ml@gmail.com, stefanha@redhat.com,
	 kraxel@redhat.com,  kkostiuk@redhat.com, qemu-block@nongnu.org
Subject: Re: [PATCH 15/16] qapi: Format since information the conventional way: (since X.Y)
Date: Tue, 04 Apr 2023 15:35:59 +0200	[thread overview]
Message-ID: <87wn2rwz0g.fsf@pond.sub.org> (raw)
In-Reply-To: <1c067573-9eab-fa70-8c49-a4085d150134@yandex-team.ru> (Vladimir Sementsov-Ogievskiy's message of "Tue, 4 Apr 2023 15:55:08 +0300")

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.



  reply	other threads:[~2023-04-04 13:36 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-04 11:58 [PATCH 00/16] qapi qga/qapi-schema: Doc fixes Markus Armbruster
2023-04-04 11:58 ` [PATCH 01/16] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status Markus Armbruster
2023-04-04 17:03   ` Konstantin Kostiuk
2023-04-04 11:58 ` [PATCH 02/16] qga/qapi-schema: Fix a misspelled reference Markus Armbruster
2023-04-04 11:58 ` [PATCH 03/16] qapi: Fix misspelled references Markus Armbruster
2023-04-05  8:21   ` David Hildenbrand
2023-04-04 11:59 ` [PATCH 04/16] qapi: Fix up references to long gone error classes Markus Armbruster
2023-04-04 11:59 ` [PATCH 05/16] qapi/block-core: Clean up after removal of dirty bitmap @status Markus Armbruster
2023-04-11 20:56   ` John Snow
2023-04-04 11:59 ` [PATCH 06/16] qapi: @foo should be used to reference, not ``foo`` Markus Armbruster
2023-04-04 11:59 ` [PATCH 07/16] qapi: Tidy up examples Markus Armbruster
2023-04-04 11:59 ` [PATCH 08/16] qapi: Delete largely misleading "Stability Considerations" Markus Armbruster
2023-04-04 11:59 ` [PATCH 09/16] qapi: Fix bullet list markup in documentation Markus Armbruster
2023-04-04 11:59 ` [PATCH 10/16] qapi: Fix unintended definition lists " Markus Armbruster
2023-04-04 12:46   ` Peter Maydell
2023-04-04 11:59 ` [PATCH 11/16] qga/qapi-schema: Fix member documentation markup Markus Armbruster
2023-04-04 11:59 ` [PATCH 12/16] qapi: Fix argument " Markus Armbruster
2023-04-04 11:59 ` [PATCH 13/16] qapi: Replace ad hoc "since" documentation by member documentation Markus Armbruster
2023-04-04 11:59 ` [PATCH 14/16] qapi: Fix misspelled section tags in doc comments Markus Armbruster
2023-04-04 11:59 ` [PATCH 15/16] qapi: Format since information the conventional way: (since X.Y) Markus Armbruster
2023-04-04 12:55   ` Vladimir Sementsov-Ogievskiy
2023-04-04 13:35     ` Markus Armbruster [this message]
2023-04-04 11:59 ` [PATCH 16/16] qapi storage-daemon/qapi: Fix documentation section structure Markus Armbruster
2023-04-04 13:12   ` Eric Blake
2023-04-25  4:59     ` Markus Armbruster
2023-04-04 13:19   ` zhenwei pi
2023-04-04 12:58 ` [PATCH 00/16] qapi qga/qapi-schema: Doc fixes Vladimir Sementsov-Ogievskiy
2023-04-28  9:41   ` Markus Armbruster
2023-04-04 13:06 ` Marc-André Lureau

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87wn2rwz0g.fsf@pond.sub.org \
    --to=armbru@redhat.com \
    --cc=arei.gonglei@huawei.com \
    --cc=eblake@redhat.com \
    --cc=eduardo@habkost.net \
    --cc=hreitz@redhat.com \
    --cc=jasowang@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=kkostiuk@redhat.com \
    --cc=kraxel@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=marcandre.lureau@redhat.com \
    --cc=marcel.apfelbaum@gmail.com \
    --cc=michael.roth@amd.com \
    --cc=pbonzini@redhat.com \
    --cc=pizhenwei@bytedance.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    --cc=quintela@redhat.com \
    --cc=stefanha@redhat.com \
    --cc=vsementsov@yandex-team.ru \
    --cc=wangyanan55@huawei.com \
    --cc=yuval.shaia.ml@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.