Chapter and section numbers may change as guides are reorganized. Replace visible numbers with links to named sections or pages.
Signed-off-by: Thomas Monjalon <[email protected]> --- doc/guides/bbdevs/acc100.rst | 4 +-- doc/guides/bbdevs/fpga_5gnr_fec.rst | 4 +-- doc/guides/bbdevs/fpga_lte_fec.rst | 4 +-- doc/guides/bbdevs/la12xx.rst | 4 +-- doc/guides/bbdevs/vrb1.rst | 4 +-- doc/guides/bbdevs/vrb2.rst | 4 +-- doc/guides/nics/mlx4.rst | 2 +- .../prog_guide/ethdev/qos_framework.rst | 25 +++++++++++-------- doc/guides/prog_guide/thread_safety.rst | 2 +- 9 files changed, 29 insertions(+), 24 deletions(-) diff --git a/doc/guides/bbdevs/acc100.rst b/doc/guides/bbdevs/acc100.rst index 985fbb4d24..6582110f3a 100644 --- a/doc/guides/bbdevs/acc100.rst +++ b/doc/guides/bbdevs/acc100.rst @@ -78,9 +78,9 @@ ACC100 5G/4G FEC PMDs support the following BBDEV capabilities: Installation ------------ -Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. +See :doc:`/linux_gsg/build_dpdk` for build instructions. -DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. +DPDK requires hugepages to be configured as described in :ref:`linux_gsg_hugepages`. The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The hugepage configuration of a server may be examined using: diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst b/doc/guides/bbdevs/fpga_5gnr_fec.rst index b181527c45..07ad51eada 100644 --- a/doc/guides/bbdevs/fpga_5gnr_fec.rst +++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst @@ -53,9 +53,9 @@ FPGA 5GNR FEC does not support the following: Installation ------------ -Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. +See :doc:`/linux_gsg/build_dpdk` for build instructions. -DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. +DPDK requires hugepages to be configured as described in :ref:`linux_gsg_hugepages`. The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The hugepage configuration of a server may be examined using: diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst b/doc/guides/bbdevs/fpga_lte_fec.rst index 74151cbef9..2ffc07891b 100644 --- a/doc/guides/bbdevs/fpga_lte_fec.rst +++ b/doc/guides/bbdevs/fpga_lte_fec.rst @@ -51,9 +51,9 @@ FPGA LTE FEC does not support the following: Installation ------------ -Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. +See :doc:`/linux_gsg/build_dpdk` for build instructions. -DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. +DPDK requires hugepages to be configured as described in :ref:`linux_gsg_hugepages`. The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The hugepage configuration of a server may be examined using: diff --git a/doc/guides/bbdevs/la12xx.rst b/doc/guides/bbdevs/la12xx.rst index b2224cc90b..3191fc5116 100644 --- a/doc/guides/bbdevs/la12xx.rst +++ b/doc/guides/bbdevs/la12xx.rst @@ -23,9 +23,9 @@ LA12xx PMD supports the following features: Installation ------------ -Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. +See :doc:`/linux_gsg/build_dpdk` for build instructions. -DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. +DPDK requires hugepages to be configured as described in :ref:`linux_gsg_hugepages`. Initialization -------------- diff --git a/doc/guides/bbdevs/vrb1.rst b/doc/guides/bbdevs/vrb1.rst index e16d6b9dbe..f60ead1ec9 100644 --- a/doc/guides/bbdevs/vrb1.rst +++ b/doc/guides/bbdevs/vrb1.rst @@ -83,9 +83,9 @@ The Intel vRAN Boost v1.0 PMD supports the following bbdev capabilities: Installation ------------ -Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. +See :doc:`/linux_gsg/build_dpdk` for build instructions. -DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. +DPDK requires hugepages to be configured as described in :ref:`linux_gsg_hugepages`. The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The hugepage configuration of a server may be examined using: diff --git a/doc/guides/bbdevs/vrb2.rst b/doc/guides/bbdevs/vrb2.rst index 3a9ae1bf82..c7488b4dd1 100644 --- a/doc/guides/bbdevs/vrb2.rst +++ b/doc/guides/bbdevs/vrb2.rst @@ -100,9 +100,9 @@ The Intel vRAN Boost v2.0 PMD supports the following bbdev capabilities: Installation ------------ -Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. +See :doc:`/linux_gsg/build_dpdk` for build instructions. -DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. +DPDK requires hugepages to be configured as described in :ref:`linux_gsg_hugepages`. The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The hugepage configuration of a server may be examined using: diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index 63b1c548d2..1d3e42bcbb 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -267,7 +267,7 @@ Installing NVIDIA MLNX_OFED connectx_port_config -#. Continue with :ref:`section 2 of the Quick Start Guide <mlx4_QSG_2>`. +#. Continue with the :ref:`Quick Start Guide <mlx4_QSG_2>`. Quick Start Guide diff --git a/doc/guides/prog_guide/ethdev/qos_framework.rst b/doc/guides/prog_guide/ethdev/qos_framework.rst index f7089190fd..fcefa9d481 100644 --- a/doc/guides/prog_guide/ethdev/qos_framework.rst +++ b/doc/guides/prog_guide/ethdev/qos_framework.rst @@ -456,6 +456,8 @@ Usually, once the occupancy of the NIC TX input queue drops below a predefined t the port scheduler is woken up (interrupt based or polling based, by continuously monitoring the queue occupancy) to push more packets into the queue. +.. _qos_internal_time_reference: + Internal Time Reference """"""""""""""""""""""" @@ -625,8 +627,8 @@ while the implementation of the token bucket operations is described in :numref: | | | | or CPU cycles for ease of credit consumption operation | | | | | (as the current time is also maintained in bytes). | | | | | | - | | | | See Section 26.2.4.5.1 "Internal Time Reference" for an | - | | | | explanation of why the time is maintained in byte units. | + | | | | See :ref:`qos_internal_time_reference` for an | + | | | | explanation of why time is maintained in byte units. | | | | | | +---+------------------------+-------+----------------------------------------------------------------------+ | 2 | tb_period | Bytes | Time period that should elapse since the last credit update in order | @@ -1205,9 +1207,9 @@ The use cases supported by the dropper are: * * Mark empty (record the time at which a packet queue becomes empty) -The configuration use case is explained in :ref:`Section 2.23.3.1 <Configuration>`, -the enqueue operation is explained in :ref:`Section 2.23.3.2 <Enqueue_Operation>` -and the mark empty operation is explained in :ref:`Section 2.23.3.3 <Queue_Empty_Operation>`. +The configuration use case is explained in :ref:`Configuration`, +the enqueue operation is explained in :ref:`Enqueue_Operation` +and the mark empty operation is explained in :ref:`Queue_Empty_Operation`. .. _Configuration: @@ -1321,8 +1323,8 @@ Where: .. note:: - The filter weight, wq = 1/2^n, where n is the filter weight parameter value passed to the dropper module - on configuration (see :ref:`Section2.23.3.1 <Configuration>` ). + The filter weight, wq = 1/2^n, where n is the filter weight parameter value + passed to the dropper module on configuration (see :ref:`Configuration`). Average Queue Size Calculation when the Queue is Empty ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -1368,6 +1370,8 @@ Since the time reference is in bytes, the port speed is implied in the expressio The dropper does not have to be configured with the actual port speed. It adjusts automatically to low speed and high speed links. +.. _qos_dropper_implementation: + Implementation """""""""""""" @@ -1406,7 +1410,8 @@ These approaches include: * Large look-up table (76 KB) -The method that was finally selected (described above in Section 26.3.2.2.1) outperforms all of these approaches +The method described in the :ref:`implementation section <qos_dropper_implementation>` +outperforms all of these approaches in terms of run-time performance and memory requirements and also achieves accuracy comparable to floating-point evaluation. :numref:`table_qos_17` lists the performance of each of these alternative approaches relative to the method that is used in the dropper. @@ -1420,7 +1425,7 @@ As can be seen, the floating-point implementation achieved the worst performance | Method | Relative Performance | | | | +====================================================================================+======================+ - | Current dropper method (see :ref:`Section 23.3.2.1.3 <Droppers>`) | 100% | + | Current dropper method (see :ref:`Droppers`) | 100% | | | | +------------------------------------------------------------------------------------+----------------------+ | Fixed-point method with small (512B) look-up table | 148% | @@ -1560,7 +1565,7 @@ Integration with the DPDK QoS Scheduler Sample Application The DPDK QoS Scheduler Application reads a configuration file on start-up. The configuration file includes a section containing RED parameters. -The format of these parameters is described in :ref:`Section2.23.3.1 <Configuration>`. +The format of these parameters is described in :ref:`Configuration`. A sample RED configuration is shown below. In this example, the queue size is 64 packets. .. note:: diff --git a/doc/guides/prog_guide/thread_safety.rst b/doc/guides/prog_guide/thread_safety.rst index f7cda8bb32..f1e0ea4578 100644 --- a/doc/guides/prog_guide/thread_safety.rst +++ b/doc/guides/prog_guide/thread_safety.rst @@ -44,7 +44,7 @@ The mempool library is based on the DPDK lockless ring library and therefore is Performance Insensitive API --------------------------- -Outside of the performance sensitive areas described in Section 25.1, +Outside of the performance sensitive areas described above, the DPDK provides a thread-safe API for most other libraries. For example, malloc and memzone functions are safe for use in multi-threaded and multi-process environments. -- 2.54.0
