Re: [PATCH v6 2/4] docs: add WHPX section with initial info

[Paolo Bonzini <pbonzini@redhat.com>]

On 3/27/26 02:11, Mohamed Mediouni wrote:
> Signed-off-by: Mohamed Mediouni <mohamed@unpredictable.fr>
> ---
>   MAINTAINERS           |   1 +
>   docs/system/index.rst |   1 +
>   docs/system/whpx.rst  | 144 ++++++++++++++++++++++++++++++++++++++++++
>   3 files changed, 146 insertions(+)
>   create mode 100644 docs/system/whpx.rst

Needs a few fixes since this is rST not Markdown:

diff --git a/docs/system/whpx.rst b/docs/system/whpx.rst
index 2f906ec5866..3e1979028c9 100644
--- a/docs/system/whpx.rst
+++ b/docs/system/whpx.rst
@@ -5,8 +5,8 @@ Windows Hypervisor Platform is the Windows API for use of
  third-party virtual machine monitors with hardware acceleration
  on Hyper-V.
  
-It's implemented on top of `Vid`, which is itself implemented
-on the same set of hypercalls as the `mshv` driver on Linux.
+It's implemented on top of ``Vid``, which is itself implemented
+on the same set of hypercalls as the ``mshv`` driver on Linux.
  
  WHPX is the name of the Windows Hypervisor Platform accelerator
  backend in QEMU. It enables using QEMU with hardware acceleration
@@ -20,11 +20,11 @@ WHPX requires the Windows Hypervisor Platform feature to be installed.
  Installation
  ^^^^^^^^^^^^
  On client editions of Windows, that means installation through
-Windows Features (`optionalfeatures.exe`). On server editions,
+Windows Features (``optionalfeatures.exe``). On server editions,
  feature-based installation in Server Manager can be used.
  
  Alternatively, command line installation is also possible through:
-`DISM /online /Enable-Feature /FeatureName:HypervisorPlatform /All`
+``DISM /online /Enable-Feature /FeatureName:HypervisorPlatform /All``
  
  Minimum OS version
  ^^^^^^^^^^^^^^^^^^
@@ -58,8 +58,8 @@ Launching a virtual machine on arm64 with WHPX acceleration::
          -device usb-kbd -device usb-tablet \
          -hda OS.qcow2
  
-On arm64, for non-Windows guests, `-device virtio-gpu-pci` provides
-additional fuctionality compared to `-device ramfb`, but is
+On arm64, for non-Windows guests, ``-device virtio-gpu-pci`` provides
+additional functionality compared to ``-device ramfb``, but is
  incompatible with Windows's UEFI GOP implementation, which
  expects a linear framebuffer to be available.
  
@@ -69,10 +69,10 @@ Some tracing options
  x86_64
  ^^^^^^
  
-`-trace whpx_unsupported_msr_access` can be used to log accesses
+``-trace whpx_unsupported_msr_access`` can be used to log accesses
  to undocumented MSRs.
  
-`-d invalid_mem` allows to trace accesses to unmapped
+``-d invalid_mem`` allows to trace accesses to unmapped
  GPAs.
  
  Known issues on x86_64
@@ -88,19 +88,19 @@ Workaround: for affected guests, use a more modern graphics mode.
  Alternatively, use TCG to run those guests.
  
  Guests using MMX, SSE or AVX instructions for MMIO
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  
-Currently, `target/i386/emulate` does not support guests that use
+Currently, ``target/i386/emulate`` does not support guests that use
  MMX, SSE or AVX instructions for access to MMIO memory ranges.
  
-Attempts to run such guests will result in an `Unimplemented handler`
+Attempts to run such guests will result in an ``Unimplemented handler``
  warning for MMX and a failure to decode for newer instructions.
  
-`-M isapc`
-^^^^^^^^^^
+``-M isapc``
+^^^^^^^^^^^^
  
-`-M isapc` doesn't disable the Hyper-V LAPIC on its own yet. To
-be able to use that machine, use `-accel whpx,hyperv=off,kernel-irqchip=off`.
+``-M isapc`` doesn't disable the Hyper-V LAPIC on its own yet. To
+be able to use that machine, use ``-accel whpx,hyperv=off,kernel-irqchip=off``.
  
  However, in QEMU 11.0, the guest will still be a 64-bit x86
  ISA machine with all the corresponding CPUID leaves exposed.
@@ -111,10 +111,10 @@ gdbstub
  As save/restore of xsave state is not currently present, state
  exposed through GDB will be incomplete.
  
-The same also applies to `info registers`.
+The same also applies to ``info registers``.
  
--cpu `type` ignored
-^^^^^^^^^^^^^^^^^^^
+``-cpu type`` ignored
+^^^^^^^^^^^^^^^^^^^^^
  
  In this release, -cpu is an ignored argument.
  
@@ -127,7 +127,7 @@ from an HLT when using the Hyper-V provided interrupt controller.
  This has been addressed in QEMU 11.0 on Windows 11 platforms but
  functionality to make it available on Windows 10 isn't present.
  
-Workaround: for affected use cases, use `-M kernel-irqchip=off`.
+Workaround: for affected use cases, use ``-M kernel-irqchip=off``.
  
  Known issues on Windows 11
  ^^^^^^^^^^^^^^^^^^^^^^^^^^

Adjust and applied, thanks.

Paolo