[v2] QAPI: add cross-references to qapi docs

[PATCH v2 04/18] qapi: add cross-references to crypto.json

John Snow posted 18 patches 5 months ago

Diff against v1
Download mbox

Maintainers: "Michael S. Tsirkin" <mst@redhat.com>, Igor Mammedov <imammedo@redhat.com>, Ani Sinha <anisinha@redhat.com>, Eric Blake <eblake@redhat.com>, Markus Armbruster <armbru@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, John Snow <jsnow@redhat.com>, Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Yanan Wang <wangyanan55@huawei.com>, Zhao Liu <zhao1.liu@intel.com>, Peter Xu <peterx@redhat.com>, Fabiano Rosas <farosas@suse.de>, Jason Wang <jasowang@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, Lukas Straub <lukasstraub2@web.de>

Expand all Fold all

[PATCH v2 04/18] qapi: add cross-references to crypto.json

Posted by John Snow 5 months ago

Signed-off-by: John Snow <jsnow@redhat.com>
---
 qapi/crypto.json | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/qapi/crypto.json b/qapi/crypto.json
index 9ec6301e188..57620d95da6 100644
--- a/qapi/crypto.json
+++ b/qapi/crypto.json
@@ -589,9 +589,9 @@
 #
 # Specific parameters for RSA algorithm.
 #
-# @hash-alg: QCryptoHashAlgo
+# @hash-alg: `QCryptoHashAlgo`
 #
-# @padding-alg: QCryptoRSAPaddingAlgo
+# @padding-alg: `QCryptoRSAPaddingAlgo`
 #
 # Since: 7.1
 ##
-- 
2.50.0

Re: [PATCH v2 04/18] qapi: add cross-references to crypto.json

Posted by Markus Armbruster 5 months ago

John Snow <jsnow@redhat.com> writes:

> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  qapi/crypto.json | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/qapi/crypto.json b/qapi/crypto.json
> index 9ec6301e188..57620d95da6 100644
> --- a/qapi/crypto.json
> +++ b/qapi/crypto.json
> @@ -589,9 +589,9 @@
>  #
>  # Specific parameters for RSA algorithm.
>  #
> -# @hash-alg: QCryptoHashAlgo
> +# @hash-alg: `QCryptoHashAlgo`
>  #
> -# @padding-alg: QCryptoRSAPaddingAlgo
> +# @padding-alg: `QCryptoRSAPaddingAlgo`
>  #
>  # Since: 7.1
>  ##

Not this patch's problem: these come out like

    Members:

            hash-alg (QCryptoHashAlgo) – QCryptoHashAlgo

            padding-alg (QCryptoRSAPaddingAlgo) – QCryptoRSAPaddingAlgo

which is crap.