Linux Documentation
 help / color / mirror / Atom feed
From: Zenghui Yu <yuzenghui@huawei.com>
To: Fuad Tabba <fuad.tabba@linux.dev>
Cc: Paolo Bonzini <pbonzini@redhat.com>,
	Sean Christopherson <seanjc@google.com>, <kvm@vger.kernel.org>,
	<linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Christian Borntraeger <borntraeger@linux.ibm.com>,
	Janosch Frank <frankja@linux.ibm.com>,
	Claudio Imbrenda <imbrenda@linux.ibm.com>,
	Huacai Chen <chenhuacai@kernel.org>, <linux-mips@vger.kernel.org>,
	Will Deacon <will@kernel.org>, Fuad Tabba <tabba@google.com>
Subject: Re: [PATCH 1/7] Documentation: KVM: Fix references to non-existent identifiers
Date: Mon, 16 Nov 2026 17:32:37 +0800	[thread overview]
Message-ID: <f2f36f67-a993-735e-39d3-70e22ce6c87f@huawei.com> (raw)
In-Reply-To: <20261111085448.1130701-2-fuad.tabba@linux.dev>

Hi Fuad,

On 2026/11/11 16:54, Fuad Tabba wrote:
> The KVM API documentation and the review checklist refer to
> non-existent ioctls, capabilities, structures, fields and constants.
> Use the names from the uAPI headers.
> 
> Signed-off-by: Fuad Tabba <fuad.tabba@linux.dev>
> ---
>  Documentation/virt/kvm/api.rst              | 40 ++++++++++-----------
>  Documentation/virt/kvm/review-checklist.rst |  2 +-
>  2 files changed, 21 insertions(+), 21 deletions(-)
> 
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index e95c9cda085d9..ccdc210575e25 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -897,7 +897,7 @@ x86 allows the operating system to program the interrupt polarity
>  (active-low/active-high) for level-triggered interrupts, and KVM used
>  to consider the polarity.  However, due to bitrot in the handling of
>  active-low interrupts, the above convention is now valid on x86 too.
> -This is signaled by KVM_CAP_X86_IOAPIC_POLARITY_IGNORED.  Userspace
> +This is signaled by KVM_CAP_IOAPIC_POLARITY_IGNORED.  Userspace
>  should not present interrupts to the guest as active-low unless this
>  capability is present (or unless it is not using the in-kernel irqchip,
>  of course).
> @@ -941,7 +941,7 @@ be used for a userspace interrupt controller.
>    struct kvm_irq_level {
>  	union {
>  		__u32 irq;     /* GSI */
> -		__s32 status;  /* not used for KVM_IRQ_LEVEL */
> +		__s32 status;  /* not used for KVM_IRQ_LINE */
>  	};
>  	__u32 level;           /* 0 or 1 */
>    };
> @@ -3219,7 +3219,7 @@ With KVM_CAP_IRQFD_RESAMPLE, KVM_IRQFD supports a de-assert and notify
>  mechanism allowing emulation of level-triggered, irqfd-based
>  interrupts.  When KVM_IRQFD_FLAG_RESAMPLE is set the user must pass an
>  additional eventfd in the kvm_irqfd.resamplefd field.  When operating
> -in resample mode, posting of an interrupt through kvm_irq.fd asserts
> +in resample mode, posting of an interrupt through kvm_irqfd.fd asserts
>  the specified gsi in the irqchip.  When the irqchip is resampled, such
>  as from an EOI, the gsi is de-asserted and the user is notified via
>  kvm_irqfd.resamplefd.  It is the user's responsibility to re-queue
> @@ -4982,8 +4982,8 @@ Errors:
>    #define KVM_STATE_NESTED_VMX_VMCS_SIZE	0x1000
>    #define KVM_STATE_NESTED_SVM_VMCB_SIZE	0x1000
>  
> -  #define KVM_STATE_NESTED_VMX_SMM_GUEST_MODE	0x00000001
> -  #define KVM_STATE_NESTED_VMX_SMM_VMXON	0x00000002
> +  #define KVM_STATE_NESTED_SMM_GUEST_MODE	0x00000001
> +  #define KVM_STATE_NESTED_SMM_VMXON		0x00000002
>  
>    #define KVM_STATE_NESTED_GIF_SET		0x00000100
>  
> @@ -5448,14 +5448,14 @@ KVM_PV_DISABLE
>    KVM_PV_ASYNC_CLEANUP_PERFORM, it will be torn down in this call
>    together with the current protected VM.
>  
> -KVM_PV_VM_SET_SEC_PARMS
> +KVM_PV_SET_SEC_PARMS
>    Pass the image header from VM memory to the Ultravisor in
>    preparation of image unpacking and verification.
>  
> -KVM_PV_VM_UNPACK
> +KVM_PV_UNPACK
>    Unpack (protect and decrypt) a page of the encrypted boot image.
>  
> -KVM_PV_VM_VERIFY
> +KVM_PV_VERIFY
>    Verify the integrity of the unpacked image. Only if this succeeds,
>    KVM is allowed to start protected VCPUs.
>  
> @@ -5951,7 +5951,7 @@ This ioctl (when supported) replaces the KVM_SET_SREGS.
>  4.133 KVM_GET_STATS_FD
>  ----------------------
>  
> -:Capability: KVM_CAP_STATS_BINARY_FD
> +:Capability: KVM_CAP_BINARY_STATS_FD
>  :Architectures: all
>  :Type: vm ioctl, vcpu ioctl
>  :Parameters: none
> @@ -6087,10 +6087,10 @@ Bits 0-3 of ``flags`` encode the type:
>    * ``KVM_STATS_TYPE_LINEAR_HIST``
>      The statistic is reported as a linear histogram. The number of
>      buckets is specified by the ``size`` field. The size of buckets is specified
> -    by the ``hist_param`` field. The range of the Nth bucket (1 <= N < ``size``)
> -    is [``hist_param``*(N-1), ``hist_param``*N), while the range of the last
> -    bucket is [``hist_param``*(``size``-1), +INF). (+INF means positive infinity
> -    value.)
> +    by the ``bucket_size`` field. The range of the Nth bucket
> +    (1 <= N < ``size``) is [``bucket_size``*(N-1), ``bucket_size``*N), while
> +    the range of the last bucket is [``bucket_size``*(``size``-1), +INF).
> +    (+INF means positive infinity value.)

