[v2] doc: fix telemetry example for cryptodev

Message ID 20220309093310.2855587-1-sean.morrissey@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] doc: fix telemetry example for cryptodev |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS

Commit Message

Sean Morrissey March 9, 2022, 9:33 a.m. UTC
  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")
Cc: stable@dpdk.org

Signed-off-by: Sean Morrissey <sean.morrissey@intel.com>
---
 doc/guides/prog_guide/cryptodev_lib.rst | 1 +
 1 file changed, 1 insertion(+)
  

Comments

Power, Ciara March 9, 2022, 3:11 p.m. UTC | #1
Hi Sean,

>-----Original Message-----
>From: Sean Morrissey <sean.morrissey@intel.com>
>Sent: Wednesday 9 March 2022 09:33
>Cc: dev@dpdk.org; Morrissey, Sean <sean.morrissey@intel.com>;
>stable@dpdk.org
>Subject: [PATCH v2] 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.
>
>Fixes: 1c559ee8469 ("cryptodev: add telemetry endpoint for capabilities")
>Cc: stable@dpdk.org
>
>Signed-off-by: Sean Morrissey <sean.morrissey@intel.com>
<snip>

Thanks for this.

Acked-by: Ciara Power <ciara.power@intel.com>
  
Thomas Monjalon March 16, 2022, 7:26 p.m. UTC | #2
> >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")
> >Cc: stable@dpdk.org
> >
> >Signed-off-by: Sean Morrissey <sean.morrissey@intel.com>
> <snip>
> 
> Thanks for this.
> 
> Acked-by: Ciara Power <ciara.power@intel.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst
index ba4c592b84..edd11059bc 100644
--- a/doc/guides/prog_guide/cryptodev_lib.rst
+++ b/doc/guides/prog_guide/cryptodev_lib.rst
@@ -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>}}