]> git.proxmox.com Git - mirror_qemu.git/commit - qga/qapi-schema.json
qga/qapi-schema.json: Fix indent level on doc comments
authorPeter Maydell <peter.maydell@linaro.org>
Thu, 13 Feb 2020 17:56:22 +0000 (17:56 +0000)
committerMarkus Armbruster <armbru@redhat.com>
Sat, 15 Feb 2020 10:41:49 +0000 (11:41 +0100)
commit883aff68a7d6797a06bac94f631db3439b11a60e
tree986de0f555ba53ef13b43ed99ebc443ee438284e
parent72ec8bf362b24ebbd45452c298a3b14fb617eebb
qga/qapi-schema.json: Fix indent level on doc comments

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>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200213175647.17628-6-peter.maydell@linaro.org>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
qga/qapi-schema.json