]> git.ipfire.org Git - thirdparty/qemu.git/commit
qapi/misc-target: Fix the doc to distinguish query-sgx and query-sgx-capabilities
authorZhao Liu <zhao1.liu@intel.com>
Tue, 13 May 2025 14:31:31 +0000 (22:31 +0800)
committerPaolo Bonzini <pbonzini@redhat.com>
Tue, 20 May 2025 06:04:19 +0000 (08:04 +0200)
commit7f2131c35c1781ca41c62dc26fd93282e1351323
tree39a6246160d2f4d0a09cf2d0c214af5274bb2412
parentc6b8fb0fb1599cffdfe6603f93bba937c1ecb0b1
qapi/misc-target: Fix the doc to distinguish query-sgx and query-sgx-capabilities

There're 2 QMP commands: query-sgx and query-sgx-capabilities, but
their outputs are very similar and the documentation lacks clear
differentiation.

From the codes, query-sgx is used to gather guest's SGX capabilities
(including SGX related CPUIDs and EPC sections' size, in SGXInfo), and
if guest doesn't have SGX, then QEMU will report the error message.

On the other hand, query-sgx-capabilities is used to gather host's SGX
capabilities (descripted by SGXInfo as well). And if host doesn't
support SGX, then QEMU will also report the error message.

Considering that SGXInfo is already documented and both these 2 commands
have enough error messages (for the exception case in their codes).

Therefore the QAPI documentation for these two commands only needs to
emphasize that one of them applies to the guest and the other to the
host.

Fix their documentation to reflect this difference.

Reported-by: Markus Armbruster <armbru@redhat.com>
Suggested-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Zhao Liu <zhao1.liu@intel.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Link: https://lore.kernel.org/r/20250513143131.2008078-3-zhao1.liu@intel.com
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
qapi/misc-target.json