[dpdk-dev,7/7] doc: update eventdev documentation
Checks
Commit Message
Update octeontx and software eventdev documentation to include new selftest
feature.
Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
---
doc/guides/eventdevs/octeontx.rst | 13 +++++++++++++
doc/guides/eventdevs/sw.rst | 12 ++++++++++++
2 files changed, 25 insertions(+)
Comments
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Pavan Nikhilesh
> Sent: Tuesday, December 12, 2017 7:27 PM
> To: jerin.jacob@caviumnetworks.com; Richardson, Bruce
> <bruce.richardson@intel.com>; Van Haaren, Harry
> <harry.van.haaren@intel.com>; Eads, Gage <gage.eads@intel.com>;
> hemant.agrawal@nxp.com; nipun.gupta@nxp.com; Ma, Liang J
> <liang.j.ma@intel.com>
> Cc: dev@dpdk.org; Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Subject: [dpdk-dev] [PATCH 7/7] doc: update eventdev documentation
>
> Update octeontx and software eventdev documentation to include new selftest
> feature.
>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
@@ -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
-----------
@@ -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
-----------