[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 17/20] qapi: document leftover members in qapi/run-state.json
From: |
Markus Armbruster |
Subject: |
[PULL 17/20] qapi: document leftover members in qapi/run-state.json |
Date: |
Tue, 26 Mar 2024 08:34:17 +0100 |
From: Paolo Bonzini <pbonzini@redhat.com>
Suggested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-ID: <20240325104502.1358693-1-pbonzini@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Capitalize "ID", update qapi/pragma.json]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/pragma.json | 4 +---
qapi/run-state.json | 26 +++++++++++++++++++++++++-
2 files changed, 26 insertions(+), 4 deletions(-)
diff --git a/qapi/pragma.json b/qapi/pragma.json
index 92715d22b3..1a302981c1 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -57,7 +57,6 @@
'DummyForceArrays',
'DummyVirtioForceArrays',
'GrabToggleKeys',
- 'GuestPanicInformationHyperV',
'HotKeyMod',
'ImageInfoSpecificKind',
'InputAxis',
@@ -93,8 +92,7 @@
'query-cpu-model-expansion',
'query-rocker',
'query-rocker-ports',
- 'query-stats-schemas',
- 'watchdog-set-action' ],
+ 'query-stats-schemas' ],
# Externally visible types whose member names may use uppercase
'member-name-exceptions': [ # visible in:
'ACPISlotType', # query-acpi-ospm-status
diff --git a/qapi/run-state.json b/qapi/run-state.json
index 5f07444b84..f8773f23b2 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -376,9 +376,17 @@
##
# @watchdog-set-action:
#
-# Set watchdog action
+# Set watchdog action.
+#
+# @action: @WatchdogAction action taken when watchdog timer expires.
#
# Since: 2.11
+#
+# Example:
+#
+# -> { "execute": "watchdog-set-action",
+# "arguments": { "action": "inject-nmi" } }
+# <- { "return": {} }
##
{ 'command': 'watchdog-set-action', 'data' : {'action': 'WatchdogAction'} }
@@ -504,6 +512,22 @@
#
# Hyper-V specific guest panic information (HV crash MSRs)
#
+# @arg1: for Windows, STOP code for the guest crash. For Linux,
+# an error code.
+#
+# @arg2: for Windows, first argument of the STOP. For Linux, the
+# guest OS ID, which has the kernel version in bits 16-47
+# and 0x8100 in bits 48-63.
+#
+# @arg3: for Windows, second argument of the STOP. For Linux, the
+# program counter of the guest.
+#
+# @arg4: for Windows, third argument of the STOP. For Linux, the
+# RAX register (x86) or the stack pointer (aarch64) of the guest.
+#
+# @arg5: for Windows, fourth argument of the STOP. For x86 Linux, the
+# stack pointer of the guest.
+#
# Since: 2.9
##
{'struct': 'GuestPanicInformationHyperV',
--
2.44.0
- [PULL 03/20] qapi: Fix bogus documentation of query-migrationthreads, (continued)
- [PULL 03/20] qapi: Fix bogus documentation of query-migrationthreads, Markus Armbruster, 2024/03/26
- [PULL 02/20] qapi: Resync MigrationParameter and MigrateSetParameters, Markus Armbruster, 2024/03/26
- [PULL 11/20] qapi: Start sentences with a capital letter, end them with a period, Markus Armbruster, 2024/03/26
- [PULL 10/20] qapi: Fix abbreviation punctuation in doc comments, Markus Armbruster, 2024/03/26
- [PULL 05/20] qapi: Expand a few awkward abbreviations in documentation, Markus Armbruster, 2024/03/26
- [PULL 06/20] qapi: Tidy up block-latency-histogram-set documentation some more, Markus Armbruster, 2024/03/26
- [PULL 08/20] qapi: Fix argument markup in drive-mirror documentation, Markus Armbruster, 2024/03/26
- [PULL 09/20] qapi: Fix typo in request-ebpf documentation, Markus Armbruster, 2024/03/26
- [PULL 16/20] qapi: document InputMultiTouchType, Markus Armbruster, 2024/03/26
- [PULL 19/20] qapi/block-core: improve Qcow2OverlapCheckFlags documentation, Markus Armbruster, 2024/03/26
- [PULL 17/20] qapi: document leftover members in qapi/run-state.json,
Markus Armbruster <=
- [PULL 15/20] qga/qapi-schema: Refill doc comments to conform to current conventions, Markus Armbruster, 2024/03/26
- [PULL 18/20] qapi: document leftover members in qapi/stats.json, Markus Armbruster, 2024/03/26
- [PULL 20/20] qapi: document parameters of query-cpu-model-* QAPI commands, Markus Armbruster, 2024/03/26
- [PULL 13/20] qapi: Refill doc comments to conform to current conventions, Markus Armbruster, 2024/03/26
- [PULL 04/20] qapi: Drop stray Arguments: line from qmp_capabilities docs, Markus Armbruster, 2024/03/26
- [PULL 14/20] qapi: Correct documentation indentation and whitespace, Markus Armbruster, 2024/03/26
- [PULL 12/20] qapi: Don't repeat member type in its documentation text, Markus Armbruster, 2024/03/26
- [PULL 07/20] qapi: Tidy up indentation of add_client's example, Markus Armbruster, 2024/03/26
- Re: [PULL 00/20] QAPI patches patches for 2024-03-26, Peter Maydell, 2024/03/26