Skip to content

Commit 01ead84

Browse files
Zenghui Yubonzini
authored andcommitted
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: Zenghui Yu <yuzenghui@huawei.com> Message-Id: <20201208043439.895-1-yuzenghui@huawei.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
1 parent 1f7becf commit 01ead84

1 file changed

Lines changed: 7 additions & 9 deletions

File tree

Documentation/virt/kvm/api.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -360,10 +360,9 @@ since the last call to this ioctl. Bit 0 is the first page in the
360360
memory slot. Ensure the entire structure is cleared to avoid padding
361361
issues.
362362

363-
If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 specifies
364-
the address space for which you want to return the dirty bitmap.
365-
They must be less than the value that KVM_CHECK_EXTENSION returns for
366-
the KVM_CAP_MULTI_ADDRESS_SPACE capability.
363+
If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of slot field specifies
364+
the address space for which you want to return the dirty bitmap. See
365+
KVM_SET_USER_MEMORY_REGION for details on the usage of slot field.
367366

368367
The bits in the dirty bitmap are cleared before the ioctl returns, unless
369368
KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2 is enabled. For more information,
@@ -4435,7 +4434,7 @@ to I/O ports.
44354434
:Capability: KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2
44364435
:Architectures: x86, arm, arm64, mips
44374436
:Type: vm ioctl
4438-
:Parameters: struct kvm_dirty_log (in)
4437+
:Parameters: struct kvm_clear_dirty_log (in)
44394438
:Returns: 0 on success, -1 on error
44404439

44414440
::
@@ -4462,10 +4461,9 @@ in KVM's dirty bitmap, and dirty tracking is re-enabled for that page
44624461
(for example via write-protection, or by clearing the dirty bit in
44634462
a page table entry).
44644463

4465-
If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 specifies
4466-
the address space for which you want to return the dirty bitmap.
4467-
They must be less than the value that KVM_CHECK_EXTENSION returns for
4468-
the KVM_CAP_MULTI_ADDRESS_SPACE capability.
4464+
If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of slot field specifies
4465+
the address space for which you want to clear the dirty status. See
4466+
KVM_SET_USER_MEMORY_REGION for details on the usage of slot field.
44694467

44704468
This ioctl is mostly useful when KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2
44714469
is enabled; for more information, see the description of the capability.

0 commit comments

Comments
 (0)