[PATCH 1/1] doc/kvm/api: Fix VM exit code for full dirty ring

[PATCH 1/1] doc/kvm/api: Fix VM exit code for full dirty ring

[Leonardo Bras]

While reading the documentation, I saw a exit code I could not grep for, to
figure out it has a slightly different name.

Fix that name in documentation so it points to the right exit code.

Signed-off-by: Leonardo Bras <leo.bras@arm.com>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 6ae24c5ca559..3382adefc772 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -8503,21 +8503,21 @@ It's not necessary for userspace to harvest the all dirty GFNs at once.
 However it must collect the dirty GFNs in sequence, i.e., the userspace
 program cannot skip one dirty GFN to collect the one next to it.
 
 After processing one or more entries in the ring buffer, userspace
 calls the VM ioctl KVM_RESET_DIRTY_RINGS to notify the kernel about
 it, so that the kernel will reprotect those collected GFNs.
 Therefore, the ioctl must be called *before* reading the content of
 the dirty pages.
 
 The dirty ring can get full.  When it happens, the KVM_RUN of the
-vcpu will return with exit reason KVM_EXIT_DIRTY_LOG_FULL.
+vcpu will return with exit reason KVM_EXIT_DIRTY_RING_FULL.
 
 The dirty ring interface has a major difference comparing to the
 KVM_GET_DIRTY_LOG interface in that, when reading the dirty ring from
 userspace, it's still possible that the kernel has not yet flushed the
 processor's dirty page buffers into the kernel buffer (with dirty bitmaps, the
 flushing is done by the KVM_GET_DIRTY_LOG ioctl).  To achieve that, one
 needs to kick the vcpu out of KVM_RUN using a signal.  The resulting
 vmexit ensures that all dirty GFNs are flushed to the dirty rings.
 
 NOTE: KVM_CAP_DIRTY_LOG_RING_ACQ_REL is the only capability that
-- 
2.50.1 (Apple Git-155)

Re: [PATCH 1/1] doc/kvm/api: Fix VM exit code for full dirty ring

[Sean Christopherson]

On Tue, 14 Oct 2025 16:28:02 +0100, Leonardo Bras wrote:
> While reading the documentation, I saw a exit code I could not grep for, to
> figure out it has a slightly different name.
> 
> Fix that name in documentation so it points to the right exit code.

Applied to kvm-x86 generic, with a massaged shortlog.  Thanks!

[1/1] KVM: Fix VM exit code for full dirty ring in API documentation
      https://github.com/kvm-x86/linux/commit/04fd067b770d

--
https://github.com/kvm-x86/linux/tree/next

Re: [PATCH 1/1] doc/kvm/api: Fix VM exit code for full dirty ring

[Leonardo Bras]

On Mon, Oct 20, 2025 at 09:33:01AM -0700, Sean Christopherson wrote:
> On Tue, 14 Oct 2025 16:28:02 +0100, Leonardo Bras wrote:
> > While reading the documentation, I saw a exit code I could not grep for, to
> > figure out it has a slightly different name.
> > 
> > Fix that name in documentation so it points to the right exit code.
> 
> Applied to kvm-x86 generic, with a massaged shortlog.  Thanks!
> 
> [1/1] KVM: Fix VM exit code for full dirty ring in API documentation
>       https://github.com/kvm-x86/linux/commit/04fd067b770d
> 
> --
> https://github.com/kvm-x86/linux/tree/next

Thanks!
Leo