diff mbox series

[v1] doc: fix telemetry example for cryptodev

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

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues
ci/iol-mellanox-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-aarch64-unit-testing success Testing PASS
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
ci/iol-abi-testing success Testing PASS

Commit Message

Sean Morrissey March 8, 2022, 3:56 p.m. UTC 
  Blank line added to the final telemetry example for the
cryptography device library as to fix the example
rendering.

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

Comments

Thomas Monjalon March 8, 2022, 10:36 p.m. UTC | #1 
08/03/2022 16:56, Sean Morrissey:
> 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).

> 
> Signed-off-by: Sean Morrissey <sean.morrissey@intel.com>
> ---
>  #. Get the capabilities of a particular Crypto device::
> +
>       --> /cryptodev/caps,0
diff mbox series

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>}}