[PATCH] KVM: s390: Fix names of skey constants in api documentation

[PATCH] KVM: s390: Fix names of skey constants in api documentation

[Janis Schoetterl-Glausch]

The are defined in include/uapi/linux/kvm.h as
KVM_S390_GET_SKEYS_NONE and KVM_S390_SKEYS_MAX, but the
api documetation talks of KVM_S390_GET_KEYS_NONE and
KVM_S390_SKEYS_ALLOC_MAX respectively.

Signed-off-by: Janis Schoetterl-Glausch <scgl@linux.ibm.com>
---
 Documentation/virt/kvm/api.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index aeeb071c7688..b86c7edae888 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -3701,7 +3701,7 @@ KVM with the currently defined set of flags.
 :Architectures: s390
 :Type: vm ioctl
 :Parameters: struct kvm_s390_skeys
-:Returns: 0 on success, KVM_S390_GET_KEYS_NONE if guest is not using storage
+:Returns: 0 on success, KVM_S390_GET_SKEYS_NONE if guest is not using storage
           keys, negative value on error
 
 This ioctl is used to get guest storage key values on the s390
@@ -3720,7 +3720,7 @@ you want to get.
 
 The count field is the number of consecutive frames (starting from start_gfn)
 whose storage keys to get. The count field must be at least 1 and the maximum
-allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
+allowed value is defined as KVM_S390_SKEYS_MAX. Values outside this range
 will cause the ioctl to return -EINVAL.
 
 The skeydata_addr field is the address to a buffer large enough to hold count
@@ -3744,7 +3744,7 @@ you want to set.
 
 The count field is the number of consecutive frames (starting from start_gfn)
 whose storage keys to get. The count field must be at least 1 and the maximum
-allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
+allowed value is defined as KVM_S390_SKEYS_MAX. Values outside this range
 will cause the ioctl to return -EINVAL.
 
 The skeydata_addr field is the address to a buffer containing count bytes of
-- 
2.25.1

Re: [PATCH] KVM: s390: Fix names of skey constants in api documentation

[Janosch Frank]

On 11/18/21 11:25, Janis Schoetterl-Glausch wrote:
> The are defined in include/uapi/linux/kvm.h as

s/The/They/

I can fix that up when picking if you want.

> KVM_S390_GET_SKEYS_NONE and KVM_S390_SKEYS_MAX, but the
> api documetation talks of KVM_S390_GET_KEYS_NONE and
> KVM_S390_SKEYS_ALLOC_MAX respectively.
> 
> Signed-off-by: Janis Schoetterl-Glausch <scgl@linux.ibm.com>

Thanks for fixing this up.

Reviewed-by: Janosch Frank <frankja@linux.ibm.com>

> ---
>   Documentation/virt/kvm/api.rst | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index aeeb071c7688..b86c7edae888 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -3701,7 +3701,7 @@ KVM with the currently defined set of flags.
>   :Architectures: s390
>   :Type: vm ioctl
>   :Parameters: struct kvm_s390_skeys
> -:Returns: 0 on success, KVM_S390_GET_KEYS_NONE if guest is not using storage
> +:Returns: 0 on success, KVM_S390_GET_SKEYS_NONE if guest is not using storage
>             keys, negative value on error
>   
>   This ioctl is used to get guest storage key values on the s390
> @@ -3720,7 +3720,7 @@ you want to get.
>   
>   The count field is the number of consecutive frames (starting from start_gfn)
>   whose storage keys to get. The count field must be at least 1 and the maximum
> -allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
> +allowed value is defined as KVM_S390_SKEYS_MAX. Values outside this range
>   will cause the ioctl to return -EINVAL.
>   
>   The skeydata_addr field is the address to a buffer large enough to hold count
> @@ -3744,7 +3744,7 @@ you want to set.
>   
>   The count field is the number of consecutive frames (starting from start_gfn)
>   whose storage keys to get. The count field must be at least 1 and the maximum
> -allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
> +allowed value is defined as KVM_S390_SKEYS_MAX. Values outside this range
>   will cause the ioctl to return -EINVAL.
>   
>   The skeydata_addr field is the address to a buffer containing count bytes of
> 

Re: [PATCH] KVM: s390: Fix names of skey constants in api documentation

[Janis Schoetterl-Glausch]

On 12/1/21 09:45, Janosch Frank wrote:
> On 11/18/21 11:25, Janis Schoetterl-Glausch wrote:
>> The are defined in include/uapi/linux/kvm.h as
> 
> s/The/They/
> 
> I can fix that up when picking if you want.

Thanks, please do.
> 
>> KVM_S390_GET_SKEYS_NONE and KVM_S390_SKEYS_MAX, but the
>> api documetation talks of KVM_S390_GET_KEYS_NONE and
>> KVM_S390_SKEYS_ALLOC_MAX respectively.
>>
>> Signed-off-by: Janis Schoetterl-Glausch <scgl@linux.ibm.com>
> 
> Thanks for fixing this up.
> 
> Reviewed-by: Janosch Frank <frankja@linux.ibm.com>
> 
>> ---
>>   Documentation/virt/kvm/api.rst | 6 +++---
>>   1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
>> index aeeb071c7688..b86c7edae888 100644
>> --- a/Documentation/virt/kvm/api.rst
>> +++ b/Documentation/virt/kvm/api.rst
>> @@ -3701,7 +3701,7 @@ KVM with the currently defined set of flags.
>>   :Architectures: s390
>>   :Type: vm ioctl
>>   :Parameters: struct kvm_s390_skeys
>> -:Returns: 0 on success, KVM_S390_GET_KEYS_NONE if guest is not using storage
>> +:Returns: 0 on success, KVM_S390_GET_SKEYS_NONE if guest is not using storage
>>             keys, negative value on error
>>     This ioctl is used to get guest storage key values on the s390
>> @@ -3720,7 +3720,7 @@ you want to get.
>>     The count field is the number of consecutive frames (starting from start_gfn)
>>   whose storage keys to get. The count field must be at least 1 and the maximum
>> -allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
>> +allowed value is defined as KVM_S390_SKEYS_MAX. Values outside this range
>>   will cause the ioctl to return -EINVAL.
>>     The skeydata_addr field is the address to a buffer large enough to hold count
>> @@ -3744,7 +3744,7 @@ you want to set.
>>     The count field is the number of consecutive frames (starting from start_gfn)
>>   whose storage keys to get. The count field must be at least 1 and the maximum
>> -allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
>> +allowed value is defined as KVM_S390_SKEYS_MAX. Values outside this range
>>   will cause the ioctl to return -EINVAL.
>>     The skeydata_addr field is the address to a buffer containing count bytes of
>>
> 

Re: [PATCH] KVM: s390: Fix names of skey constants in api documentation

[Janosch Frank]

On 12/2/21 11:31, Janis Schoetterl-Glausch wrote:
> On 12/1/21 09:45, Janosch Frank wrote:
>> On 11/18/21 11:25, Janis Schoetterl-Glausch wrote:
>>> The are defined in include/uapi/linux/kvm.h as
>>
>> s/The/They/
>>
>> I can fix that up when picking if you want.
> 
> Thanks, please do.
>>
>>> KVM_S390_GET_SKEYS_NONE and KVM_S390_SKEYS_MAX, but the
>>> api documetation talks of KVM_S390_GET_KEYS_NONE and
>>> KVM_S390_SKEYS_ALLOC_MAX respectively.
>>>
>>> Signed-off-by: Janis Schoetterl-Glausch <scgl@linux.ibm.com>
>>
>> Thanks for fixing this up.

Thanks, picked

>>
>> Reviewed-by: Janosch Frank <frankja@linux.ibm.com>
>>
>>> ---
>>>    Documentation/virt/kvm/api.rst | 6 +++---
>>>    1 file changed, 3 insertions(+), 3 deletions(-)
>>>
>>> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
>>> index aeeb071c7688..b86c7edae888 100644
>>> --- a/Documentation/virt/kvm/api.rst
>>> +++ b/Documentation/virt/kvm/api.rst
>>> @@ -3701,7 +3701,7 @@ KVM with the currently defined set of flags.
>>>    :Architectures: s390
>>>    :Type: vm ioctl
>>>    :Parameters: struct kvm_s390_skeys
>>> -:Returns: 0 on success, KVM_S390_GET_KEYS_NONE if guest is not using storage
>>> +:Returns: 0 on success, KVM_S390_GET_SKEYS_NONE if guest is not using storage
>>>              keys, negative value on error
>>>      This ioctl is used to get guest storage key values on the s390
>>> @@ -3720,7 +3720,7 @@ you want to get.
>>>      The count field is the number of consecutive frames (starting from start_gfn)
>>>    whose storage keys to get. The count field must be at least 1 and the maximum
>>> -allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
>>> +allowed value is defined as KVM_S390_SKEYS_MAX. Values outside this range
>>>    will cause the ioctl to return -EINVAL.
>>>      The skeydata_addr field is the address to a buffer large enough to hold count
>>> @@ -3744,7 +3744,7 @@ you want to set.
>>>      The count field is the number of consecutive frames (starting from start_gfn)
>>>    whose storage keys to get. The count field must be at least 1 and the maximum
>>> -allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
>>> +allowed value is defined as KVM_S390_SKEYS_MAX. Values outside this range
>>>    will cause the ioctl to return -EINVAL.
>>>      The skeydata_addr field is the address to a buffer containing count bytes of
>>>
>>
>