diff options
author | Markus Armbruster <armbru@redhat.com> | 2023-04-28 12:54:29 +0200 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2023-05-10 10:01:01 +0200 |
commit | a937b6aa739f65f2cae2ad9a7eb65a309ad2a359 (patch) | |
tree | c11a2c7b6fc5b850ef4dd6b613902759824779a5 /qapi/trace.json | |
parent | 059d341a67bb660a7957cb62a6a860c92c2fb64a (diff) |
qapi: Reformat doc comments to conform to current conventions
Change
# @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
# do eiusmod tempor incididunt ut labore et dolore magna aliqua.
to
# @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
# do eiusmod tempor incididunt ut labore et dolore magna aliqua.
See recent commit "qapi: Relax doc string @name: description
indentation rules" for rationale.
Reflow paragraphs to 70 columns width, and consistently use two spaces
to separate sentences.
To check the generated documentation does not change, I compared the
generated HTML before and after this commit with "wdiff -3". Finds no
differences. Comparing with diff is not useful, as the reflown
paragraphs are visible there.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230428105429.1687850-18-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Acked-by: Lukas Straub <lukasstraub2@web.de>
[Straightforward conflicts in qapi/audio.json qapi/misc-target.json
qapi/run-state.json resolved]
Diffstat (limited to 'qapi/trace.json')
-rw-r--r-- | qapi/trace.json | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/qapi/trace.json b/qapi/trace.json index f425d10764..6bf0af0946 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -32,11 +32,13 @@ # Information of a tracing event. # # @name: Event name. +# # @state: Tracing state. +# # @vcpu: Whether this is a per-vCPU event (since 2.7). # -# An event is per-vCPU if it has the "vcpu" property in the "trace-events" -# files. +# An event is per-vCPU if it has the "vcpu" property in the +# "trace-events" files. # # Since: 2.2 ## @@ -49,19 +51,20 @@ # Query the state of events. # # @name: Event name pattern (case-sensitive glob). +# # @vcpu: The vCPU to query (any by default; since 2.7). # # Returns: a list of @TraceEventInfo for the matching events # -# An event is returned if: +# An event is returned if: # -# - its name matches the @name pattern, and -# - if @vcpu is given, the event has the "vcpu" property. +# - its name matches the @name pattern, and +# - if @vcpu is given, the event has the "vcpu" property. # -# Therefore, if @vcpu is given, the operation will only match per-vCPU events, -# returning their state on the specified vCPU. Special case: if @name is an -# exact match, @vcpu is given and the event does not have the "vcpu" property, -# an error is returned. +# Therefore, if @vcpu is given, the operation will only match per-vCPU +# events, returning their state on the specified vCPU. Special case: +# if @name is an exact match, @vcpu is given and the event does not +# have the "vcpu" property, an error is returned. # # Since: 2.2 # @@ -70,7 +73,6 @@ # -> { "execute": "trace-event-get-state", # "arguments": { "name": "qemu_memalign" } } # <- { "return": [ { "name": "qemu_memalign", "state": "disabled", "vcpu": false } ] } -# ## { 'command': 'trace-event-get-state', 'data': {'name': 'str', '*vcpu': 'int'}, @@ -82,8 +84,11 @@ # Set the dynamic tracing state of events. # # @name: Event name pattern (case-sensitive glob). +# # @enable: Whether to enable tracing. +# # @ignore-unavailable: Do not match unavailable events with @name. +# # @vcpu: The vCPU to act upon (all by default; since 2.7). # # An event's state is modified if: @@ -91,10 +96,10 @@ # - its name matches the @name pattern, and # - if @vcpu is given, the event has the "vcpu" property. # -# Therefore, if @vcpu is given, the operation will only match per-vCPU events, -# setting their state on the specified vCPU. Special case: if @name is an exact -# match, @vcpu is given and the event does not have the "vcpu" property, an -# error is returned. +# Therefore, if @vcpu is given, the operation will only match per-vCPU +# events, setting their state on the specified vCPU. Special case: if +# @name is an exact match, @vcpu is given and the event does not have +# the "vcpu" property, an error is returned. # # Since: 2.2 # @@ -103,7 +108,6 @@ # -> { "execute": "trace-event-set-state", # "arguments": { "name": "qemu_memalign", "enable": true } } # <- { "return": {} } -# ## { 'command': 'trace-event-set-state', 'data': {'name': 'str', 'enable': 'bool', '*ignore-unavailable': 'bool', |