Skip to content

Commit 41dd9a6

Browse files
youngcopytmonjalo
youngcopy
authored and
tmonjalo
committed
doc: reorganize prog guide
Create categories in the index of the programmer's guide, sort chapters and rewrite some titles for consistency. Subdirectories are created for ethdev and eventdev for grouping the files together. Useless link anchors at the beginning of files are removed, the corresponding :ref: are replaced with :doc: links. Signed-off-by: David Young <[email protected]> Signed-off-by: Thomas Monjalon <[email protected]>
1 parent cb9187b commit 41dd9a6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+270
-209
lines changed

‎doc/guides/howto/flow_bifurcation.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ the :ref:`flow_isolated_mode` must be configured,
5858
so there is no default rule routing traffic to userspace.
5959

6060
There is no specific instructions to follow.
61-
The recommended reading is the :doc:`../prog_guide/rte_flow` guide.
61+
The recommended reading is the :doc:`../prog_guide/ethdev/flow_offload` guide.
6262
Below is an example of testpmd commands
6363
for receiving VXLAN 42 in 4 queues of the DPDK port 0,
6464
while all other packets go to the kernel:

‎doc/guides/howto/rte_flow.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This document demonstrates some concrete examples for programming flow rules
88
with the ``rte_flow`` APIs.
99

1010
* Detail of the rte_flow APIs can be found in the following link:
11-
:doc:`../prog_guide/rte_flow`.
11+
:doc:`../prog_guide/ethdev/flow_offload`.
1212

1313
* Details of the TestPMD commands to set the flow rules can be found in the
1414
following link: :ref:`TestPMD Flow rules <testpmd_rte_flow>`

‎doc/guides/nics/dpaa2.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ of configured tx queues.
582582

583583
After hierarchy is complete it can be committed.
584584

585-
For an additional description please refer to DPDK :doc:`Traffic Management API <../prog_guide/traffic_management>`.
585+
For an additional description please refer to DPDK :doc:`../prog_guide/ethdev/traffic_management`.
586586

587587
Supported Features
588588
~~~~~~~~~~~~~~~~~~
@@ -601,7 +601,7 @@ The following capabilities are supported:
601601
Usage example
602602
~~~~~~~~~~~~~
603603

604-
For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`.
604+
For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`../testpmd_app_ug/testpmd_funcs`.
605605

606606
#. Run testpmd as follows:
607607

‎doc/guides/nics/mvpp2.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ can be configured via generic flow API offered by DPDK.
403403

404404
The :ref:`flow_isolated_mode` is supported.
405405

406-
For an additional description please refer to DPDK :doc:`../prog_guide/rte_flow`.
406+
For an additional description please refer to DPDK :doc:`../prog_guide/ethdev/flow_offload`.
407407

408408
Supported flow actions
409409
~~~~~~~~~~~~~~~~~~~~~~
@@ -578,7 +578,7 @@ MVPP2 PMD supports DPDK traffic metering and policing that allows the following:
578578

579579
#. Gather statistics.
580580

581-
For an additional description please refer to DPDK :doc:`Traffic Metering and Policing API <../prog_guide/traffic_metering_and_policing>`.
581+
For an additional description please refer to DPDK :doc:`../prog_guide/ethdev/traffic_metering_and_policing`.
582582

583583
The policer objects defined by this feature can work with the default policer defined via config file as described in :ref:`QoS Support <extconf>`.
584584

@@ -658,7 +658,7 @@ of configured tx queues.
658658
After hierarchy is complete it can be committed.
659659

660660

661-
For an additional description please refer to DPDK :doc:`Traffic Management API <../prog_guide/traffic_management>`.
661+
For an additional description please refer to DPDK :doc:`../prog_guide/ethdev/traffic_management`.
662662

663663
Limitations
664664
~~~~~~~~~~~
@@ -674,7 +674,7 @@ The following capabilities are not supported:
674674
Usage example
675675
~~~~~~~~~~~~~
676676

677-
For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`.
677+
For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`../testpmd_app_ug/testpmd_funcs`.
678678

679679
#. Run testpmd as follows:
680680

‎doc/guides/nics/txgbe.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ For example, create a flow rule:
166166
167167
testpmd> flow create 0 ingress pattern eth type is 0x0806 / end actions queue index 2 / end
168168
169-
For a detailed usage description please refer to "Flow rules management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`.
169+
For a detailed usage description please refer to "Flow rules management" section in DPDK :doc:`../testpmd_app_ug/testpmd_funcs`.
170170

