diff mbox series

qapi: Document QCryptodevBackendServiceType

Message ID 20240812014252.1398754-1-pizhenwei@bytedance.com
State New
Headers show
Series qapi: Document QCryptodevBackendServiceType | expand

Commit Message

zhenwei pi Aug. 12, 2024, 1:42 a.m. UTC
QCryptodevBackendServiceType was introduced by
bc304a6442e (cryptodev: Introduce server type in QAPI). However there
is a lack of member description. Thanks to Markus for pointing out
this.

Signed-off-by: zhenwei pi <pizhenwei@bytedance.com>
---
 qapi/cryptodev.json | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Philippe Mathieu-Daudé Aug. 12, 2024, 6:14 a.m. UTC | #1
On 12/8/24 03:42, zhenwei pi wrote:
> QCryptodevBackendServiceType was introduced by
> bc304a6442e (cryptodev: Introduce server type in QAPI). However there
> is a lack of member description. Thanks to Markus for pointing out
> this.
> 
> Signed-off-by: zhenwei pi <pizhenwei@bytedance.com>
> ---
>   qapi/cryptodev.json | 10 ++++++++++
>   1 file changed, 10 insertions(+)
> 
> diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json
> index 68289f4984..9622c6d92b 100644
> --- a/qapi/cryptodev.json
> +++ b/qapi/cryptodev.json
> @@ -28,6 +28,16 @@
>   #
>   # The supported service types of a crypto device.
>   #
> +# @cipher: Symmetric Key Cipher service
> +#
> +# @hash: Hash service
> +#
> +# @mac: Message Authentication Codes service
> +#
> +# @aead: Authenticated Encryption with Associated Data service
> +#
> +# @akcipher: Asymmetric Key Cipher service

Can we drop all trailing "service"s?

