| Message ID | 20230404115912.2829251-16-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi qga/qapi-schema: Doc fixes | expand |
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)" ?
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.
diff --git a/qapi/block-core.json b/qapi/block-core.json index 9dd5ed9a47..b57978957f 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -1318,10 +1318,10 @@ # value is monotonically increasing. # # @busy: false if the job is known to be in a quiescent state, with -# no pending I/O. Since 1.3. +# no pending I/O. (Since 1.3) # # @paused: whether the job is paused or, if @busy is true, will -# pause itself as soon as possible. Since 1.3. +# pause itself as soon as possible. (Since 1.3) # # @speed: the rate limit, bytes per second # @@ -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) # # Since: 1.5 ## diff --git a/qapi/ui.json b/qapi/ui.json index e9599dea50..88de458ba9 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -1207,13 +1207,13 @@ # window resizes (virtio-gpu) this will default to "on", # assuming the guest will resize the display to match # the window size then. Otherwise it defaults to "off". -# Since 3.1 +# (Since 3.1) # @show-tabs: Display the tab bar for switching between the various graphical # interfaces (e.g. VGA and virtual console character devices) # by default. -# Since 7.1 +# (Since 7.1) # @show-menubar: Display the main window menubar. Defaults to "on". -# Since 8.0 +# (Since 8.0) # # Since: 2.12 ##
Signed-off-by: Markus Armbruster <armbru@redhat.com> --- qapi/block-core.json | 6 +++--- qapi/stats.json | 2 +- qapi/tpm.json | 3 +-- qapi/ui.json | 6 +++--- 4 files changed, 8 insertions(+), 9 deletions(-)