diff options
| author | Peter Maydell | 2020-02-13 18:56:26 +0100 |
|---|---|---|
| committer | Markus Armbruster | 2020-02-15 11:41:50 +0100 |
| commit | 26ec4e53f2bf0a381189071f405b99a7e2627a49 (patch) | |
| tree | ae7e34e71e3e366c57b8c3112d97970f2d34250a | |
| parent | qapi: Fix incorrect "Not documented" claims in QMP documentation (diff) | |
| download | qemu-26ec4e53f2bf0a381189071f405b99a7e2627a49.tar.gz qemu-26ec4e53f2bf0a381189071f405b99a7e2627a49.tar.xz qemu-26ec4e53f2bf0a381189071f405b99a7e2627a49.zip | |
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>
| -rw-r--r-- | qapi/block-core.json | 786 | ||||
| -rw-r--r-- | qapi/block.json | 14 | ||||
| -rw-r--r-- | qapi/char.json | 8 | ||||
| -rw-r--r-- | qapi/dump.json | 4 | ||||
| -rw-r--r-- | qapi/introspect.json | 12 | ||||
| -rw-r--r-- | qapi/job.json | 32 | ||||
| -rw-r--r-- | qapi/machine-target.json | 18 | ||||
| -rw-r--r-- | qapi/machine.json | 12 | ||||
| -rw-r--r-- | qapi/migration.json | 198 | ||||
| -rw-r--r-- | qapi/misc-target.json | 8 | ||||
| -rw-r--r-- | qapi/misc.json | 102 | ||||
| -rw-r--r-- | qapi/net.json | 22 | ||||
| -rw-r--r-- | qapi/qdev.json | 10 | ||||
| -rw-r--r-- | qapi/qom.json | 4 | ||||
| -rw-r--r-- | qapi/rocker.json | 12 | ||||
| -rw-r--r-- | qapi/run-state.json | 34 | ||||
| -rw-r--r-- | qapi/sockets.json | 8 | ||||
| -rw-r--r-- | qapi/trace.json | 16 | ||||
| -rw-r--r-- | qapi/transaction.json | 4 | ||||
| -rw-r--r-- | qapi/ui.json | 36 |
20 files changed, 670 insertions, 670 deletions
diff --git a/qapi/block-core.json b/qapi/block-core.json index c617bc2af6..c62b7db281 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json |