linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Joshua Abraham <j.abraham1776@gmail.com>
To: pbonzini@redhat.com
Cc: corbet@lwn.net, kvm@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, j.abraham1776@gmail.com
Subject: [PATCH] docs: kvm: Fix KVM_KVMCLOCK_CTRL API doc
Date: Fri, 1 May 2020 15:34:06 -0400	[thread overview]
Message-ID: <20200501193404.GA19745@josh-ZenBook> (raw)

The KVM_KVMCLOCK_CTRL ioctl signals to supported KVM guests
that the hypervisor has paused it. This updates the documentation 
to reflect that the guest, not the host is notified by this API.

Signed-off-by: Joshua Abraham <j.abraham1776@gmail.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 efbbe570aa9b..06a4d9bfc6e5 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -2572,7 +2572,7 @@ 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
+This signals to the guest 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
-- 
2.17.1


             reply	other threads:[~2020-05-01 19:34 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-01 19:34 Joshua Abraham [this message]
2020-05-01 20:18 ` [PATCH] docs: kvm: Fix KVM_KVMCLOCK_CTRL API doc Sean Christopherson
2020-05-01 20:32   ` Joshua Abraham
2020-05-01 20:51     ` Sean Christopherson
2020-05-01 21:10       ` Joshua Abraham
2020-05-01 21:38         ` Sean Christopherson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200501193404.GA19745@josh-ZenBook \
    --to=j.abraham1776@gmail.com \
    --cc=corbet@lwn.net \
    --cc=kvm@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pbonzini@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).