Skip to contentSkip to conversation

doc: fix telemetry example for cryptodev

PATCH Superseded Sean Morrissey 3 participants 5 messages Mar 8, 2022 – Mar 16, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: fix telemetry example for cryptodev

Blank line added to the final telemetry example for the cryptography device library as to fix the example rendering.

---
 doc/guides/prog_guide/cryptodev_lib.rst | 1 +
 1 file changed, 1 insertion(+)
doc/guides/prog_guide/cryptodev_lib.rst +1 -0
index ba4c592b84..edd11059bc 100644
@@ -1211,6 +1211,7 @@ are shown below.
      "enqueue_err_count": 0, "dequeue_err_count": 0}}
 
 #. Get the capabilities of a particular Crypto device::
+
      --> /cryptodev/caps,0
      {"/cryptodev/caps": {"crypto_caps": [<array of serialized bytes of
      capabilities>], "crypto_caps_n": <number of capabilities>}}
Signature · 1 line
2.25.1
#1 lore raw

08/03/2022 16:56, Sean Morrissey:

Quoted 3 lines

Blank line added to the final telemetry example for the cryptography device library as to fix the example rendering.

Even for a simple fix like that, you need to add a Fixes: line so we know where to backport (or not).

Quoted 6 lines

---
#. Get the capabilities of a particular Crypto device::
+

      --> /cryptodev/caps,0
#2 lore raw

PATCH v2 1/1 doc: fix telemetry example for cryptodev

In reply to Sean Morrissey

Blank line added to the final telemetry example for the cryptography device library as to fix the example rendering.

Fixes 1c559ee8469 ("cryptodev: add telemetry endpoint for capabilities")
---
 doc/guides/prog_guide/cryptodev_lib.rst | 1 +
 1 file changed, 1 insertion(+)
doc/guides/prog_guide/cryptodev_lib.rst +1 -0
index ba4c592b84..edd11059bc 100644
@@ -1211,6 +1211,7 @@ are shown below.
      "enqueue_err_count": 0, "dequeue_err_count": 0}}
 
 #. Get the capabilities of a particular Crypto device::
+
      --> /cryptodev/caps,0
      {"/cryptodev/caps": {"crypto_caps": [<array of serialized bytes of
      capabilities>], "crypto_caps_n": <number of capabilities>}}
Signature · 1 line
2.25.1
Acked-by on v2 1/1
#3 lore raw

Hi Sean,

Quoted 7 lines

-----Original Message-----
From: Sean Morrissey <[email protected]>
Sent: Wednesday 9 March 2022 09:33
Cc: [email protected]; Morrissey, Sean <[email protected]>; [email protected]
Subject: [PATCH v2] doc: fix telemetry example for cryptodev

Quoted 7 lines

Blank line added to the final telemetry example for the cryptography device library as to fix the example rendering.

Fixes 1c559ee8469 ("cryptodev: add telemetry endpoint for capabilities")

<snip>

Thanks for this.