diff mbox

[dpdk-dev,v5,11/11] doc: update eventdev documentation

Message ID 20180111102156.12726-11-pbhagavatula@caviumnetworks.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail apply patch file failure

Commit Message

Pavan Nikhilesh Jan. 11, 2018, 10:21 a.m. UTC 
  Update octeontx eventdev documentation to include new selftest feature.

Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
---
 doc/guides/eventdevs/octeontx.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Jerin Jacob Jan. 11, 2018, 11:27 a.m. UTC | #1 
-----Original Message-----
> Date: Thu, 11 Jan 2018 15:51:56 +0530
> From: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> To: jerin.jacob@caviumnetworks.com, harry.van.haaren@intel.com,
>  gage.eads@intel.com, liang.j.ma@intel.com
> Cc: dev@dpdk.org, Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Subject: [dpdk-dev] [PATCH v5 11/11] doc: update eventdev documentation
> X-Mailer: git-send-email 2.14.1
> 
> Update octeontx eventdev documentation to include new selftest feature.
> 
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Applied this series to dpdk-next-eventdev/master. Thanks.
diff mbox

Patch

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