Update octeontx and software eventdev documentation to include new selftest feature.
Signed-off-by: Pavan Nikhilesh <pbhagavat...@caviumnetworks.com> --- doc/guides/eventdevs/octeontx.rst | 13 +++++++++++++ doc/guides/eventdevs/sw.rst | 12 ++++++++++++ 2 files changed, 25 insertions(+) diff --git a/doc/guides/eventdevs/octeontx.rst b/doc/guides/eventdevs/octeontx.rst index cef004a20..bf2985be1 100644 --- a/doc/guides/eventdevs/octeontx.rst +++ b/doc/guides/eventdevs/octeontx.rst @@ -114,6 +114,19 @@ Example: ./your_eventdev_application --vdev="event_octeontx" + +Selftest +-------- + +The functionality of octeontx eventdev can be verified using this option, +various unit and functional tests are run to verify the sanity. +The tests are run once the vdev creation is successfully complete. + +.. code-block:: console + + --vdev="event_octeontx,self_test=1" + + Limitations ----------- diff --git a/doc/guides/eventdevs/sw.rst b/doc/guides/eventdevs/sw.rst index ec49b3b57..671b6c5b9 100644 --- a/doc/guides/eventdevs/sw.rst +++ b/doc/guides/eventdevs/sw.rst @@ -114,6 +114,18 @@ verify possible gains. --vdev="event_sw0,credit_quanta=64" +Selftest +~~~~~~~~ + +The functionality of software eventdev can be verified using this option, +various unit and functional tests are run to verify the sanity. +The tests are run once the vdev creation is successfully complete. + +.. code-block:: console + + --vdev="event_sw,self_test=1" + + Limitations ----------- -- 2.14.1