[2/2] doc: fix runtime config options
Checks
Commit Message
This patch added examples for runtime config options, to help user
how to use this.
Fixes: a124f9e9591b ("net/hns3: add runtime config to select IO burst function")
Fixes: 70791213242e ("net/hns3: support masking device capability")
Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
---
doc/guides/nics/hns3.rst | 9 +++++++++
1 file changed, 9 insertions(+)
@@ -67,6 +67,9 @@ Runtime Config Options
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``,
@@ -84,6 +87,9 @@ Runtime Config Options
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.
@@ -93,6 +99,9 @@ Runtime Config Options
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
------------------------------