From: "Philippe Mathieu-Daudé" <philmd@linaro.org>
To: Peter Maydell <peter.maydell@linaro.org>, qemu-devel@nongnu.org
Cc: "Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: Re: [PATCH 7/8] docs/specs/vmcoreinfo: Convert to rST
Date: Tue, 31 Oct 2023 16:42:14 +0100 [thread overview]
Message-ID: <66663c7e-3ab8-ae62-cd55-52c89bcd7733@linaro.org> (raw)
In-Reply-To: <20230927151205.70930-8-peter.maydell@linaro.org>
On 27/9/23 17:12, Peter Maydell wrote:
> Convert docs/specs/vmcoreinfo.txt to rST format.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> MAINTAINERS | 1 +
> docs/specs/index.rst | 1 +
> docs/specs/{vmcoreinfo.txt => vmcoreinfo.rst} | 33 ++++++++++---------
> 3 files changed, 19 insertions(+), 16 deletions(-)
> rename docs/specs/{vmcoreinfo.txt => vmcoreinfo.rst} (50%)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 9e27cad11c3..23ee617acaf 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -2805,6 +2805,7 @@ F: include/sysemu/dump.h
> F: qapi/dump.json
> F: scripts/dump-guest-memory.py
> F: stubs/dump.c
> +F: docs/specs/vmcoreinfo.rst
Good :)
Cc'ing Marc-André.
> Error reporting
> M: Markus Armbruster <armbru@redhat.com>
> diff --git a/docs/specs/index.rst b/docs/specs/index.rst
> index 8d30968650b..7a56ccb2155 100644
> --- a/docs/specs/index.rst
> +++ b/docs/specs/index.rst
> @@ -30,3 +30,4 @@ guest hardware that is specific to QEMU.
> pvpanic
> standard-vga
> virt-ctlr
> + vmcoreinfo
> diff --git a/docs/specs/vmcoreinfo.txt b/docs/specs/vmcoreinfo.rst
> similarity index 50%
> rename from docs/specs/vmcoreinfo.txt
> rename to docs/specs/vmcoreinfo.rst
> index bcbca6fe47c..462b04474d3 100644
> --- a/docs/specs/vmcoreinfo.txt
> +++ b/docs/specs/vmcoreinfo.rst
> @@ -2,19 +2,19 @@
> VMCoreInfo device
> =================
>
> -The `-device vmcoreinfo` will create a fw_cfg entry for a guest to
> +The ``-device vmcoreinfo`` will create a ``fw_cfg`` entry for a guest to
> store dump details.
>
> -etc/vmcoreinfo
> -**************
> +``etc/vmcoreinfo``
> +==================
>
> -A guest may use this fw_cfg entry to add information details to qemu
> +A guest may use this ``fw_cfg`` entry to add information details to qemu
> dumps.
>
> The entry of 16 bytes has the following layout, in little-endian::
>
> -#define VMCOREINFO_FORMAT_NONE 0x0
> -#define VMCOREINFO_FORMAT_ELF 0x1
> + #define VMCOREINFO_FORMAT_NONE 0x0
> + #define VMCOREINFO_FORMAT_ELF 0x1
>
> struct FWCfgVMCoreInfo {
> uint16_t host_format; /* formats host supports */
> @@ -26,17 +26,17 @@ The entry of 16 bytes has the following layout, in little-endian::
> Only full write (of 16 bytes) are considered valid for further
> processing of entry values.
>
> -A write of 0 in guest_format will disable further processing of
> +A write of 0 in ``guest_format`` will disable further processing of
> vmcoreinfo entry values & content.
>
> -You may write a guest_format that is not supported by the host, in
> +You may write a ``guest_format`` that is not supported by the host, in
> which case the entry data can be ignored by qemu (but you may still
> -access it through a debugger, via vmcoreinfo_realize::vmcoreinfo_state).
> +access it through a debugger, via ``vmcoreinfo_realize::vmcoreinfo_state``).
>
> Format & content
> -****************
> +================
>
> -As of qemu 2.11, only VMCOREINFO_FORMAT_ELF is supported.
> +As of qemu 2.11, only ``VMCOREINFO_FORMAT_ELF`` is supported.
Maybe s/qemu/QEMU/, otherwise:
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
> The entry gives location and size of an ELF note that is appended in
> qemu dumps.
> @@ -44,10 +44,11 @@ qemu dumps.
> The note format/class must be of the target bitness and the size must
> be less than 1Mb.
>
> -If the ELF note name is "VMCOREINFO", it is expected to be the Linux
> -vmcoreinfo note (see Documentation/ABI/testing/sysfs-kernel-vmcoreinfo
> -in Linux source). In this case, qemu dump code will read the content
> -as a key=value text file, looking for "NUMBER(phys_base)" key
> +If the ELF note name is ``VMCOREINFO``, it is expected to be the Linux
> +vmcoreinfo note (see `the kernel documentation for its format
> +<https://www.kernel.org/doc/Documentation/ABI/testing/sysfs-kernel-vmcoreinfo>`_).
> +In this case, qemu dump code will read the content
> +as a key=value text file, looking for ``NUMBER(phys_base)`` key
> value. The value is expected to be more accurate than architecture
> guess of the value. This is useful for KASLR-enabled guest with
> -ancient tools not handling the VMCOREINFO note.
> +ancient tools not handling the ``VMCOREINFO`` note.
next prev parent reply other threads:[~2023-10-31 15:42 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-27 15:11 [PATCH 0/8] docs/specs: Convert txt files to rST Peter Maydell
2023-09-27 15:11 ` [PATCH 1/8] docs/specs/vmw_pvscsi-spec: Convert " Peter Maydell
2023-10-19 16:38 ` Thomas Huth
2023-09-27 15:11 ` [PATCH 2/8] docs/specs/edu: " Peter Maydell
2023-10-19 16:48 ` Thomas Huth
2023-09-27 15:12 ` [PATCH 3/8] docs/specs/ivshmem-spec: " Peter Maydell
2023-10-31 15:46 ` Philippe Mathieu-Daudé
2023-09-27 15:12 ` [PATCH 4/8] docs/specs/pvpanic: " Peter Maydell
2023-10-31 15:33 ` Philippe Mathieu-Daudé
2023-09-27 15:12 ` [PATCH 5/8] docs/specs/standard-vga: " Peter Maydell
2023-10-31 15:36 ` Philippe Mathieu-Daudé
2023-09-27 15:12 ` [PATCH 6/8] docs/specs/virt-ctlr: " Peter Maydell
2023-10-31 15:39 ` Philippe Mathieu-Daudé
2023-10-31 15:43 ` Peter Maydell
2023-11-08 10:31 ` Philippe Mathieu-Daudé
2023-09-27 15:12 ` [PATCH 7/8] docs/specs/vmcoreinfo: " Peter Maydell
2023-10-31 15:42 ` Philippe Mathieu-Daudé [this message]
2023-11-02 13:35 ` Marc-André Lureau
2023-09-27 15:12 ` [PATCH 8/8] docs/specs/vmgenid: " Peter Maydell
2023-10-31 15:43 ` Philippe Mathieu-Daudé
2023-11-01 11:48 ` Ani Sinha
2023-10-17 12:46 ` [PATCH 0/8] docs/specs: Convert txt files " Peter Maydell
2023-10-31 14:09 ` Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=66663c7e-3ab8-ae62-cd55-52c89bcd7733@linaro.org \
--to=philmd@linaro.org \
--cc=marcandre.lureau@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).