Commit 01ead84c authored by Zenghui Yu's avatar Zenghui Yu Committed by Paolo Bonzini
Browse files

KVM: Documentation: Update description of KVM_{GET,CLEAR}_DIRTY_LOG 



Update various words, including the wrong parameter name and the vague
description of the usage of "slot" field.

Signed-off-by: default avatarZenghui Yu <yuzenghui@huawei.com>
Message-Id: <20201208043439.895-1-yuzenghui@huawei.com>
Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent 1f7becf1

Documentation/virt/kvm/api.rst

+7 −9
Original line number Original line Diff line number Diff line
@@ -360,10 +360,9 @@ since the last call to this ioctl. Bit 0 is the first page in the 
memory slot.  Ensure the entire structure is cleared to avoid padding

memory slot.  Ensure the entire structure is cleared to avoid padding

issues.

issues.





If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 specifies

If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of slot field specifies

the address space for which you want to return the dirty bitmap.

the address space for which you want to return the dirty bitmap.  See

They must be less than the value that KVM_CHECK_EXTENSION returns for

KVM_SET_USER_MEMORY_REGION for details on the usage of slot field.

the KVM_CAP_MULTI_ADDRESS_SPACE capability.





The bits in the dirty bitmap are cleared before the ioctl returns, unless

The bits in the dirty bitmap are cleared before the ioctl returns, unless

KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2 is enabled.  For more information,

KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2 is enabled.  For more information,
@@ -4435,7 +4434,7 @@ to I/O ports. 
:Capability: KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2

:Capability: KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2

:Architectures: x86, arm, arm64, mips

:Architectures: x86, arm, arm64, mips

:Type: vm ioctl

:Type: vm ioctl

:Parameters: struct kvm_dirty_log (in)

:Parameters: struct kvm_clear_dirty_log (in)

:Returns: 0 on success, -1 on error

:Returns: 0 on success, -1 on error





::

::
@@ -4462,10 +4461,9 @@ in KVM's dirty bitmap, and dirty tracking is re-enabled for that page 
(for example via write-protection, or by clearing the dirty bit in

(for example via write-protection, or by clearing the dirty bit in

a page table entry).

a page table entry).





If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 specifies

If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of slot field specifies

the address space for which you want to return the dirty bitmap.

the address space for which you want to clear the dirty status.  See

They must be less than the value that KVM_CHECK_EXTENSION returns for

KVM_SET_USER_MEMORY_REGION for details on the usage of slot field.

the KVM_CAP_MULTI_ADDRESS_SPACE capability.





This ioctl is mostly useful when KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2

This ioctl is mostly useful when KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2

is enabled; for more information, see the description of the capability.

is enabled; for more information, see the description of the capability.