Could we fix the broken reST while we're at it? I mean

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index ccdc210575e2..4c7fece10aa3 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -6088,8 +6088,8 @@ Bits 0-3 of ``flags`` encode the type:
     The statistic is reported as a linear histogram. The number of
     buckets is specified by the ``size`` field. The size of buckets is specified
     by the ``bucket_size`` field. The range of the Nth bucket
-    (1 <= N < ``size``) is [``bucket_size``*(N-1), ``bucket_size``*N), while
-    the range of the last bucket is [``bucket_size``*(``size``-1), +INF).
+    (1 <= N < ``size``) is [``bucket_size`` * (N-1), ``bucket_size`` * N), while
+    the range of the last bucket is [``bucket_size`` * (``size``-1), +INF).
     (+INF means positive infinity value.)
   * ``KVM_STATS_TYPE_LOG_HIST``
     The statistic is reported as a logarithmic histogram. The number of

The patch itself looks good to me.

Thanks,
Zenghui

  parent reply	other threads:[~2026-11-16  9:32 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-11  8:54 [PATCH 0/7] KVM: Documentation and comment fixes Fuad Tabba
2026-11-11  8:54 ` [PATCH 1/7] Documentation: KVM: Fix references to non-existent identifiers Fuad Tabba
2026-11-16  1:30   ` Randy Dunlap
2026-11-16  9:32   ` Zenghui Yu [this message]
2026-11-16  9:56     ` Fuad Tabba
2026-11-11  8:54 ` [PATCH 2/7] Documentation: KVM: Fix lock names and a lock type in locking.rst Fuad Tabba
2026-11-11  8:54 ` [PATCH 3/7] Documentation: KVM: Fix the function that implements halt polling Fuad Tabba
2026-11-16  1:37   ` Randy Dunlap
2026-11-11  8:54 ` [PATCH 4/7] Documentation: KVM: Drop the stale number of vCPU request flags Fuad Tabba
2026-11-16  1:39   ` Randy Dunlap
2026-11-11  8:54 ` [PATCH 5/7] KVM: Fix comments that refer to non-existent identifiers Fuad Tabba
2026-11-11 21:31   ` Randy Dunlap
2026-11-16 11:56   ` Zenghui Yu
2026-11-11  8:54 ` [PATCH 6/7] KVM: Fix the range of reserved arch-independent request bits Fuad Tabba
2026-11-11  8:54 ` [PATCH 7/7] KVM: Fix typos in comments Fuad Tabba
2026-11-11 17:05   ` Randy Dunlap
2026-11-16  9:57     ` Fuad Tabba
2026-11-16 11:58 ` [PATCH 0/7] KVM: Documentation and comment fixes Zenghui Yu

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=f2f36f67-a993-735e-39d3-70e22ce6c87f@huawei.com \
    --to=yuzenghui@huawei.com \
    --cc=borntraeger@linux.ibm.com \
    --cc=chenhuacai@kernel.org \
    --cc=corbet@lwn.net \
    --cc=frankja@linux.ibm.com \
    --cc=fuad.tabba@linux.dev \
    --cc=imbrenda@linux.ibm.com \
    --cc=kvm@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mips@vger.kernel.org \
    --cc=pbonzini@redhat.com \
    --cc=seanjc@google.com \
    --cc=tabba@google.com \
    --cc=will@kernel.org \
    /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