]> Git Repo - qemu.git/commit
qapi: Fix indent level on doc comments in json files
authorPeter Maydell <[email protected]>
Thu, 13 Feb 2020 17:56:26 +0000 (17:56 +0000)
committerMarkus Armbruster <[email protected]>
Sat, 15 Feb 2020 10:41:50 +0000 (11:41 +0100)
commit26ec4e53f2bf0a381189071f405b99a7e2627a49
treeae7e34e71e3e366c57b8c3112d97970f2d34250a
parentf56275064e06974b5c03f37ccdb124adbc5baef6
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 <[email protected]>
Message-Id: <20200213175647[email protected]>
Reviewed-by: Markus Armbruster <[email protected]>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <[email protected]>
20 files changed:
qapi/block-core.json
qapi/block.json
qapi/char.json
qapi/dump.json
qapi/introspect.json
qapi/job.json
qapi/machine-target.json
qapi/machine.json
qapi/migration.json
qapi/misc-target.json
qapi/misc.json
qapi/net.json
qapi/qdev.json
qapi/qom.json
qapi/rocker.json
qapi/run-state.json
qapi/sockets.json
qapi/trace.json
qapi/transaction.json
qapi/ui.json
This page took 0.027006 seconds and 4 git commands to generate.