Skip to content

Commit

Permalink
qapi: qga: Clarify when out-data and err-data are populated
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
danobi authored and kostyanf14 committed Oct 11, 2023
1 parent d6f67b8 commit f897ef0
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions qga/qapi-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit f897ef0

Please sign in to comment.