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/machine-target.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/machine-target.json')
| -rw-r--r-- | qapi/machine-target.json | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/qapi/machine-target.json b/qapi/machine-target.json index 0462322472..f2c82949d8 100644 --- a/qapi/machine-target.json +++ b/qapi/machine-target.json @@ -40,13 +40,13 @@ # model details. # # Note: When a non-migration-safe CPU model is expanded in static mode, some -# features enabled by the CPU model may be omitted, because they can't be -# implemented by a static CPU model definition (e.g. cache info passthrough and -# PMU passthrough in x86). If you need an accurate representation of the -# features enabled by a non-migration-safe CPU model, use @full. If you need a -# static representation that will keep ABI compatibility even when changing QEMU -# version or machine-type, use @static (but keep in mind that some features may -# be omitted). +# features enabled by the CPU model may be omitted, because they can't be +# implemented by a static CPU model definition (e.g. cache info passthrough and +# PMU passthrough in x86). If you need an accurate representation of the +# features enabled by a non-migration-safe CPU model, use @full. If you need a +# static representation that will keep ABI compatibility even when changing QEMU +# version or machine-type, use @static (but keep in mind that some features may +# be omitted). # # Since: 2.8.0 ## @@ -148,7 +148,7 @@ # with wrong types. # # Note: this command isn't specific to s390x, but is only implemented -# on this architecture currently. +# on this architecture currently. # # Since: 2.8.0 ## @@ -191,7 +191,7 @@ # with wrong types. # # Note: this command isn't specific to s390x, but is only implemented -# on this architecture currently. +# on this architecture currently. # # Since: 2.8.0 ## |