171171
Traffic Management API
172172
~~~~~~~~~~~~~~~~~~~~~~
@@ -181,7 +181,7 @@ For example, add shaper profile
181181
182182
testpmd> add port tm node shaper profile 0 0 0 0 25000000 0 0
183183
184-
For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`.
184+
For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`../testpmd_app_ug/testpmd_funcs`.
185185

186186
Limitations or Known issues
187187
---------------------------

‎doc/guides/prog_guide/bpf_lib.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. SPDX-License-Identifier: BSD-3-Clause
22
Copyright(c) 2018 Intel Corporation.
33
4-
Berkeley Packet Filter Library
5-
==============================
4+
Berkeley Packet Filter (BPF) Library
5+
====================================
66

77
The DPDK provides an BPF library that gives the ability
88
to load and execute Enhanced Berkeley Packet Filter (eBPF) bytecode within

‎doc/guides/prog_guide/build_app.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
.. SPDX-License-Identifier: BSD-3-Clause
22
Copyright(c) 2010-2014 Intel Corporation.
33
4-
.. _Building_Your_Own_Application:
5-
64
Building Your Own Application
75
=============================
86

‎doc/guides/prog_guide/dmadev.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. SPDX-License-Identifier: BSD-3-Clause
22
Copyright 2021 HiSilicon Limited
33
4-
DMA Device Library
5-
==================
4+
Direct Memory Access (DMA) Device Library
5+
=========================================
66

77
The DMA library provides a DMA device framework for management and provisioning
88
of hardware and software DMA poll mode drivers, defining generic API which

‎doc/guides/prog_guide/efd_lib.rst‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
.. SPDX-License-Identifier: BSD-3-Clause
22
Copyright(c) 2016-2017 Intel Corporation.
33
4-
.. _Efd_Library:
5-
6-
Elastic Flow Distributor Library
7-
================================
4+
Elastic Flow Distributor (EFD) Library
5+
======================================
86

97
Introduction
108
------------

‎doc/guides/prog_guide/env_abstraction_layer.rst‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
.. SPDX-License-Identifier: BSD-3-Clause
22
Copyright(c) 2010-2014 Intel Corporation.
33
4-
.. _Environment_Abstraction_Layer:
5-
6-
Environment Abstraction Layer
7-
=============================
4+
Environment Abstraction Layer (EAL) Library
5+
===========================================
86

97
The Environment Abstraction Layer (EAL) is responsible for gaining access to low-level resources such as hardware and memory space.
108
It provides a generic interface that hides the environment specifics from the applications and libraries.
@@ -39,7 +37,7 @@ EAL in a Linux-userland Execution Environment
3937
In a Linux user space environment, the DPDK application runs as a user-space application using the pthread library.
4038

4139
The EAL performs physical memory allocation using mmap() in hugetlbfs (using huge page sizes to increase performance).
42-
This memory is exposed to DPDK service layers such as the :ref:`Mempool Library <Mempool_Library>`.
40+
This memory is exposed to DPDK service layers such as the :doc:`mempool_lib`.
4341

4442
At this point, the DPDK services layer will be initialized, then through pthread setaffinity calls,
4543
each execution unit will be assigned to a specific logical core to run as a user-level thread.
@@ -80,8 +78,7 @@ Multi-process Support
8078
~~~~~~~~~~~~~~~~~~~~~
8179

8280
The Linux EAL allows a multi-process as well as a multi-threaded (pthread) deployment model.
83-
See chapter
84-
:ref:`Multi-process Support <Multi-process_Support>` for more details.
81+
See chapter :doc:`multi_proc_support` for more details.
8582

8683
Memory Mapping Discovery and Memory Reservation
8784
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -154,8 +151,7 @@ of memory that can be used by DPDK application.
154151
and IPC must not be mixed: it is not safe to allocate/free memory inside
155152
memory-related or IPC callbacks, and it is not safe to use IPC inside
156153
memory-related callbacks. See chapter
157-
:ref:`Multi-process Support <Multi-process_Support>` for more details about
158-
DPDK IPC.
154+
:doc:`multi_proc_support` for more details about DPDK IPC.
159155

160156
Legacy Memory Mode
161157
^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)