[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 12/12] qga/qapi-schema: Refill doc comments to conform to current
From: |
Markus Armbruster |
Subject: |
[PATCH 12/12] qga/qapi-schema: Refill doc comments to conform to current conventions |
Date: |
Fri, 22 Mar 2024 15:09:10 +0100 |
For legibility, wrap text paragraphs so every line is at most 70
characters long.
To check the generated documentation does not change, I compared the
generated HTML before and after this commit with "wdiff -3". Finds no
differences. Comparing with diff is not useful, as the refilled
paragraphs are visible there.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qga/qapi-schema.json | 29 +++++++++++++++++------------
1 file changed, 17 insertions(+), 12 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 9554b566a7..d5af155007 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -1220,13 +1220,13 @@
# @signal: signal number (linux) or unhandled exception code (windows)
# if the process was abnormally terminated.
#
-# @out-data: base64-encoded stdout of the process. This field will only
-# be populated after the process exits.
+# @out-data: base64-encoded stdout of the process. This field will
+# only be populated after the process exits.
#
-# @err-data: base64-encoded stderr of the process. Note: @out-data and
-# @err-data are present only if 'capture-output' was specified for
-# 'guest-exec'. This field will only be populated after the process
-# exits.
+# @err-data: base64-encoded stderr of the process. Note: @out-data
+# and @err-data are present only if 'capture-output' was specified
+# for 'guest-exec'. This field will only be populated after the
+# process exits.
#
# @out-truncated: true if stdout was not fully captured due to size
# limitation.
@@ -1273,12 +1273,16 @@
# An enumeration of guest-exec capture modes.
#
# @none: do not capture any output
+#
# @stdout: only capture stdout
+#
# @stderr: only capture stderr
+#
# @separated: capture both stdout and stderr, but separated into
-# GuestExecStatus out-data and err-data, respectively
-# @merged: capture both stdout and stderr, but merge together
-# into out-data. not effective on windows guests.
+# GuestExecStatus out-data and err-data, respectively
+#
+# @merged: capture both stdout and stderr, but merge together into
+# out-data. Not effective on windows guests.
#
# Since: 8.0
##
@@ -1291,8 +1295,9 @@
#
# Controls what guest-exec output gets captures.
#
-# @flag: captures both stdout and stderr if true. Equivalent
-# to GuestExecCaptureOutputMode::all. (since 2.5)
+# @flag: captures both stdout and stderr if true. Equivalent to
+# GuestExecCaptureOutputMode::all. (since 2.5)
+#
# @mode: capture mode; preferred interface
#
# Since: 8.0
@@ -1315,7 +1320,7 @@
# @input-data: data to be passed to process stdin (base64 encoded)
#
# @capture-output: bool flag to enable capture of stdout/stderr of
-# running process. defaults to false.
+# running process. Defaults to false.
#
# Returns: PID
#
--
2.44.0
- [PATCH 03/12] qapi: Tidy up block-latency-histogram-set documentation some more, (continued)
- [PATCH 03/12] qapi: Tidy up block-latency-histogram-set documentation some more, Markus Armbruster, 2024/03/22
- [PATCH 04/12] qapi: Tidy up indentation of add_client's example, Markus Armbruster, 2024/03/22
- [PATCH 02/12] qapi: Expand a few awkward abbreviations in documentation, Markus Armbruster, 2024/03/22
- [PATCH 01/12] qapi: Drop stray Arguments: line from qmp_capabilities docs, Markus Armbruster, 2024/03/22
- [PATCH 08/12] qapi: Start sentences with a capital letter, end them with a period, Markus Armbruster, 2024/03/22
- [PATCH 05/12] qapi: Fix argument markup in drive-mirror documentation, Markus Armbruster, 2024/03/22
- [PATCH 07/12] qapi: Fix abbreviation punctuation in doc comments, Markus Armbruster, 2024/03/22
- [PATCH 09/12] qapi: Don't repeat member type in its documentation text, Markus Armbruster, 2024/03/22
- [PATCH 11/12] qapi: Correct documentation indentation and whitespace, Markus Armbruster, 2024/03/22
- [PATCH 12/12] qga/qapi-schema: Refill doc comments to conform to current conventions,
Markus Armbruster <=
- [PATCH 06/12] qapi: Fix typo in request-ebpf documentation, Markus Armbruster, 2024/03/22
- [PATCH 10/12] qapi: Refill doc comments to conform to current conventions, Markus Armbruster, 2024/03/22