[PATCH 3/6] qapi/crypto: Supply missing member documentation

Markus Armbruster posted 6 patches 3 months, 2 weeks ago
There is a newer version of this series
[PATCH 3/6] qapi/crypto: Supply missing member documentation
Posted by Markus Armbruster 3 months, 2 weeks ago
Since we neglect to document the members of QCryptoAkCipherKeyType,
their description in the QEMU QMP Reference manual is "Not
documented".  Fix that.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/crypto.json | 4 ++++
 qapi/pragma.json | 1 -
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/qapi/crypto.json b/qapi/crypto.json
index 97e02dbd59..67f5855a96 100644
--- a/qapi/crypto.json
+++ b/qapi/crypto.json
@@ -610,6 +610,10 @@
 #
 # The type of asymmetric keys.
 #
+# @public: public key
+#
+# @private: private key
+#
 # Since: 7.1
 ##
 { 'enum': 'QCryptoAkCipherKeyType',
diff --git a/qapi/pragma.json b/qapi/pragma.json
index 6ff135d8d2..fd6bdcaa6d 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -67,7 +67,6 @@
         'NetClientDriver',
         'ObjectType',
         'PciMemoryRegion',
-        'QCryptoAkCipherKeyType',
         'QCryptodevBackendServiceType',
         'QKeyCode',
         'RbdAuthMode',
-- 
2.45.0
Re: [PATCH 3/6] qapi/crypto: Supply missing member documentation
Posted by Philippe Mathieu-Daudé 3 months, 2 weeks ago
On 8/8/24 20:26, Markus Armbruster wrote:
> Since we neglect to document the members of QCryptoAkCipherKeyType,
> their description in the QEMU QMP Reference manual is "Not
> documented".  Fix that.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   qapi/crypto.json | 4 ++++
>   qapi/pragma.json | 1 -
>   2 files changed, 4 insertions(+), 1 deletion(-)

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>