Skip to contentSkip to conversation

docs: kvm: Fix KVM_KVMCLOCK_CTRL API doc

PATCH Applied Joshua Abraham 2 participants 2 messages May 1, 2020 – May 5, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 docs: kvm: Fix KVM_KVMCLOCK_CTRL API doc

The KVM_KVMCLOCK_CTRL ioctl signals to supported KVM guests that the hypervisor has paused it. Update the documentation to reflect that the guest is notified by this API.

---
Changes in v2:
- Re-word documentation to be clearer. Also fix a small grammar error.

 Documentation/virt/kvm/api.rst | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)
Documentation/virt/kvm/api.rst +7 -5
index efbbe570aa9b..d2c1cbce1018 100644
@@ -2572,13 +2572,15 @@ list in 4.68.
 :Parameters: None
 :Returns: 0 on success, -1 on error
 
-This signals to the host kernel that the specified guest is being paused by
-userspace.  The host will set a flag in the pvclock structure that is checked
-from the soft lockup watchdog.  The flag is part of the pvclock structure that
-is shared between guest and host, specifically the second bit of the flags
+This ioctl sets a flag accessible to the guest indicating that the specified
+vCPU has been paused by the host userspace.
+
+The host will set a flag in the pvclock structure that is checked from the
+soft lockup watchdog.  The flag is part of the pvclock structure that is
+shared between guest and host, specifically the second bit of the flags
 field of the pvclock_vcpu_time_info structure.  It will be set exclusively by
 the host and read/cleared exclusively by the guest.  The guest operation of
-checking and clearing the flag must an atomic operation so
+checking and clearing the flag must be an atomic operation so
 load-link/store-conditional, or equivalent must be used.  There are two cases
 where the guest will clear the flag: when the soft lockup watchdog timer resets
 itself or when a soft lockup is detected.  This ioctl can be called any time
Signature · 1 line
2.17.1
maintainer Applied
#1 lore raw
Quoted 4 lines · On Fri, 1 May 2020 18:36:24 -0400 Joshua Abraham <[email protected]>…

The KVM_KVMCLOCK_CTRL ioctl signals to supported KVM guests that the hypervisor has paused it. Update the documentation to reflect that the guest is notified by this API.

Quoted 8 lines

---
Changes in v2:
- Re-word documentation to be clearer. Also fix a small grammar error.

 Documentation/virt/kvm/api.rst | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

Applied, thanks.

jon