doc: add runtime option examples to hns3 guide

[dpdk.git] / doc / guides / nics / hns3.rst

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index fa45721ee3ec3cc174b39d32292fab884fceb4ce..d51d9b13998960f2f09a01113e5d9a86ff474c6e 100644 (file)
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -59,7 +59,7 @@ Runtime Config Options
   ``sve``, if supported use the ``sve`` Rx function which indicates the
   sve algorithm.
   ``simple``, if supported use the ``simple`` Rx function which indicates
   ``sve``, if supported use the ``sve`` Rx function which indicates the
   sve algorithm.
   ``simple``, if supported use the ``simple`` Rx function which indicates

-  the scalar algorithm.
+  the scalar simple algorithm.

   ``common``, if supported use the ``common`` Rx function which indicates
   the scalar scattered algorithm.
 
   ``common``, if supported use the ``common`` Rx function which indicates
   the scalar scattered algorithm.
 


@@ -67,6 +67,9 @@ Runtime Config Options
   be first checked, if meets, use the ``vec``. Then, ``simple``, at last
   ``common``.
 
   be first checked, if meets, use the ``vec``. Then, ``simple``, at last
   ``common``.
 

+  For example::
+  -a 0000:7d:00.0,rx_func_hint=simple
+

 - ``tx_func_hint`` (default ``none``)
 
   Used to select Tx burst function, supported value are ``vec``, ``sve``,
 - ``tx_func_hint`` (default ``none``)
 
   Used to select Tx burst function, supported value are ``vec``, ``sve``,


@@ -84,6 +87,9 @@ Runtime Config Options
   be first checked, if meets, use the ``vec``. Then, ``simple``, at last
   ``common``.
 
   be first checked, if meets, use the ``vec``. Then, ``simple``, at last
   ``common``.
 

+  For example::
+  -a 0000:7d:00.0,tx_func_hint=common
+

 - ``dev_caps_mask`` (default ``0``)
 
   Used to mask the capability which queried from firmware.
 - ``dev_caps_mask`` (default ``0``)
 
   Used to mask the capability which queried from firmware.


@@ -93,6 +99,9 @@ Runtime Config Options
   masked off, then the capability will be 0xFFF0.
   Its main purpose is to debug and avoid problems.
 
   masked off, then the capability will be 0xFFF0.
   Its main purpose is to debug and avoid problems.
 

+  For example::
+  -a 0000:7d:00.0,dev_caps_mask=0xF
+

 Driver compilation and testing
 ------------------------------
 
 Driver compilation and testing
 ------------------------------