diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2020-02-13 17:56:26 +0000 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2020-02-15 11:41:50 +0100 |
| commit | 26ec4e53f2bf0a381189071f405b99a7e2627a49 (patch) | |
| tree | ae7e34e71e3e366c57b8c3112d97970f2d34250a /qapi/trace.json | |
| parent | f56275064e06974b5c03f37ccdb124adbc5baef6 (diff) | |
qapi: Fix indent level on doc comments in json files
The current doc generation doesn't care much about indentation levels,
but we would like to switch to an rST format, and rST does care about
indentation.
Make the doc comments more strongly consistent about indentation
for multiline constructs like:
@arg: description line 1
description line 2
Returns: line one
line 2
so that there is always exactly one space after the colon, and
subsequent lines align with the first.
This commit is a purely whitespace change, and it does not alter the
generated .texi files (because the texi generation code strips away
all the extra whitespace). This does mean that we end up with some
over-length lines.
Note that when the documentation for an argument fits on a single
line like this:
@arg: one line only
then stray extra spaces after the ':' don't affect the rST output, so
I have not attempted to methodically fix them, though the preference
is a single space here too.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200213175647.17628-10-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'qapi/trace.json')
| -rw-r--r-- | qapi/trace.json | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/qapi/trace.json b/qapi/trace.json index 799b254a18..4955e5a750 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -52,14 +52,14 @@ # # Returns: a list of @TraceEventInfo for the matching events # -# An event is returned if: -# - 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. +# An event is returned if: +# - 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. # # Since: 2.2 # |