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>

1 files changed, 16 insertions, 16 deletions

diff --git a/qapi/job.json b/qapi/job.json
index a121b615fb..5e658281f5 100644
--- a/qapi/job.json
+++ b/qapi/job.json
@@ -214,28 +214,28 @@
 #
 # Information about a job.
 #
-# @id:                  The job identifier
+# @id: The job identifier
 #
-# @type:                The kind of job that is being performed
+# @type: The kind of job that is being performed
 #
-# @status:              Current job state/status
+# @status: Current job state/status
 #
-# @current-progress:    Progress made until now. The unit is arbitrary and the
-#                       value can only meaningfully be used for the ratio of
-#                       @current-progress to @total-progress. The value is
-#                       monotonically increasing.
+# @current-progress: Progress made until now. The unit is arbitrary and the
+#                    value can only meaningfully be used for the ratio of
+#                    @current-progress to @total-progress. The value is
+#                    monotonically increasing.
 #
-# @total-progress:      Estimated @current-progress value at the completion of
-#                       the job. This value can arbitrarily change while the
-#                       job is running, in both directions.
+# @total-progress: Estimated @current-progress value at the completion of
+#                  the job. This value can arbitrarily change while the
+#                  job is running, in both directions.
 #
-# @error:               If this field is present, the job failed; if it is
-#                       still missing in the CONCLUDED state, this indicates
-#                       successful completion.
+# @error: If this field is present, the job failed; if it is
+#         still missing in the CONCLUDED state, this indicates
+#         successful completion.
 #
-#                       The value is a human-readable error message to describe
-#                       the reason for the job failure. It should not be parsed
-#                       by applications.
+#         The value is a human-readable error message to describe
+#         the reason for the job failure. It should not be parsed
+#         by applications.
 #
 # Since: 3.0
 ##