From patchwork Fri Dec 8 02:11:07 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dave Young X-Patchwork-Id: 467 Return-Path: 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]) by inbox.dpdk.org (Postfix) with ESMTP id 129DB436A0; Fri, 8 Dec 2023 03:11:32 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EEFBA410FB; Fri, 8 Dec 2023 03:11:31 +0100 (CET) Received: from mail-yw1-f176.google.com (mail-yw1-f176.google.com [209.85.128.176]) by mails.dpdk.org (Postfix) with ESMTP id 37754402AC for ; Fri, 8 Dec 2023 03:11:30 +0100 (CET) Received: by mail-yw1-f176.google.com with SMTP id 00721157ae682-5d63f04779bso2660227b3.1 for ; Thu, 07 Dec 2023 18:11:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=youngcopy-com.20230601.gappssmtp.com; s=20230601; t=1702001489; x=1702606289; darn=dpdk.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=c20hff+IPckyF/vbmB0/BGEXYSKKyXyCcD351Yes3sk=; b=xuxlrDqRKd0A0hC+fBJBLHdkzrWTuP8Wr9W9THJhgzvLOIWDisZ7Suz10eYwxSFkDW 371tjDYHT/ydjQqhcb2f5jJRVskvfocBHAtD1fYyjY/1M3+DsMgod9ajrvfh/Ynlgh79 pTsHMRwm+cCA78O4q8v71utG1cys49zy3QRoGam62RXzlbnp4w+BxHSgqmIVG9lYtM89 DSH13EwsZbtekFxtqH19AayLyCP1Yxq0PidUTpf54uEa5esyRQY67vTrMdVJ3VeLVCuh preKvI+iR7ebQuigARmxaafcRi2/gmENvDUxkAs2Q8Rf8f0oLQznGcxpomZiJGzDUTLd 66aw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1702001489; x=1702606289; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=c20hff+IPckyF/vbmB0/BGEXYSKKyXyCcD351Yes3sk=; b=q++wfkXGACcHk4uRS/y7JBUBs66l44Hnl8X+tvQ1oL3lmzV0P6fTJixHCKgd1nJb1P gd0ZcRIKkT3+/wV6KWS/hYAQAagPZq6FTYZe+HAM38DRzcky//Cck8C6bruiHDkXfNgu 5a2RwJJ04H/3eTw+HkKW1Pyt8Ro4meORPLnR86zuKKVv9MIujC41znRIkG439sbp7JLO e4hkhAeIBi9JP/jYc1Vugs+H6lG1CTpR7AoAfIsyqJNSQJ8MwUN4vx+yLghTKR241m7W yzXlnZtN27uyuTPgLih+ChjJje7IRG+ACWfsFsDULDGQcBGMm0JV1O1pIilKZ/IUwB89 KbhA== X-Gm-Message-State: AOJu0YzGPfQYyFMzEhteI2prCEGiae6vgeeZkSkMOhbmqJcdthrkkxA5 KEiRVPWNBLVcDwckD3SF8IfwdRK8/Yi7SvlOHF8= X-Google-Smtp-Source: AGHT+IEEWEKEuAlPXqoYq29l4Z/BNE4Q54ji3lj8GRd+EKYK9qgN39NLUOV/Rwc60sDI4RoUaZhgdQ== X-Received: by 2002:a0d:cbce:0:b0:5d4:3013:25d6 with SMTP id n197-20020a0dcbce000000b005d4301325d6mr5324149ywd.5.1702001488813; Thu, 07 Dec 2023 18:11:28 -0800 (PST) Received: from localhost.localdomain ([2600:1700:20c0:a560:d1dd:3efb:9d96:5cfd]) by smtp.gmail.com with ESMTPSA id v4-20020a818504000000b005d9729068f5sm339927ywf.42.2023.12.07.18.11.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 07 Dec 2023 18:11:28 -0800 (PST) From: David Young To: dev@dpdk.org Cc: Bruce Richardson , Thomas Monjalon , David Young Subject: [PATCH 0/1] docs:programmers guide index reflow Date: Thu, 7 Dec 2023 21:11:07 -0500 Message-ID: <20231208021108.2001-1-dave@youngcopy.com> X-Mailer: git-send-email 2.41.0.windows.1 MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org 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%)