[PATCH next] Documentation: KVM: fix reference for kvm_ppc_resize_hpt and various typos

[PATCH next] Documentation: KVM: fix reference for kvm_ppc_resize_hpt and various typos

[Alok Tiwari]

Fix the incorrect reference to struct kvm_reinject_control and replace
it with the correct struct kvm_ppc_resize_hpt in the documentation of
the HPT resize ioctl.

Also correct several minor typos throughout api.rst, including grammar
issues, capitalization (e.g., "SError"), and punctuation fixes.

Signed-off-by: Alok Tiwari <alok.a.tiwari@oracle.com>
---
 Documentation/virt/kvm/api.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index f0d961436d0f..04ac699e7885 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -88,7 +88,7 @@ the VM is shut down.
 =============
 
 As of Linux 2.6.22, the KVM ABI has been stabilized: no backward
-incompatible change are allowed.  However, there is an extension
+incompatible changes are allowed.  However, there is an extension
 facility that allows backward-compatible extensions to the API to be
 queried and used.
 
@@ -1198,7 +1198,7 @@ pending until the guest takes the exception by unmasking PSTATE.A.
 
 Running the VCPU may cause it to take a pending SError, or make an access that
 causes an SError to become pending. The event's description is only valid while
-the VPCU is not running.
+the VCPU is not running.
 
 This API provides a way to read and write the pending 'event' state that is not
 visible to the guest. To save, restore or migrate a VCPU the struct representing
@@ -1293,7 +1293,7 @@ ARM64:
 User space may need to inject several types of events to the guest.
 
 Set the pending SError exception state for this VCPU. It is not possible to
-'cancel' an Serror that has been made pending.
+'cancel' an SError that has been made pending.
 
 If the guest performed an access to I/O memory which could not be handled by
 userspace, for example because of missing instruction syndrome decode
@@ -1832,7 +1832,7 @@ emulate them efficiently. The fields in each entry are defined as follows:
          the values returned by the cpuid instruction for
          this function/index combination
 
-x2APIC (CPUID leaf 1, ecx[21) and TSC deadline timer (CPUID leaf 1, ecx[24])
+x2APIC (CPUID leaf 1, ecx[21]) and TSC deadline timer (CPUID leaf 1, ecx[24])
 may be returned as true, but they depend on KVM_CREATE_IRQCHIP for in-kernel
 emulation of the local APIC.  TSC deadline timer support is also reported via::
 
@@ -3215,8 +3215,8 @@ default-sized hash table (16 MB).
 
 If this ioctl is called when a hash table has already been allocated,
 with a different order from the existing hash table, the existing hash
-table will be freed and a new one allocated.  If this is ioctl is
-called when a hash table has already been allocated of the same order
+table will be freed and a new one allocated. If this ioctl is called
+when a hash table has already been allocated of the same order
 as specified, the kernel will clear out the existing hash table (zero
 all HPTEs).  In either case, if the guest is using the virtualized
 real-mode area (VRMA) facility, the kernel will re-create the VMRA
@@ -4427,7 +4427,7 @@ base 2 of the page size in the bottom 6 bits.
 :Returns: 0 on successful completion,
 	 >0 if a new HPT is being prepared, the value is an estimated
          number of milliseconds until preparation is complete,
-         -EFAULT if struct kvm_reinject_control cannot be read,
+         -EFAULT if struct kvm_ppc_resize_hpt cannot be read,
 	 -EINVAL if the supplied shift or flags are invalid,
 	 -ENOMEM if unable to allocate the new HPT,
 
@@ -4481,7 +4481,7 @@ ones will monitor preparation until it completes or fails.
 :Returns: 0 on successful completion,
          -EFAULT if struct kvm_reinject_control cannot be read,
 	 -EINVAL if the supplied shift or flags are invalid,
-	 -ENXIO is there is no pending HPT, or the pending HPT doesn't
+	 -ENXIO if there is no pending HPT, or the pending HPT doesn't
          have the requested size,
 	 -EBUSY if the pending HPT is not fully prepared,
 	 -ENOSPC if there was a hash collision when moving existing
@@ -8884,7 +8884,7 @@ This capability indicates that KVM supports steal time accounting.
 When steal time accounting is supported it may be enabled with
 architecture-specific interfaces.  This capability and the architecture-
 specific interfaces must be consistent, i.e. if one says the feature
-is supported, than the other should as well and vice versa.  For arm64
+is supported, then the other should as well and vice versa.  For arm64
 see Documentation/virt/kvm/devices/vcpu.rst "KVM_ARM_VCPU_PVTIME_CTRL".
 For x86 see Documentation/virt/kvm/x86/msr.rst "MSR_KVM_STEAL_TIME".
 
@@ -8924,7 +8924,7 @@ KVM_EXIT_X86_WRMSR exit notifications.
 
 :Architectures: x86
 
-This capability indicates that KVM supports that accesses to user defined MSRs
+This capability indicates that KVM supports accesses to user defined MSRs
 may be rejected. With this capability exposed, KVM exports new VM ioctl
 KVM_X86_SET_MSR_FILTER which user space can call to specify bitmaps of MSR
 ranges that KVM should deny access to.
-- 
2.46.0

Re: [PATCH next] Documentation: KVM: fix reference for kvm_ppc_resize_hpt and various typos

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1063 bytes --]

