diff options
| author | Luiz Capitulino <lcapitulino@redhat.com> | 2012-06-28 11:59:15 -0300 |
|---|---|---|
| committer | Luiz Capitulino <lcapitulino@redhat.com> | 2012-07-13 13:46:55 -0300 |
| commit | f5b0d93bcba712e1864c71c2f298c59a94efaa79 (patch) | |
| tree | 5f34a49c83234971864d7d5ca702c5867f1fd332 | |
| parent | c0958559b1a589a0d189c45ea1adaa6b345f4256 (diff) | |
qmp: dump-guest-memory: improve schema doc
Clarify a few points and makes it looks more like the other commands'
documentation.
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
| -rw-r--r-- | qapi-schema.json | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/qapi-schema.json b/qapi-schema.json index 1ab5dbd5ff..5252452c1b 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -1789,34 +1789,36 @@ # # Dump guest's memory to vmcore. It is a synchronous operation that can take # very long depending on the amount of guest memory. This command is only -# supported only on i386 and x86_64 -# -# @paging: if true, do paging to get guest's memory mapping. The @paging's -# default value of @paging is false, If you want to use gdb to process the -# core, please set @paging to true. The reason why the @paging's value is -# false: -# 1. guest machine in a catastrophic state can have corrupted memory, -# which we cannot trust. -# 2. The guest machine can be in read-mode even if paging is enabled. -# For example: the guest machine uses ACPI to sleep, and ACPI sleep -# state goes in real-mode +# supported on i386 and x86_64. +# +# @paging: if true, do paging to get guest's memory mapping. This allows +# using gdb to process the core file. However, setting @paging to false +# may be desirable because of two reasons: +# +# 1. The guest may be in a catastrophic state or can have corrupted +# memory, which cannot be trusted +# 2. The guest can be in real-mode even if paging is enabled. For example, +# the guest uses ACPI to sleep, and ACPI sleep state goes in real-mode +# # @protocol: the filename or file descriptor of the vmcore. The supported -# protocol can be file or fd: +# protocols are: +# # 1. file: the protocol starts with "file:", and the following string is # the file's path. # 2. fd: the protocol starts with "fd:", and the following string is the # fd's name. +# # @begin: #optional if specified, the starting physical address. +# # @length: #optional if specified, the memory size, in bytes. If you don't -# want to dump all guest's memory, please specify the start @begin and -# @length +# want to dump all guest's memory, please specify the start @begin and @length # # Returns: nothing on success # If @begin contains an invalid address, InvalidParameter # If only one of @begin and @length is specified, MissingParameter # If @protocol stats with "fd:", and the fd cannot be found, FdNotFound # If @protocol starts with "file:", and the file cannot be -# opened, OpenFileFailed +# opened, OpenFileFailed # If @protocol does not start with "fd:" or "file:", InvalidParameter # If an I/O error occurs while writing the file, IOError # If the target does not support this command, Unsupported |