aboutsummaryrefslogtreecommitdiff
path: root/qga
diff options
context:
space:
mode:
authorDaniel Xu <dxu@dxuuu.xyz>2023-10-01 12:38:26 -0600
committerKonstantin Kostiuk <kkostiuk@redhat.com>2023-10-11 14:30:54 +0300
commitf897ef0d47d332d4c4498aed1140c6856fe56d79 (patch)
treeb72823a005b322742df7228671a68d78db86324a /qga
parentd6f67b83b81bf49b5c62e77143ed39c020e51830 (diff)
qapi: qga: Clarify when out-data and err-data are populated
If output is being captured for a guest-exec invocation, the out-data and err-data fields of guest-exec-status are only populated after the process is reaped. This is somewhat counter intuitive and too late to change. Thus, it would be good to document the behavior. Signed-off-by: Daniel Xu <dxu@dxuuu.xyz> Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com> Signed-off-by: Konstantin Kostiuk <kkostiuk@redhat.com>
Diffstat (limited to 'qga')
-rw-r--r--qga/qapi-schema.json8
1 files changed, 5 insertions, 3 deletions
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index b720dd4379..876e2a8ea8 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -1220,11 +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
+# @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: base64-encoded stderr of the process. Note: @out-data and
# @err-data are present only if 'capture-output' was specified for
-# 'guest-exec'
+# '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.