> +#
>   # Since: 8.0
>   ##
>   { 'enum': 'QCryptodevBackendServiceType',
zhenwei pi Aug. 13, 2024, 1:51 a.m. UTC | #2
On 8/12/24 14:14, Philippe Mathieu-Daudé wrote:
> On 12/8/24 03:42, zhenwei pi wrote:
>> QCryptodevBackendServiceType was introduced by
>> bc304a6442e (cryptodev: Introduce server type in QAPI). However there
>> is a lack of member description. Thanks to Markus for pointing out
>> this.
>>
>> Signed-off-by: zhenwei pi
>> ---
>> qapi/cryptodev.json | 10 ++++++++++
>> 1 file changed, 10 insertions(+)
>>
>> diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json
>> index 68289f4984..9622c6d92b 100644
>> --- a/qapi/cryptodev.json
>> +++ b/qapi/cryptodev.json
>> @@ -28,6 +28,16 @@
>> #
>> # The supported service types of a crypto device.
>> #
>> +# @cipher: Symmetric Key Cipher service
>> +#
>> +# @hash: Hash service
>> +#
>> +# @mac: Message Authentication Codes service
>> +#
>> +# @aead: Authenticated Encryption with Associated Data service
>> +#
>> +# @akcipher: Asymmetric Key Cipher service
>
> Can we drop all trailing "service"s?
>

I copied these descriptions from virtio-crypto spec. Removing them also
is fine to me.

>> +#
>> # Since: 8.0
>> ##
>> { 'enum': 'QCryptodevBackendServiceType',
>
zhenwei pi Aug. 20, 2024, 3:46 a.m. UTC | #3
Hi Markus,

This seems to be ignored...

On 8/13/24 09:51, zhenwei pi wrote:
> On 8/12/24 14:14, Philippe Mathieu-Daudé wrote:
>> On 12/8/24 03:42, zhenwei pi wrote:
>>> QCryptodevBackendServiceType was introduced by
>>> bc304a6442e (cryptodev: Introduce server type in QAPI). However there
>>> is a lack of member description. Thanks to Markus for pointing out
>>> this.
>>>
>>> Signed-off-by: zhenwei pi
>>> ---
>>> qapi/cryptodev.json | 10 ++++++++++
>>> 1 file changed, 10 insertions(+)
>>>
>>> diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json
>>> index 68289f4984..9622c6d92b 100644
>>> --- a/qapi/cryptodev.json
>>> +++ b/qapi/cryptodev.json
>>> @@ -28,6 +28,16 @@
>>> #
>>> # The supported service types of a crypto device.
>>> #
>>> +# @cipher: Symmetric Key Cipher service
>>> +#
>>> +# @hash: Hash service
>>> +#
>>> +# @mac: Message Authentication Codes service
>>> +#
>>> +# @aead: Authenticated Encryption with Associated Data service
>>> +#
>>> +# @akcipher: Asymmetric Key Cipher service
>>
>> Can we drop all trailing "service"s?
>>
>
> I copied these descriptions from virtio-crypto spec. Removing them also
> is fine to me.
>
>>> +#
>>> # Since: 8.0
>>> ##
>>> { 'enum': 'QCryptodevBackendServiceType',
>>
>
> --
> zhenwei pi
>
Markus Armbruster Sept. 5, 2024, 10:45 a.m. UTC | #4
zhenwei pi <pizhenwei@bytedance.com> writes:

> QCryptodevBackendServiceType was introduced by
> bc304a6442e (cryptodev: Introduce server type in QAPI). However there
> is a lack of member description. Thanks to Markus for pointing out
> this.
>
> Signed-off-by: zhenwei pi <pizhenwei@bytedance.com>
> ---
>  qapi/cryptodev.json | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json
> index 68289f4984..9622c6d92b 100644
> --- a/qapi/cryptodev.json
> +++ b/qapi/cryptodev.json
> @@ -28,6 +28,16 @@
>  #
>  # The supported service types of a crypto device.
>  #
> +# @cipher: Symmetric Key Cipher service
> +#
> +# @hash: Hash service
> +#
> +# @mac: Message Authentication Codes service
> +#
> +# @aead: Authenticated Encryption with Associated Data service
> +#
> +# @akcipher: Asymmetric Key Cipher service
> +#
>  # Since: 8.0
>  ##
>  { 'enum': 'QCryptodevBackendServiceType',

Missing: removal of QCryptodevBackendServiceType from pragma
documentation-exceptions.  Happy to do that in my tree.

Apart from that
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Markus Armbruster Sept. 5, 2024, 10:46 a.m. UTC | #5
Philippe Mathieu-Daudé <philmd@linaro.org> writes:

> On 12/8/24 03:42, zhenwei pi wrote:
>> QCryptodevBackendServiceType was introduced by
>> bc304a6442e (cryptodev: Introduce server type in QAPI). However there
>> is a lack of member description. Thanks to Markus for pointing out
>> this.
>> Signed-off-by: zhenwei pi <pizhenwei@bytedance.com>
>> ---
>>   qapi/cryptodev.json | 10 ++++++++++
>>   1 file changed, 10 insertions(+)
>> diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json
>> index 68289f4984..9622c6d92b 100644
>> --- a/qapi/cryptodev.json
>> +++ b/qapi/cryptodev.json
>> @@ -28,6 +28,16 @@
>>   #
>>   # The supported service types of a crypto device.
>>   #
>> +# @cipher: Symmetric Key Cipher service
>> +#
>> +# @hash: Hash service
>> +#
>> +# @mac: Message Authentication Codes service
>> +#
>> +# @aead: Authenticated Encryption with Associated Data service
>> +#
>> +# @akcipher: Asymmetric Key Cipher service
>
> Can we drop all trailing "service"s?

No opinion myself.  Eric, what do you think?

>> +#
>>   # Since: 8.0
>>   ##
>>   { 'enum': 'QCryptodevBackendServiceType',
Philippe Mathieu-Daudé Sept. 5, 2024, 10:56 a.m. UTC | #6
On 5/9/24 12:46, Markus Armbruster wrote:
> Philippe Mathieu-Daudé <philmd@linaro.org> writes:
> 
>> On 12/8/24 03:42, zhenwei pi wrote:
>>> QCryptodevBackendServiceType was introduced by
>>> bc304a6442e (cryptodev: Introduce server type in QAPI). However there
>>> is a lack of member description. Thanks to Markus for pointing out
>>> this.
>>> Signed-off-by: zhenwei pi <pizhenwei@bytedance.com>
>>> ---
>>>    qapi/cryptodev.json | 10 ++++++++++
>>>    1 file changed, 10 insertions(+)
>>> diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json
>>> index 68289f4984..9622c6d92b 100644
>>> --- a/qapi/cryptodev.json
>>> +++ b/qapi/cryptodev.json
>>> @@ -28,6 +28,16 @@
>>>    #
>>>    # The supported service types of a crypto device.
>>>    #
>>> +# @cipher: Symmetric Key Cipher service
>>> +#
>>> +# @hash: Hash service
>>> +#
>>> +# @mac: Message Authentication Codes service
>>> +#
>>> +# @aead: Authenticated Encryption with Associated Data service
>>> +#
>>> +# @akcipher: Asymmetric Key Cipher service
>>
>> Can we drop all trailing "service"s?
> 
> No opinion myself.  Eric, what do you think?

Not really giving any useful value, noise, but
I don't mind, no need to bike shed on this ;)

> 
>>> +#
>>>    # Since: 8.0
>>>    ##
>>>    { 'enum': 'QCryptodevBackendServiceType',
>
diff mbox series

Patch

diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json
index 68289f4984..9622c6d92b 100644
--- a/qapi/cryptodev.json
+++ b/qapi/cryptodev.json
@@ -28,6 +28,16 @@ 
 #
 # The supported service types of a crypto device.
 #
+# @cipher: Symmetric Key Cipher service
+#
+# @hash: Hash service
+#
+# @mac: Message Authentication Codes service
+#
+# @aead: Authenticated Encryption with Associated Data service
+#
+# @akcipher: Asymmetric Key Cipher service
+#
 # Since: 8.0
 ##
 { 'enum': 'QCryptodevBackendServiceType',