docs:programmers guide index reflow
cover docs:programmers guide index reflow
Enhanced Organization of the Programmer's Guide for Better Clarity
- Restructured main sections for coherent topic grouping; added 'Foundation Principles', 'Memory Management', 'CPU Management', and 'Device Libraries'.
- 'Foundation Principles' now includes 'Introduction', 'Overview', 'Source Organization', and a new 'Glossary' section.
- Consolidated memory-related topics under 'Memory Management', enhancing topic discoverability.
- Introduced 'CPU Management' to centralize CPU-related libraries and features.
- Reorganized 'Device Libraries' for clearer categorization of device-specific documentation.
- Grouped packet processing topics under 'CPU Packet Processing' for focused guidance.
- 'Utility Libraries' section newly created to encompass supporting libraries like Timer, RCU, and Ring libraries.
- Refined 'Protocol Processing Libraries' section, emphasizing protocol-specific information.
- New 'High-Level Libraries' section highlights advanced libraries like Packet Framework and Graph Library.
- Added 'Howto Guides' and 'Tips & Tricks' for practical, hands-on advice and optimization techniques.
- Updated filenames and page titles for consistency and clarity, including the addition of 'library' in titles where it was previously missing.
- This reorganization simplifies guide navigation, facilitating quicker access to information.
David Young (1):
Modified Programmer's Guide index for better organization and
readability
doc/guides/prog_guide/bpf_lib.rst | 4 +-
doc/guides/prog_guide/dmadev.rst | 6 +-
doc/guides/prog_guide/efd_lib.rst | 4 +-
.../prog_guide/env_abstraction_layer.rst | 4 +-
doc/guides/prog_guide/ethdev/index.rst | 12 ++
.../prog_guide/{ => ethdev}/poll_mode_drv.rst | 0
.../prog_guide/{ => ethdev}/qos_framework.rst | 0
.../prog_guide/{ => ethdev}/rte_flow.rst | 0
.../{ => ethdev}/switch_representation.rst | 0
.../{ => ethdev}/traffic_management.rst | 0
.../traffic_metering_and_policing.rst | 0
.../{ => eventdev}/event_crypto_adapter.rst | 0
.../event_ethernet_rx_adapter.rst | 0
.../event_ethernet_tx_adapter.rst | 0
.../{ => eventdev}/event_timer_adapter.rst | 0
.../prog_guide/{ => eventdev}/eventdev.rst | 2 +-
doc/guides/prog_guide/eventdev/index.rst | 11 ++
doc/guides/prog_guide/fib_lib.rst | 4 +-
.../generic_receive_offload_lib.rst | 4 +-
.../generic_segmentation_offload_lib.rst | 4 +-
doc/guides/prog_guide/gpudev.rst | 4 +-
doc/guides/prog_guide/index.rst | 145 ++++++++++++------
doc/guides/prog_guide/lpm6_lib.rst | 4 +-
doc/guides/prog_guide/lpm_lib.rst | 4 +-
doc/guides/prog_guide/mbuf_lib.rst | 6 +-
doc/guides/prog_guide/mempool_lib.rst | 4 +-
doc/guides/prog_guide/mldev.rst | 6 +-
.../prog_guide/packet_classif_access_ctrl.rst | 4 +-
doc/guides/prog_guide/packet_framework.rst | 4 +-
doc/guides/prog_guide/rawdev.rst | 4 +-
doc/guides/prog_guide/regexdev.rst | 4 +-
doc/guides/prog_guide/rib_lib.rst | 4 +-
...y_dpdk_functions.rst => thread_safety.rst} | 4 +-
33 files changed, 166 insertions(+), 86 deletions(-)
create mode 100644 doc/guides/prog_guide/ethdev/index.rst
rename doc/guides/prog_guide/{ => ethdev}/poll_mode_drv.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/qos_framework.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/rte_flow.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/switch_representation.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/traffic_management.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/traffic_metering_and_policing.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/event_crypto_adapter.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_rx_adapter.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_tx_adapter.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/event_timer_adapter.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/eventdev.rst (99%)
create mode 100644 doc/guides/prog_guide/eventdev/index.rst
rename doc/guides/prog_guide/{thread_safety_dpdk_functions.rst => thread_safety.rst} (98%)Signature · 1 line
2.41.0.windows.1
PATCH 1/1 Modified Programmer's Guide index for better organization and readability
---
doc/guides/prog_guide/bpf_lib.rst | 4 +-
doc/guides/prog_guide/dmadev.rst | 6 +-
doc/guides/prog_guide/efd_lib.rst | 4 +-
.../prog_guide/env_abstraction_layer.rst | 4 +-
doc/guides/prog_guide/ethdev/index.rst | 12 ++
.../prog_guide/{ => ethdev}/poll_mode_drv.rst | 0
.../prog_guide/{ => ethdev}/qos_framework.rst | 0
.../prog_guide/{ => ethdev}/rte_flow.rst | 0
.../{ => ethdev}/switch_representation.rst | 0
.../{ => ethdev}/traffic_management.rst | 0
.../traffic_metering_and_policing.rst | 0
.../{ => eventdev}/event_crypto_adapter.rst | 0
.../event_ethernet_rx_adapter.rst | 0
.../event_ethernet_tx_adapter.rst | 0
.../{ => eventdev}/event_timer_adapter.rst | 0
.../prog_guide/{ => eventdev}/eventdev.rst | 2 +-
doc/guides/prog_guide/eventdev/index.rst | 11 ++
doc/guides/prog_guide/fib_lib.rst | 4 +-
.../generic_receive_offload_lib.rst | 4 +-
.../generic_segmentation_offload_lib.rst | 4 +-
doc/guides/prog_guide/gpudev.rst | 4 +-
doc/guides/prog_guide/index.rst | 145 ++++++++++++------
doc/guides/prog_guide/lpm6_lib.rst | 4 +-
doc/guides/prog_guide/lpm_lib.rst | 4 +-
doc/guides/prog_guide/mbuf_lib.rst | 6 +-
doc/guides/prog_guide/mempool_lib.rst | 4 +-
doc/guides/prog_guide/mldev.rst | 6 +-
.../prog_guide/packet_classif_access_ctrl.rst | 4 +-
doc/guides/prog_guide/packet_framework.rst | 4 +-
doc/guides/prog_guide/rawdev.rst | 4 +-
doc/guides/prog_guide/regexdev.rst | 4 +-
doc/guides/prog_guide/rib_lib.rst | 4 +-
...y_dpdk_functions.rst => thread_safety.rst} | 4 +-
33 files changed, 166 insertions(+), 86 deletions(-)
create mode 100644 doc/guides/prog_guide/ethdev/index.rst
rename doc/guides/prog_guide/{ => ethdev}/poll_mode_drv.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/qos_framework.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/rte_flow.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/switch_representation.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/traffic_management.rst (100%)
rename doc/guides/prog_guide/{ => ethdev}/traffic_metering_and_policing.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/event_crypto_adapter.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_rx_adapter.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_tx_adapter.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/event_timer_adapter.rst (100%)
rename doc/guides/prog_guide/{ => eventdev}/eventdev.rst (99%)
create mode 100644 doc/guides/prog_guide/eventdev/index.rst
rename doc/guides/prog_guide/{thread_safety_dpdk_functions.rst => thread_safety.rst} (98%)doc/guides/prog_guide/bpf_lib.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2018 Intel Corporation. -Berkeley Packet Filter Library -============================== +Berkeley Packet Filter (BPF) Library +==================================== The DPDK provides an BPF library that gives the ability to load and execute Enhanced Berkeley Packet Filter (eBPF) bytecode within
doc/guides/prog_guide/dmadev.rst +4 -2
@@ -1,8 +1,10 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2021 HiSilicon Limited -DMA Device Library -================== +.. _direct_memory_access_dma: + +Direct Memory Access (DMA) Device Library +========================================= The DMA library provides a DMA device framework for management and provisioning of hardware and software DMA poll mode drivers, defining generic API which
doc/guides/prog_guide/efd_lib.rst +2 -2
@@ -3,8 +3,8 @@ .. _Efd_Library: -Elastic Flow Distributor Library -================================ +Elastic Flow Distributor (EFD) Library +====================================== Introduction ------------
doc/guides/prog_guide/env_abstraction_layer.rst +2 -2
@@ -3,8 +3,8 @@ .. _Environment_Abstraction_Layer: -Environment Abstraction Layer -============================= +Environment Abstraction Layer (EAL) Library +=========================================== The Environment Abstraction Layer (EAL) is responsible for gaining access to low-level resources such as hardware and memory space. It provides a generic interface that hides the environment specifics from the applications and libraries.
doc/guides/prog_guide/ethdev/index.rst new file +12 -0
@@ -0,0 +1,12 @@ +Ethernet Device Library +======================= + +.. toctree:: + :maxdepth: 1 + + poll_mode_drv + rte_flow + switch_representation + traffic_metering_and_policing + traffic_management + qos_framework
doc/guides/prog_guide/ethdev/poll_mode_drv.rst renamed from doc/guides/prog_guide/poll_mode_drv.rst +0 -0
doc/guides/prog_guide/ethdev/qos_framework.rst renamed from doc/guides/prog_guide/qos_framework.rst +0 -0
doc/guides/prog_guide/ethdev/rte_flow.rst renamed from doc/guides/prog_guide/rte_flow.rst +0 -0
doc/guides/prog_guide/ethdev/switch_representation.rst renamed from doc/guides/prog_guide/switch_representation.rst +0 -0
doc/guides/prog_guide/ethdev/traffic_management.rst renamed from doc/guides/prog_guide/traffic_management.rst +0 -0
doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst renamed from doc/guides/prog_guide/traffic_metering_and_policing.rst +0 -0
doc/guides/prog_guide/eventdev/event_crypto_adapter.rst renamed from doc/guides/prog_guide/event_crypto_adapter.rst +0 -0
doc/guides/prog_guide/eventdev/event_ethernet_rx_adapter.rst renamed from doc/guides/prog_guide/event_ethernet_rx_adapter.rst +0 -0
doc/guides/prog_guide/eventdev/event_ethernet_tx_adapter.rst renamed from doc/guides/prog_guide/event_ethernet_tx_adapter.rst +0 -0
doc/guides/prog_guide/eventdev/event_timer_adapter.rst renamed from doc/guides/prog_guide/event_timer_adapter.rst +0 -0
doc/guides/prog_guide/eventdev/eventdev.rst renamed from doc/guides/prog_guide/eventdev.rst +1 -1
@@ -169,7 +169,7 @@ walk-through: .. _figure_eventdev-usage1: -.. figure:: img/eventdev_usage.* +.. figure:: ../img/eventdev_usage.* Sample eventdev usage, with RX, two atomic stages and a single-link to TX.
doc/guides/prog_guide/eventdev/index.rst new file +11 -0
@@ -0,0 +1,11 @@ +Event Device Library +==================== + +.. toctree:: + :maxdepth: 1 + + eventdev + event_ethernet_rx_adapter + event_ethernet_tx_adapter + event_timer_adapter + event_crypto_adapter
doc/guides/prog_guide/fib_lib.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2021 Intel Corporation. -FIB Library -=========== +Forwarding Information Base (FIB) Library +========================================= The FIB library provides a fast Longest Prefix Match (LPM) search for 32-bit keys or 128-bit for IPv6. It can be used in a variety of applications,
doc/guides/prog_guide/generic_receive_offload_lib.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2017 Intel Corporation. -Generic Receive Offload Library -=============================== +Generic Receive Offload (GRO) Library +===================================== Generic Receive Offload (GRO) is a widely used SW-based offloading technique to reduce per-packet processing overheads. By reassembling
doc/guides/prog_guide/generic_segmentation_offload_lib.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2017 Intel Corporation. -Generic Segmentation Offload Library -==================================== +Generic Segmentation Offload (GSO) Library +========================================== Overview --------
doc/guides/prog_guide/gpudev.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2021 NVIDIA Corporation & Affiliates -General-Purpose Graphics Processing Unit Library -================================================ +General-Purpose Graphics Processing Unit (GPU) Library +====================================================== When mixing networking activity with task processing on a GPU device, there may be the need to put in communication the CPU with the device
doc/guides/prog_guide/index.rst +100 -45
174 lines not on this page · raw message
doc/guides/prog_guide/lpm6_lib.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. -LPM6 Library -============ +Longest Prefix Match 6 (LPM6) Library +===================================== The LPM6 (LPM for IPv6) library component implements the Longest Prefix Match (LPM) table search method for 128-bit keys that is typically used to find the best match route in IPv6 forwarding applications.
doc/guides/prog_guide/lpm_lib.rst +2 -2
@@ -3,8 +3,8 @@ .. _LPM_Library: -LPM Library -=========== +Longest Prefix Match (LPM) Library +================================== The DPDK LPM library component implements the Longest Prefix Match (LPM) table search method for 32-bit keys that is typically used to find the best route match in IP forwarding applications.
doc/guides/prog_guide/mbuf_lib.rst +3 -3
@@ -3,10 +3,10 @@ .. _Mbuf_Library: -Mbuf Library -============ +Packet (Mbuf) Library +===================== -The mbuf library provides the ability to allocate and free buffers (mbufs) +The Packet (MBuf) library provides the ability to allocate and free buffers (mbufs) that may be used by the DPDK application to store message buffers. The message buffers are stored in a mempool, using the :ref:`Mempool Library <Mempool_Library>`.
doc/guides/prog_guide/mempool_lib.rst +2 -2
@@ -3,8 +3,8 @@ .. _Mempool_Library: -Mempool Library -=============== +Memory Pool Library +=================== A memory pool is an allocator of a fixed-sized object. In the DPDK, it is identified by name and uses a mempool handler to store free objects.
doc/guides/prog_guide/mldev.rst +3 -3
@@ -1,10 +1,10 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022 Marvell. -Machine Learning Device Library -=============================== +Machine Learning (ML) Device Library +=========================================== -The MLDEV library provides a Machine Learning device framework for the management and +The Machine Learning (ML) Device library provides a Machine Learning device framework for the management and provisioning of hardware and software ML poll mode drivers, defining an API which support a number of ML operations including device handling and inference processing.
doc/guides/prog_guide/packet_classif_access_ctrl.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2015 Intel Corporation. -Packet Classification and Access Control -======================================== +Packet Classification and Access Control (ACL) Library +====================================================== The DPDK provides an Access Control library that gives the ability to classify an input packet based on a set of classification rules.
doc/guides/prog_guide/packet_framework.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. -Packet Framework -================ +Packet Framework Library +======================== Design Objectives -----------------
doc/guides/prog_guide/rawdev.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2018 NXP -Rawdevice Library -================= +Raw Device Library +================== Introduction ------------
doc/guides/prog_guide/regexdev.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2020 Mellanox Technologies, Ltd -RegEx Device Library -==================== +Regular Expression (RegEx) Device Library +========================================= The RegEx library provides a RegEx device framework for management and provisioning of hardware and software RegEx poll mode drivers, defining generic
doc/guides/prog_guide/rib_lib.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2021 Intel Corporation. -RIB Library -=========== +Routing Information Base (RIB) Library +====================================== The Routing Information Base (RIB) library provides a data store for routing information. This library is intended for use in control or management plane applications.
doc/guides/prog_guide/thread_safety.rst renamed from doc/guides/prog_guide/thread_safety_dpdk_functions.rst +2 -2
@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. -Thread Safety of DPDK Functions -=============================== +Thread Safety +============= The DPDK is comprised of several libraries. Some of the functions in these libraries can be safely called from multiple threads simultaneously, while others cannot.
Signature · 1 line
2.41.0.windows.1
Re: [PATCH 1/1] Modified Programmer's Guide index for better organization and readability
Signed-off-by David Young <[email protected]>
Thanks!
David Young
Professional Copywriter/Technical Writer
Young Copy
+1 (678) 500-9550
https://www.youngcopy.com
Quoted 677 lines · David Young
--- doc/guides/prog_guide/bpf_lib.rst | 4 +- doc/guides/prog_guide/dmadev.rst | 6 +- doc/guides/prog_guide/efd_lib.rst | 4 +- .../prog_guide/env_abstraction_layer.rst | 4 +- doc/guides/prog_guide/ethdev/index.rst | 12 ++ .../prog_guide/{ => ethdev}/poll_mode_drv.rst | 0 .../prog_guide/{ => ethdev}/qos_framework.rst | 0 .../prog_guide/{ => ethdev}/rte_flow.rst | 0 .../{ => ethdev}/switch_representation.rst | 0 .../{ => ethdev}/traffic_management.rst | 0 .../traffic_metering_and_policing.rst | 0 .../{ => eventdev}/event_crypto_adapter.rst | 0 .../event_ethernet_rx_adapter.rst | 0 .../event_ethernet_tx_adapter.rst | 0 .../{ => eventdev}/event_timer_adapter.rst | 0 .../prog_guide/{ => eventdev}/eventdev.rst | 2 +- doc/guides/prog_guide/eventdev/index.rst | 11 ++ doc/guides/prog_guide/fib_lib.rst | 4 +- .../generic_receive_offload_lib.rst | 4 +- .../generic_segmentation_offload_lib.rst | 4 +- doc/guides/prog_guide/gpudev.rst | 4 +- doc/guides/prog_guide/index.rst | 145 ++++++++++++------ doc/guides/prog_guide/lpm6_lib.rst | 4 +- doc/guides/prog_guide/lpm_lib.rst | 4 +- doc/guides/prog_guide/mbuf_lib.rst | 6 +- doc/guides/prog_guide/mempool_lib.rst | 4 +- doc/guides/prog_guide/mldev.rst | 6 +- .../prog_guide/packet_classif_access_ctrl.rst | 4 +- doc/guides/prog_guide/packet_framework.rst | 4 +- doc/guides/prog_guide/rawdev.rst | 4 +- doc/guides/prog_guide/regexdev.rst | 4 +- doc/guides/prog_guide/rib_lib.rst | 4 +- ...y_dpdk_functions.rst => thread_safety.rst} | 4 +- 33 files changed, 166 insertions(+), 86 deletions(-) create mode 100644 doc/guides/prog_guide/ethdev/index.rst rename doc/guides/prog_guide/{ => ethdev}/poll_mode_drv.rst (100%) rename doc/guides/prog_guide/{ => ethdev}/qos_framework.rst (100%) rename doc/guides/prog_guide/{ => ethdev}/rte_flow.rst (100%) rename doc/guides/prog_guide/{ => ethdev}/switch_representation.rst (100%) rename doc/guides/prog_guide/{ => ethdev}/traffic_management.rst (100%) rename doc/guides/prog_guide/{ => ethdev}/traffic_metering_and_policing.rst (100%) rename doc/guides/prog_guide/{ => eventdev}/event_crypto_adapter.rst (100%) rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_rx_adapter.rst (100%) rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_tx_adapter.rst (100%) rename doc/guides/prog_guide/{ => eventdev}/event_timer_adapter.rst (100%) rename doc/guides/prog_guide/{ => eventdev}/eventdev.rst (99%) create mode 100644 doc/guides/prog_guide/eventdev/index.rst rename doc/guides/prog_guide/{thread_safety_dpdk_functions.rst =>
thread_safety.rst} (98%)doc/guides/prog_guide/bpf_lib.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2018 Intel Corporation. -Berkeley Packet Filter Library -============================== +Berkeley Packet Filter (BPF) Library +==================================== The DPDK provides an BPF library that gives the ability to load and execute Enhanced Berkeley Packet Filter (eBPF) bytecode withindoc/guides/prog_guide/dmadev.rst +4
-2@@ -1,8 +1,10 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2021 HiSilicon Limited -DMA Device Library -================== +.. _direct_memory_access_dma: + +Direct Memory Access (DMA) Device Library +========================================= The DMA library provides a DMA device framework for management andprovisioning
of hardware and software DMA poll mode drivers, defining generic API whichdoc/guides/prog_guide/efd_lib.rst +2
-2@@ -3,8 +3,8 @@ .. _Efd_Library: -Elastic Flow Distributor Library -================================ +Elastic Flow Distributor (EFD) Library +====================================== Introduction ------------doc/guides/prog_guide/env_abstraction_layer.rst +2
-2@@ -3,8 +3,8 @@ .. _Environment_Abstraction_Layer: -Environment Abstraction Layer -============================= +Environment Abstraction Layer (EAL) Library +=========================================== The Environment Abstraction Layer (EAL) is responsible for gaining accessto low-level resources such as hardware and memory space.
It provides a generic interface that hides the environment specifics from
the applications and libraries.doc/guides/prog_guide/ethdev/index.rst new file +12
-0@@ -0,0 +1,12 @@ +Ethernet Device Library +======================= + +.. toctree:: + :maxdepth: 1 + + poll_mode_drv + rte_flow + switch_representation + traffic_metering_and_policing + traffic_management + qos_frameworkdoc/guides/prog_guide/ethdev/poll_mode_drv.rst renamed from doc/guides/prog_guide/poll_mode_drv.rst +0
-0doc/guides/prog_guide/ethdev/qos_framework.rst renamed from doc/guides/prog_guide/qos_framework.rst +0
-0doc/guides/prog_guide/ethdev/rte_flow.rst renamed from doc/guides/prog_guide/rte_flow.rst +0
-0doc/guides/prog_guide/ethdev/switch_representation.rst renamed from doc/guides/prog_guide/switch_representation.rst +0
-0doc/guides/prog_guide/ethdev/traffic_management.rst renamed from doc/guides/prog_guide/traffic_management.rst +0
-0doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst renamed from doc/guides/prog_guide/traffic_metering_and_policing.rst +0
-0doc/guides/prog_guide/eventdev/event_crypto_adapter.rst renamed from doc/guides/prog_guide/event_crypto_adapter.rst +0
-0doc/guides/prog_guide/eventdev/event_ethernet_rx_adapter.rst renamed from doc/guides/prog_guide/event_ethernet_rx_adapter.rst +0
-0doc/guides/prog_guide/eventdev/event_ethernet_tx_adapter.rst renamed from doc/guides/prog_guide/event_ethernet_tx_adapter.rst +0
-0doc/guides/prog_guide/eventdev/event_timer_adapter.rst renamed from doc/guides/prog_guide/event_timer_adapter.rst +0
-0doc/guides/prog_guide/eventdev/eventdev.rst renamed from doc/guides/prog_guide/eventdev.rst +1
-1@@ -169,7 +169,7 @@ walk-through: .. _figure_eventdev-usage1: -.. figure:: img/eventdev_usage.* +.. figure:: ../img/eventdev_usage.* Sample eventdev usage, with RX, two atomic stages and a single-link toTX.
doc/guides/prog_guide/eventdev/index.rst new file +11
-0@@ -0,0 +1,11 @@ +Event Device Library +==================== + +.. toctree:: + :maxdepth: 1 + + eventdev + event_ethernet_rx_adapter + event_ethernet_tx_adapter + event_timer_adapter + event_crypto_adapterdoc/guides/prog_guide/fib_lib.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2021 Intel Corporation. -FIB Library -=========== +Forwarding Information Base (FIB) Library +========================================= The FIB library provides a fast Longest Prefix Match (LPM) search for32-bit
keys or 128-bit for IPv6. It can be used in a variety of applications,doc/guides/prog_guide/generic_receive_offload_lib.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2017 Intel Corporation. -Generic Receive Offload Library -=============================== +Generic Receive Offload (GRO) Library +===================================== Generic Receive Offload (GRO) is a widely used SW-based offloading technique to reduce per-packet processing overheads. By reassemblingdoc/guides/prog_guide/generic_segmentation_offload_lib.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2017 Intel Corporation. -Generic Segmentation Offload Library -==================================== +Generic Segmentation Offload (GSO) Library +========================================== Overview --------doc/guides/prog_guide/gpudev.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2021 NVIDIA Corporation & Affiliates -General-Purpose Graphics Processing Unit Library -================================================ +General-Purpose Graphics Processing Unit (GPU) Library +====================================================== When mixing networking activity with task processing on a GPU device, there may be the need to put in communication the CPU with the devicedoc/guides/prog_guide/index.rst +100
-45@@ -4,28 +4,67 @@ Programmer's Guide ================== +Foundation Principles +--------------------- + .. toctree:: - :maxdepth: 3 - :numbered: + :maxdepth: 1 intro overview source_org - env_abstraction_layer - log_lib - service_cores - trace_lib - rcu_lib - ring_lib - stack_lib + glossary + +Memory Management +----------------- + +.. toctree:: + :maxdepth: 1 + mempool_lib mbuf_lib - poll_mode_drv - rte_flow - switch_representation - traffic_metering_and_policing - traffic_management - bbdev + multi_proc_support + +CPU Management +-------------- + +.. toctree:: + :maxdepth: 1 + + env_abstraction_layer + power_man + thread_safety + service_cores + +CPU Packet Processing +--------------------- + +.. toctree:: + :maxdepth: 1 + + lpm_lib + lpm6_lib + rib_lib + fib_lib + packet_classif_access_ctrl + packet_distrib_lib + efd_lib + reorder_lib + ip_fragment_reassembly_lib + generic_receive_offload_lib + generic_segmentation_offload_lib + toeplitz_hash_lib + hash_lib + member_lib + +Device Libraries +---------------- + +.. toctree:: + :maxdepth: 1 + + ethdev/index + vhost_lib cryptodev_lib compressdev regexdev@@ -35,46 +74,62 @@ Programmer's Guide rte_security rawdev link_bonding_poll_mode_drv_lib + bbdev + eventdev/index + +Utility Libraries +----------------- + +.. toctree:: + :maxdepth: 1 + timer_lib - hash_lib - toeplitz_hash_lib - efd_lib - member_lib - lpm_lib - lpm6_lib - fib_lib - rib_lib - packet_distrib_lib - reorder_lib - ip_fragment_reassembly_lib - generic_receive_offload_lib - generic_segmentation_offload_lib - ipsec_lib - pdcp_lib - pcapng_lib - pdump_lib - multi_proc_support - thread_safety_dpdk_functions - eventdev - event_ethernet_rx_adapter - event_ethernet_tx_adapter - event_timer_adapter - event_crypto_adapter - qos_framework - power_man - packet_classif_access_ctrl - packet_framework - vhost_lib + rcu_lib + ring_lib + stack_lib metrics_lib telemetry_lib + pdump_lib + pcapng_lib bpf_lib + trace_lib + +Protocol Processing Libraries +----------------------------- + +.. toctree:: + :maxdepth: 1 + + pdcp_lib + ipsec_lib + +High-Level Libraries +-------------------- + +.. toctree:: + :maxdepth: 1 + + packet_framework graph_lib + +Howto Guides +------------- + +.. toctree:: + :maxdepth: 1 + build-sdk-meson meson_ut build_app + +Tips & Tricks +------------- + +.. toctree:: + :maxdepth: 1 + perf_opt_guidelines writing_efficient_code lto profile_app asan - glossarydoc/guides/prog_guide/lpm6_lib.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. -LPM6 Library -============ +Longest Prefix Match 6 (LPM6) Library +===================================== The LPM6 (LPM for IPv6) library component implements the Longest PrefixMatch (LPM) table search method for 128-bit keys
that is typically used to find the best match route in IPv6 forwarding
applications.doc/guides/prog_guide/lpm_lib.rst +2
-2@@ -3,8 +3,8 @@ .. _LPM_Library: -LPM Library -=========== +Longest Prefix Match (LPM) Library +================================== The DPDK LPM library component implements the Longest Prefix Match (LPM)table search method for 32-bit keys
that is typically used to find the best route match in IP forwarding
applications.doc/guides/prog_guide/mbuf_lib.rst +3
-3@@ -3,10 +3,10 @@ .. _Mbuf_Library: -Mbuf Library -============ +Packet (Mbuf) Library +===================== -The mbuf library provides the ability to allocate and free buffers (mbufs) +The Packet (MBuf) library provides the ability to allocate and free buffers (mbufs) that may be used by the DPDK application to store message buffers. The message buffers are stored in a mempool, using the :ref:`MempoolLibrary <Mempool_Library>`.
doc/guides/prog_guide/mempool_lib.rst +2
-2@@ -3,8 +3,8 @@ .. _Mempool_Library: -Mempool Library -=============== +Memory Pool Library +=================== A memory pool is an allocator of a fixed-sized object. In the DPDK, it is identified by name and uses a mempool handler to storefree objects.
doc/guides/prog_guide/mldev.rst +2
-3@@ -1,10 +1,10 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022 Marvell. -Machine Learning Device Library -=============================== +Machine Learning (ML) Device Library +=========================================== -The MLDEV library provides a Machine Learning device framework for themanagement and
+The Machine Learning (ML) Device library provides a Machine Learning device framework for the management and
provisioning of hardware and software ML poll mode drivers, defining an API which support a number of ML operations including device handling and inference processing.doc/guides/prog_guide/packet_classif_access_ctrl.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2015 Intel Corporation. -Packet Classification and Access Control -======================================== +Packet Classification and Access Control (ACL) Library +====================================================== The DPDK provides an Access Control library that gives the ability to classify an input packet based on a set of classification rules.doc/guides/prog_guide/packet_framework.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. -Packet Framework -================ +Packet Framework Library +======================== Design Objectives -----------------doc/guides/prog_guide/rawdev.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2018 NXP -Rawdevice Library -================= +Raw Device Library +================== Introduction ------------doc/guides/prog_guide/regexdev.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2020 Mellanox Technologies, Ltd -RegEx Device Library -==================== +Regular Expression (RegEx) Device Library +========================================= The RegEx library provides a RegEx device framework for management and provisioning of hardware and software RegEx poll mode drivers, defininggeneric
doc/guides/prog_guide/rib_lib.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2021 Intel Corporation. -RIB Library -=========== +Routing Information Base (RIB) Library +====================================== The Routing Information Base (RIB) library provides a data store forrouting information.
This library is intended for use in control or management plane
applications.doc/guides/prog_guide/thread_safety.rst renamed from doc/guides/prog_guide/thread_safety_dpdk_functions.rst +2
-2@@ -1,8 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. -Thread Safety of DPDK Functions -=============================== +Thread Safety +============= The DPDK is comprised of several libraries. Some of the functions in these libraries can be safely called frommultiple threads simultaneously, while others cannot. --
2.41.0.windows.1
Re: [PATCH 1/1] Modified Programmer's Guide index for better organization and readability
08/12/2023 16:43, Dave Young:
Quoted 1 line
Signed-off-by David Young <[email protected]>
Many months later, adapted and applied, thanks.