aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/qmp-commands.txt30
-rw-r--r--qapi-schema.json9
2 files changed, 9 insertions, 30 deletions
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt
index 8adc1060dc..162467e924 100644
--- a/docs/qmp-commands.txt
+++ b/docs/qmp-commands.txt
@@ -192,36 +192,6 @@ Example:
-> { "execute": "x-colo-lost-heartbeat" }
<- { "return": {} }
-dump
-
-
-Dump guest memory to file. The file can be processed with crash or gdb.
-
-Arguments:
-
-- "paging": do paging to get guest's memory mapping (json-bool)
-- "protocol": destination file(started with "file:") or destination file
- descriptor (started with "fd:") (json-string)
-- "detach": if specified, command will return immediately, without waiting
- for the dump to finish. The user can track progress using
- "query-dump". (json-bool)
-- "begin": the starting physical address. It's optional, and should be specified
- with length together (json-int)
-- "length": the memory size, in bytes. It's optional, and should be specified
- with begin together (json-int)
-- "format": the format of guest memory dump. It's optional, and can be
- elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
- conflict with paging and filter, ie. begin and length (json-string)
-
-Example:
-
--> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
-<- { "return": {} }
-
-Notes:
-
-(1) All boolean arguments default to false
-
query-dump-guest-memory-capability
----------
diff --git a/qapi-schema.json b/qapi-schema.json
index affcad129a..0d80fa2028 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -3204,9 +3204,18 @@
# @length is not allowed to be specified with non-elf @format at the
# same time (since 2.0)
#
+# Note: All boolean arguments default to false
+#
# Returns: nothing on success
#
# Since: 1.2
+#
+# Example:
+#
+# -> { "execute": "dump-guest-memory",
+# "arguments": { "protocol": "fd:dump" } }
+# <- { "return": {} }
+#
##
{ 'command': 'dump-guest-memory',
'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool',