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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <6b781b76-28a9-c375-30cb-ee6764ecd7c8@linux.ibm.com>
Date:   Wed, 1 Dec 2021 09:45:48 +0100
From:   Janosch Frank <frankja@...ux.ibm.com>
To:     Janis Schoetterl-Glausch <scgl@...ux.ibm.com>,
        Christian Borntraeger <borntraeger@...ibm.com>,
        Paolo Bonzini <pbonzini@...hat.com>,
        Jonathan Corbet <corbet@....net>
Cc:     kvm@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] KVM: s390: Fix names of skey constants in api
 documentation

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@...ux.ibm.com>

Thanks for fixing this up.

Reviewed-by: Janosch Frank <frankja@...ux.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
>