Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/134943/?format=api
{ "id": 134943, "url": "http://patchwork.dpdk.org/api/patches/134943/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20231208021108.2001-2-dave@youngcopy.com/", "project": { "id": 1, "url": "http://patchwork.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20231208021108.2001-2-dave@youngcopy.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20231208021108.2001-2-dave@youngcopy.com", "date": "2023-12-08T02:11:08", "name": "[1/1] Modified Programmer's Guide index for better organization and readability", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "014830175104db1ee6f8ead7c5d1c3f6fe2f3855", "submitter": { "id": 3122, "url": "http://patchwork.dpdk.org/api/people/3122/?format=api", "name": "Dave Young", "email": "dave@youngcopy.com" }, "delegate": { "id": 1, "url": "http://patchwork.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20231208021108.2001-2-dave@youngcopy.com/mbox/", "series": [ { "id": 30483, "url": "http://patchwork.dpdk.org/api/series/30483/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=30483", "date": "2023-12-08T02:11:07", "name": "docs:programmers guide index reflow", "version": 1, "mbox": "http://patchwork.dpdk.org/series/30483/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/134943/comments/", "check": "warning", "checks": "http://patchwork.dpdk.org/api/patches/134943/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 3B8E0436A1;\n\tFri, 8 Dec 2023 03:11:38 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 1448742F8B;\n\tFri, 8 Dec 2023 03:11:35 +0100 (CET)", "from mail-yb1-f169.google.com (mail-yb1-f169.google.com\n [209.85.219.169])\n by mails.dpdk.org (Postfix) with ESMTP id C46F542F89\n for <dev@dpdk.org>; Fri, 8 Dec 2023 03:11:33 +0100 (CET)", "by mail-yb1-f169.google.com with SMTP id\n 3f1490d57ef6-db981947bf9so354829276.0\n for <dev@dpdk.org>; Thu, 07 Dec 2023 18:11:33 -0800 (PST)", "from localhost.localdomain\n ([2600:1700:20c0:a560:d1dd:3efb:9d96:5cfd])\n by smtp.gmail.com with ESMTPSA id\n v4-20020a818504000000b005d9729068f5sm339927ywf.42.2023.12.07.18.11.31\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Thu, 07 Dec 2023 18:11:31 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=youngcopy-com.20230601.gappssmtp.com; s=20230601; t=1702001492;\n x=1702606292;\n darn=dpdk.org;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:from:to:cc:subject:date\n :message-id:reply-to;\n bh=mw0iqB7FMv+IdSU+rMNlp5ImrekpYWn5YYeHnLwqXTs=;\n b=CFEqkhJtCVyopfHTP0xTalv+hjxTxEt+BeS7G4+VGIGQe94OeryznkCCb4nzkx2ub7\n ib5I7bbFrzYZGIZmh9qtFIPNBZLBTjBejiBnF3tEf3h2i3j/ECoOqI6n7Fu2IHDdV+bb\n 2t652gHbEH7bCB7MX6hhf0Gm5FeI+UCNfZ9QQ7QXRv+3xuzI0ZViyNn/OiSpkawbOLkT\n +y1IM6dGvEkY8lYYQhf5HPYn/MZqoQ6WwPrW24rm3ZSR4nPbONIwIKhrbEcnxI8MD4a8\n Bmr0X3Uz4opCe3JImEhTW+hEcVsNllxe2ZnXRYHRZCKKuiVXrbAIZDO0FLM4yNF/ha2k\n hHIA==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1702001492; x=1702606292;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n :subject:date:message-id:reply-to;\n bh=mw0iqB7FMv+IdSU+rMNlp5ImrekpYWn5YYeHnLwqXTs=;\n b=l12wZqYVgZ+UvMyRzGW+wbSho3fsnCYi0dM4k4Cy2Q7UdC12rlxMz0gfl6O0KiXPI4\n hRuf4m2LatNqrTTMOZPQWY3eSkJold1C9DeOtPqDws8YtUWi34ZjMd/FIsyfLNvY3wP7\n 26MFKVUxYFSvTT13xxI0mH3Z6+d8rV54GAHqWScIvZXnY+sdOPhvGXZtt3+IMXKdjX9a\n +oXYEcc8Bu4WWXJS57xQD7u9OVy2Kjh1EpBBwUEQBiHSM6VgtxWWKixXvk7XI8A2twib\n ysJWEGmiSuwym/1oCgpTPjKJbSCVOLuXPeC1288BOEGvz1RTaCEEe1IyKWTOtTZVwR79\n 2NHQ==", "X-Gm-Message-State": "AOJu0YwbQikX5kLCHULJ7q2wwOclU4HyTpZXsQHSHfEtGju26pdJlKGU\n 0DgdrfmIaedzBoAE0gjyYn/Y+QKc9v7hzKwjS/I=", "X-Google-Smtp-Source": "\n AGHT+IHmaSm5S9NIcF1tZlrewdbcqMZFSVbatTl1CuAXASs32OQqVD3GJ0nwk8Vp//0DtF+XNzDd7w==", "X-Received": "by 2002:a0d:d884:0:b0:5af:778e:d53b with SMTP id\n a126-20020a0dd884000000b005af778ed53bmr4921902ywe.0.1702001492231;\n Thu, 07 Dec 2023 18:11:32 -0800 (PST)", "From": "David Young <dave@youngcopy.com>", "To": "dev@dpdk.org", "Cc": "Bruce Richardson <bruce.richardson@intel.com>,\n Thomas Monjalon <thomas@monjalon.net>, David Young <dave@youngcopy.com>", "Subject": "[PATCH 1/1] Modified Programmer's Guide index for better organization\n and readability", "Date": "Thu, 7 Dec 2023 21:11:08 -0500", "Message-ID": "<20231208021108.2001-2-dave@youngcopy.com>", "X-Mailer": "git-send-email 2.41.0.windows.1", "In-Reply-To": "<20231208021108.2001-1-dave@youngcopy.com>", "References": "<20231208021108.2001-1-dave@youngcopy.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "---\n doc/guides/prog_guide/bpf_lib.rst | 4 +-\n doc/guides/prog_guide/dmadev.rst | 6 +-\n doc/guides/prog_guide/efd_lib.rst | 4 +-\n .../prog_guide/env_abstraction_layer.rst | 4 +-\n doc/guides/prog_guide/ethdev/index.rst | 12 ++\n .../prog_guide/{ => ethdev}/poll_mode_drv.rst | 0\n .../prog_guide/{ => ethdev}/qos_framework.rst | 0\n .../prog_guide/{ => ethdev}/rte_flow.rst | 0\n .../{ => ethdev}/switch_representation.rst | 0\n .../{ => ethdev}/traffic_management.rst | 0\n .../traffic_metering_and_policing.rst | 0\n .../{ => eventdev}/event_crypto_adapter.rst | 0\n .../event_ethernet_rx_adapter.rst | 0\n .../event_ethernet_tx_adapter.rst | 0\n .../{ => eventdev}/event_timer_adapter.rst | 0\n .../prog_guide/{ => eventdev}/eventdev.rst | 2 +-\n doc/guides/prog_guide/eventdev/index.rst | 11 ++\n doc/guides/prog_guide/fib_lib.rst | 4 +-\n .../generic_receive_offload_lib.rst | 4 +-\n .../generic_segmentation_offload_lib.rst | 4 +-\n doc/guides/prog_guide/gpudev.rst | 4 +-\n doc/guides/prog_guide/index.rst | 145 ++++++++++++------\n doc/guides/prog_guide/lpm6_lib.rst | 4 +-\n doc/guides/prog_guide/lpm_lib.rst | 4 +-\n doc/guides/prog_guide/mbuf_lib.rst | 6 +-\n doc/guides/prog_guide/mempool_lib.rst | 4 +-\n doc/guides/prog_guide/mldev.rst | 6 +-\n .../prog_guide/packet_classif_access_ctrl.rst | 4 +-\n doc/guides/prog_guide/packet_framework.rst | 4 +-\n doc/guides/prog_guide/rawdev.rst | 4 +-\n doc/guides/prog_guide/regexdev.rst | 4 +-\n doc/guides/prog_guide/rib_lib.rst | 4 +-\n ...y_dpdk_functions.rst => thread_safety.rst} | 4 +-\n 33 files changed, 166 insertions(+), 86 deletions(-)\n create mode 100644 doc/guides/prog_guide/ethdev/index.rst\n rename doc/guides/prog_guide/{ => ethdev}/poll_mode_drv.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/qos_framework.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/rte_flow.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/switch_representation.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/traffic_management.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/traffic_metering_and_policing.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/event_crypto_adapter.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_rx_adapter.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_tx_adapter.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/event_timer_adapter.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/eventdev.rst (99%)\n create mode 100644 doc/guides/prog_guide/eventdev/index.rst\n rename doc/guides/prog_guide/{thread_safety_dpdk_functions.rst => thread_safety.rst} (98%)", "diff": "diff --git a/doc/guides/prog_guide/bpf_lib.rst b/doc/guides/prog_guide/bpf_lib.rst\nindex 1cf2d59429..8c820328b9 100644\n--- a/doc/guides/prog_guide/bpf_lib.rst\n+++ b/doc/guides/prog_guide/bpf_lib.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2018 Intel Corporation.\n \n-Berkeley Packet Filter Library\n-==============================\n+Berkeley Packet Filter (BPF) Library\n+====================================\n \n The DPDK provides an BPF library that gives the ability\n to load and execute Enhanced Berkeley Packet Filter (eBPF) bytecode within\ndiff --git a/doc/guides/prog_guide/dmadev.rst b/doc/guides/prog_guide/dmadev.rst\nindex 2aa26d33b8..2b31dc904f 100644\n--- a/doc/guides/prog_guide/dmadev.rst\n+++ b/doc/guides/prog_guide/dmadev.rst\n@@ -1,8 +1,10 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright 2021 HiSilicon Limited\n \n-DMA Device Library\n-==================\n+.. _direct_memory_access_dma:\n+\n+Direct Memory Access (DMA) Device Library\n+=========================================\n \n The DMA library provides a DMA device framework for management and provisioning\n of hardware and software DMA poll mode drivers, defining generic API which\ndiff --git a/doc/guides/prog_guide/efd_lib.rst b/doc/guides/prog_guide/efd_lib.rst\nindex 2b355ff2a6..4bee7237be 100644\n--- a/doc/guides/prog_guide/efd_lib.rst\n+++ b/doc/guides/prog_guide/efd_lib.rst\n@@ -3,8 +3,8 @@\n \n .. _Efd_Library:\n \n-Elastic Flow Distributor Library\n-================================\n+Elastic Flow Distributor (EFD) Library\n+======================================\n \n Introduction\n ------------\ndiff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst\nindex 6debf54efb..5ce80a4496 100644\n--- a/doc/guides/prog_guide/env_abstraction_layer.rst\n+++ b/doc/guides/prog_guide/env_abstraction_layer.rst\n@@ -3,8 +3,8 @@\n \n .. _Environment_Abstraction_Layer:\n \n-Environment Abstraction Layer\n-=============================\n+Environment Abstraction Layer (EAL) Library\n+===========================================\n \n The Environment Abstraction Layer (EAL) is responsible for gaining access to low-level resources such as hardware and memory space.\n It provides a generic interface that hides the environment specifics from the applications and libraries.\ndiff --git a/doc/guides/prog_guide/ethdev/index.rst b/doc/guides/prog_guide/ethdev/index.rst\nnew file mode 100644\nindex 0000000000..c8e3b0d37b\n--- /dev/null\n+++ b/doc/guides/prog_guide/ethdev/index.rst\n@@ -0,0 +1,12 @@\n+Ethernet Device Library\n+=======================\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n+ poll_mode_drv\n+ rte_flow\n+ switch_representation\n+ traffic_metering_and_policing\n+ traffic_management\n+ qos_framework\ndiff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/ethdev/poll_mode_drv.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/poll_mode_drv.rst\nrename to doc/guides/prog_guide/ethdev/poll_mode_drv.rst\ndiff --git a/doc/guides/prog_guide/qos_framework.rst b/doc/guides/prog_guide/ethdev/qos_framework.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/qos_framework.rst\nrename to doc/guides/prog_guide/ethdev/qos_framework.rst\ndiff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/ethdev/rte_flow.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/rte_flow.rst\nrename to doc/guides/prog_guide/ethdev/rte_flow.rst\ndiff --git a/doc/guides/prog_guide/switch_representation.rst b/doc/guides/prog_guide/ethdev/switch_representation.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/switch_representation.rst\nrename to doc/guides/prog_guide/ethdev/switch_representation.rst\ndiff --git a/doc/guides/prog_guide/traffic_management.rst b/doc/guides/prog_guide/ethdev/traffic_management.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/traffic_management.rst\nrename to doc/guides/prog_guide/ethdev/traffic_management.rst\ndiff --git a/doc/guides/prog_guide/traffic_metering_and_policing.rst b/doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/traffic_metering_and_policing.rst\nrename to doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst\ndiff --git a/doc/guides/prog_guide/event_crypto_adapter.rst b/doc/guides/prog_guide/eventdev/event_crypto_adapter.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/event_crypto_adapter.rst\nrename to doc/guides/prog_guide/eventdev/event_crypto_adapter.rst\ndiff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/eventdev/event_ethernet_rx_adapter.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/event_ethernet_rx_adapter.rst\nrename to doc/guides/prog_guide/eventdev/event_ethernet_rx_adapter.rst\ndiff --git a/doc/guides/prog_guide/event_ethernet_tx_adapter.rst b/doc/guides/prog_guide/eventdev/event_ethernet_tx_adapter.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/event_ethernet_tx_adapter.rst\nrename to doc/guides/prog_guide/eventdev/event_ethernet_tx_adapter.rst\ndiff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/eventdev/event_timer_adapter.rst\nsimilarity index 100%\nrename from doc/guides/prog_guide/event_timer_adapter.rst\nrename to doc/guides/prog_guide/eventdev/event_timer_adapter.rst\ndiff --git a/doc/guides/prog_guide/eventdev.rst b/doc/guides/prog_guide/eventdev/eventdev.rst\nsimilarity index 99%\nrename from doc/guides/prog_guide/eventdev.rst\nrename to doc/guides/prog_guide/eventdev/eventdev.rst\nindex 2c83176846..211fcaeb9f 100644\n--- a/doc/guides/prog_guide/eventdev.rst\n+++ b/doc/guides/prog_guide/eventdev/eventdev.rst\n@@ -169,7 +169,7 @@ walk-through:\n \n .. _figure_eventdev-usage1:\n \n-.. figure:: img/eventdev_usage.*\n+.. figure:: ../img/eventdev_usage.*\n \n Sample eventdev usage, with RX, two atomic stages and a single-link to TX.\n \ndiff --git a/doc/guides/prog_guide/eventdev/index.rst b/doc/guides/prog_guide/eventdev/index.rst\nnew file mode 100644\nindex 0000000000..e0e3f4328d\n--- /dev/null\n+++ b/doc/guides/prog_guide/eventdev/index.rst\n@@ -0,0 +1,11 @@\n+Event Device Library\n+====================\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n+ eventdev\n+ event_ethernet_rx_adapter\n+ event_ethernet_tx_adapter\n+ event_timer_adapter\n+ event_crypto_adapter\ndiff --git a/doc/guides/prog_guide/fib_lib.rst b/doc/guides/prog_guide/fib_lib.rst\nindex 970a433d34..a81da2d491 100644\n--- a/doc/guides/prog_guide/fib_lib.rst\n+++ b/doc/guides/prog_guide/fib_lib.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2021 Intel Corporation.\n \n-FIB Library\n-===========\n+Forwarding Information Base (FIB) Library\n+=========================================\n \n The FIB library provides a fast Longest Prefix Match (LPM) search for 32-bit\n keys or 128-bit for IPv6. It can be used in a variety of applications,\ndiff --git a/doc/guides/prog_guide/generic_receive_offload_lib.rst b/doc/guides/prog_guide/generic_receive_offload_lib.rst\nindex 6d176947e4..f2b5ff9eed 100644\n--- a/doc/guides/prog_guide/generic_receive_offload_lib.rst\n+++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2017 Intel Corporation.\n \n-Generic Receive Offload Library\n-===============================\n+Generic Receive Offload (GRO) Library\n+=====================================\n \n Generic Receive Offload (GRO) is a widely used SW-based offloading\n technique to reduce per-packet processing overheads. By reassembling\ndiff --git a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst\nindex e605b86376..97b906aee1 100644\n--- a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst\n+++ b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2017 Intel Corporation.\n \n-Generic Segmentation Offload Library\n-====================================\n+Generic Segmentation Offload (GSO) Library\n+==========================================\n \n Overview\n --------\ndiff --git a/doc/guides/prog_guide/gpudev.rst b/doc/guides/prog_guide/gpudev.rst\nindex c6ae7191c8..de246d2a4c 100644\n--- a/doc/guides/prog_guide/gpudev.rst\n+++ b/doc/guides/prog_guide/gpudev.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright (c) 2021 NVIDIA Corporation & Affiliates\n \n-General-Purpose Graphics Processing Unit Library\n-================================================\n+General-Purpose Graphics Processing Unit (GPU) Library\n+======================================================\n \n When mixing networking activity with task processing on a GPU device,\n there may be the need to put in communication the CPU with the device\ndiff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst\nindex 52a6d9e7aa..6fcf304c68 100644\n--- a/doc/guides/prog_guide/index.rst\n+++ b/doc/guides/prog_guide/index.rst\n@@ -4,28 +4,67 @@\n Programmer's Guide\n ==================\n \n+Foundation Principles\n+---------------------\n+\n .. toctree::\n- :maxdepth: 3\n- :numbered:\n+ :maxdepth: 1\n \n intro\n overview\n source_org\n- env_abstraction_layer\n- log_lib\n- service_cores\n- trace_lib\n- rcu_lib\n- ring_lib\n- stack_lib\n+ glossary \n+\n+Memory Management\n+-----------------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n mempool_lib\n mbuf_lib\n- poll_mode_drv\n- rte_flow\n- switch_representation\n- traffic_metering_and_policing\n- traffic_management\n- bbdev\n+ multi_proc_support\n+\n+CPU Management\n+--------------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n+ env_abstraction_layer\n+ power_man\n+ thread_safety\n+ service_cores\n+\n+CPU Packet Processing\n+---------------------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n+ lpm_lib\n+ lpm6_lib\n+ rib_lib\n+ fib_lib\n+ packet_classif_access_ctrl\n+ packet_distrib_lib\n+ efd_lib\n+ reorder_lib\n+ ip_fragment_reassembly_lib\n+ generic_receive_offload_lib\n+ generic_segmentation_offload_lib\n+ toeplitz_hash_lib\n+ hash_lib\n+ member_lib\n+\n+Device Libraries\n+----------------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n+ ethdev/index\n+ vhost_lib\n cryptodev_lib\n compressdev\n regexdev\n@@ -35,46 +74,62 @@ Programmer's Guide\n rte_security\n rawdev\n link_bonding_poll_mode_drv_lib\n+ bbdev\n+ eventdev/index\n+\n+Utility Libraries\n+-----------------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n timer_lib\n- hash_lib\n- toeplitz_hash_lib\n- efd_lib\n- member_lib\n- lpm_lib\n- lpm6_lib\n- fib_lib\n- rib_lib\n- packet_distrib_lib\n- reorder_lib\n- ip_fragment_reassembly_lib\n- generic_receive_offload_lib\n- generic_segmentation_offload_lib\n- ipsec_lib\n- pdcp_lib\n- pcapng_lib\n- pdump_lib\n- multi_proc_support\n- thread_safety_dpdk_functions\n- eventdev\n- event_ethernet_rx_adapter\n- event_ethernet_tx_adapter\n- event_timer_adapter\n- event_crypto_adapter\n- qos_framework\n- power_man\n- packet_classif_access_ctrl\n- packet_framework\n- vhost_lib\n+ rcu_lib\n+ ring_lib\n+ stack_lib\n metrics_lib\n telemetry_lib\n+ pdump_lib\n+ pcapng_lib\n bpf_lib\n+ trace_lib\n+\n+Protocol Processing Libraries\n+-----------------------------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n+ pdcp_lib\n+ ipsec_lib\n+\n+High-Level Libraries\n+--------------------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n+ packet_framework\n graph_lib\n+\n+Howto Guides\n+-------------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n build-sdk-meson\n meson_ut\n build_app\n+\n+Tips & Tricks\n+-------------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n perf_opt_guidelines\n writing_efficient_code\n lto\n profile_app\n asan\n- glossary\ndiff --git a/doc/guides/prog_guide/lpm6_lib.rst b/doc/guides/prog_guide/lpm6_lib.rst\nindex 8425d14805..2c3eb10857 100644\n--- a/doc/guides/prog_guide/lpm6_lib.rst\n+++ b/doc/guides/prog_guide/lpm6_lib.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2010-2014 Intel Corporation.\n \n-LPM6 Library\n-============\n+Longest Prefix Match 6 (LPM6) Library\n+=====================================\n \n The LPM6 (LPM for IPv6) library component implements the Longest Prefix Match (LPM) table search method for 128-bit keys\n that is typically used to find the best match route in IPv6 forwarding applications.\ndiff --git a/doc/guides/prog_guide/lpm_lib.rst b/doc/guides/prog_guide/lpm_lib.rst\nindex 03945904b3..191fb8d81b 100644\n--- a/doc/guides/prog_guide/lpm_lib.rst\n+++ b/doc/guides/prog_guide/lpm_lib.rst\n@@ -3,8 +3,8 @@\n \n .. _LPM_Library:\n \n-LPM Library\n-===========\n+Longest Prefix Match (LPM) Library\n+==================================\n \n The DPDK LPM library component implements the Longest Prefix Match (LPM) table search method for 32-bit keys\n that is typically used to find the best route match in IP forwarding applications.\ndiff --git a/doc/guides/prog_guide/mbuf_lib.rst b/doc/guides/prog_guide/mbuf_lib.rst\nindex 049357c755..50fbd99923 100644\n--- a/doc/guides/prog_guide/mbuf_lib.rst\n+++ b/doc/guides/prog_guide/mbuf_lib.rst\n@@ -3,10 +3,10 @@\n \n .. _Mbuf_Library:\n \n-Mbuf Library\n-============\n+Packet (Mbuf) Library\n+=====================\n \n-The mbuf library provides the ability to allocate and free buffers (mbufs)\n+The Packet (MBuf) library provides the ability to allocate and free buffers (mbufs)\n that may be used by the DPDK application to store message buffers.\n The message buffers are stored in a mempool, using the :ref:`Mempool Library <Mempool_Library>`.\n \ndiff --git a/doc/guides/prog_guide/mempool_lib.rst b/doc/guides/prog_guide/mempool_lib.rst\nindex 4db577fe18..8769505d5d 100644\n--- a/doc/guides/prog_guide/mempool_lib.rst\n+++ b/doc/guides/prog_guide/mempool_lib.rst\n@@ -3,8 +3,8 @@\n \n .. _Mempool_Library:\n \n-Mempool Library\n-===============\n+Memory Pool Library\n+===================\n \n A memory pool is an allocator of a fixed-sized object.\n In the DPDK, it is identified by name and uses a mempool handler to store free objects.\ndiff --git a/doc/guides/prog_guide/mldev.rst b/doc/guides/prog_guide/mldev.rst\nindex 102fbda71c..f9109a6a22 100644\n--- a/doc/guides/prog_guide/mldev.rst\n+++ b/doc/guides/prog_guide/mldev.rst\n@@ -1,10 +1,10 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright (c) 2022 Marvell.\n \n-Machine Learning Device Library\n-===============================\n+Machine Learning (ML) Device Library\n+===========================================\n \n-The MLDEV library provides a Machine Learning device framework for the management and\n+The Machine Learning (ML) Device library provides a Machine Learning device framework for the management and\n provisioning of hardware and software ML poll mode drivers,\n defining an API which support a number of ML operations\n including device handling and inference processing.\ndiff --git a/doc/guides/prog_guide/packet_classif_access_ctrl.rst b/doc/guides/prog_guide/packet_classif_access_ctrl.rst\nindex 1811db4618..c8844d0616 100644\n--- a/doc/guides/prog_guide/packet_classif_access_ctrl.rst\n+++ b/doc/guides/prog_guide/packet_classif_access_ctrl.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2010-2015 Intel Corporation.\n \n-Packet Classification and Access Control\n-========================================\n+Packet Classification and Access Control (ACL) Library\n+======================================================\n \n The DPDK provides an Access Control library that gives the ability\n to classify an input packet based on a set of classification rules.\ndiff --git a/doc/guides/prog_guide/packet_framework.rst b/doc/guides/prog_guide/packet_framework.rst\nindex ebc69d8c3e..9b8896aa74 100644\n--- a/doc/guides/prog_guide/packet_framework.rst\n+++ b/doc/guides/prog_guide/packet_framework.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2010-2014 Intel Corporation.\n \n-Packet Framework\n-================\n+Packet Framework Library\n+========================\n \n Design Objectives\n -----------------\ndiff --git a/doc/guides/prog_guide/rawdev.rst b/doc/guides/prog_guide/rawdev.rst\nindex 488e0a7ef6..f8aa3856d7 100644\n--- a/doc/guides/prog_guide/rawdev.rst\n+++ b/doc/guides/prog_guide/rawdev.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright 2018 NXP\n \n-Rawdevice Library\n-=================\n+Raw Device Library\n+==================\n \n Introduction\n ------------\ndiff --git a/doc/guides/prog_guide/regexdev.rst b/doc/guides/prog_guide/regexdev.rst\nindex 93229fa743..3bf3b154b4 100644\n--- a/doc/guides/prog_guide/regexdev.rst\n+++ b/doc/guides/prog_guide/regexdev.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright 2020 Mellanox Technologies, Ltd\n \n-RegEx Device Library\n-====================\n+Regular Expression (RegEx) Device Library\n+=========================================\n \n The RegEx library provides a RegEx device framework for management and\n provisioning of hardware and software RegEx poll mode drivers, defining generic\ndiff --git a/doc/guides/prog_guide/rib_lib.rst b/doc/guides/prog_guide/rib_lib.rst\nindex 53ca3518a0..40b7de3f1d 100644\n--- a/doc/guides/prog_guide/rib_lib.rst\n+++ b/doc/guides/prog_guide/rib_lib.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2021 Intel Corporation.\n \n-RIB Library\n-===========\n+Routing Information Base (RIB) Library\n+======================================\n \n The Routing Information Base (RIB) library provides a data store for routing information.\n This library is intended for use in control or management plane applications.\ndiff --git a/doc/guides/prog_guide/thread_safety_dpdk_functions.rst b/doc/guides/prog_guide/thread_safety.rst\nsimilarity index 98%\nrename from doc/guides/prog_guide/thread_safety_dpdk_functions.rst\nrename to doc/guides/prog_guide/thread_safety.rst\nindex 5618e25e47..f7cda8bb32 100644\n--- a/doc/guides/prog_guide/thread_safety_dpdk_functions.rst\n+++ b/doc/guides/prog_guide/thread_safety.rst\n@@ -1,8 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2010-2014 Intel Corporation.\n \n-Thread Safety of DPDK Functions\n-===============================\n+Thread Safety\n+=============\n \n The DPDK is comprised of several libraries.\n Some of the functions in these libraries can be safely called from multiple threads simultaneously, while others cannot.\n", "prefixes": [ "1/1" ] }