On Mon, Jun 23, 2025 at 12:11:47PM -0700, Alok Tiwari wrote:
>  If this ioctl is called when a hash table has already been allocated,
>  with a different order from the existing hash table, the existing hash
> -table will be freed and a new one allocated.  If this is ioctl is
> -called when a hash table has already been allocated of the same order
> +table will be freed and a new one allocated. If this ioctl is called
> +when a hash table has already been allocated of the same order

Two spaces between sentences (just to be consistent), please.

> -This capability indicates that KVM supports that accesses to user defined MSRs
> +This capability indicates that KVM supports accesses to user defined MSRs
>  may be rejected. With this capability exposed, KVM exports new VM ioctl
>  KVM_X86_SET_MSR_FILTER which user space can call to specify bitmaps of MSR
>  ranges that KVM should deny access to.

Do you mean accesses to user defined MSRs *that* may be rejected?

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH next] Documentation: KVM: fix reference for kvm_ppc_resize_hpt and various typos

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> On Mon, Jun 23, 2025 at 12:11:47PM -0700, Alok Tiwari wrote:
>>  If this ioctl is called when a hash table has already been allocated,
>>  with a different order from the existing hash table, the existing hash
>> -table will be freed and a new one allocated.  If this is ioctl is
>> -called when a hash table has already been allocated of the same order
>> +table will be freed and a new one allocated. If this ioctl is called
>> +when a hash table has already been allocated of the same order
>
> Two spaces between sentences (just to be consistent), please.

Spaces after periods are explicitly documented as something we do not
"correct" or harass our contributors about.  Please, for the Nth time,
do not add unnecessary friction to the process of improving our
documentation.

jon

Re: [PATCH next] Documentation: KVM: fix reference for kvm_ppc_resize_hpt and various typos

[Bagas Sanjaya]

On 6/24/25 19:42, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
>> On Mon, Jun 23, 2025 at 12:11:47PM -0700, Alok Tiwari wrote:
>>>   If this ioctl is called when a hash table has already been allocated,
>>>   with a different order from the existing hash table, the existing hash
>>> -table will be freed and a new one allocated.  If this is ioctl is
>>> -called when a hash table has already been allocated of the same order
>>> +table will be freed and a new one allocated. If this ioctl is called
>>> +when a hash table has already been allocated of the same order
>>
>> Two spaces between sentences (just to be consistent), please.
> 
> Spaces after periods are explicitly documented as something we do not
> "correct" or harass our contributors about.  Please, for the Nth time,
> do not add unnecessary friction to the process of improving our
> documentation.
> 

OK, thanks!

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH next] Documentation: KVM: fix reference for kvm_ppc_resize_hpt and various typos

[ALOK TIWARI]

On 6/24/2025 4:54 AM, Bagas Sanjaya wrote:
>> -This capability indicates that KVM supports that accesses to user defined MSRs
>> +This capability indicates that KVM supports accesses to user defined MSRs
>>   may be rejected. With this capability exposed, KVM exports new VM ioctl
>>   KVM_X86_SET_MSR_FILTER which user space can call to specify bitmaps of MSR
>>   ranges that KVM should deny access to.
> Do you mean accesses to user defined MSRs*that* may be rejected?

Do you want me to undo this change and go back to the earlier one?

> 
> Thanks.

Do I need to send a new patch?

Thanks,
Alok

Re: [PATCH next] Documentation: KVM: fix reference for kvm_ppc_resize_hpt and various typos

[Bagas Sanjaya]

On 6/25/25 21:00, ALOK TIWARI wrote:
> 
> 
> On 6/24/2025 4:54 AM, Bagas Sanjaya wrote:
>>> -This capability indicates that KVM supports that accesses to user 
>>> defined MSRs
>>> +This capability indicates that KVM supports accesses to user defined 
>>> MSRs
>>>   may be rejected. With this capability exposed, KVM exports new VM 
>>> ioctl
>>>   KVM_X86_SET_MSR_FILTER which user space can call to specify bitmaps 
>>> of MSR
>>>   ranges that KVM should deny access to.
>> Do you mean accesses to user defined MSRs*that* may be rejected?
> 
> Do you want me to undo this change and go back to the earlier one?
> 

Nope but I need clarification.

>>
>> Thanks.
> 
> Do I need to send a new patch?
> 

Maybe.

-- 
An old man doll... just what I always wanted! - Clara