doc: add config file option for hns3 PMD

Message ID 1619660285-31522-1-git-send-email-humin29@huawei.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series doc: add config file option for hns3 PMD |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot fail github build: failed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

humin (Q) April 29, 2021, 1:38 a.m. UTC
  This patch adds description of max TQP number per PF for config file
option.

Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
---
 doc/guides/nics/hns3.rst | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)
  

Patch

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index d51d9b1..03b7527 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -44,11 +44,24 @@  Prerequisites
 - Get the information about Kunpeng920 chip using
   `<https://www.hisilicon.com/en/products/Kunpeng>`_.
 
-- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
+- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to
+setup the basic DPDK environment.
 
 
+Pre-Installation Configuration
+------------------------------
+
+Config File Options
+~~~~~~~~~~~~~~~~~~~
+
+The following options can be modified in the ``config/rte_config.h`` file.
+
+- ``RTE_LIBRTE_HNS3_MAX_TQP_NUM_PER_PF`` (default ``256``)
+
+  Number of MAX queues reserved for PF.
+
 Runtime Config Options
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
 
 - ``rx_func_hint`` (default ``none``)