diff options
| author | Markus Armbruster <armbru@redhat.com> | 2024-03-22 15:09:10 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-03-26 06:36:08 +0100 |
| commit | 7270819384cabf6c501ef34217eb56a1b14696e3 (patch) | |
| tree | d7bc2a88718c79b3194f04664037c2c0361ec88d | |
| parent | 5305a4eeb80b9b69ae2c1a1440bd3ece0a8b35a2 (diff) | |
qga/qapi-schema: Refill doc comments to conform to current conventions
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>
Message-ID: <20240322140910.328840-13-armbru@redhat.com>
| -rw-r--r-- | qga/qapi-schema.json | 29 |
1 files 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 # |