From: David Young <dave@youngcopy.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>,
Thomas Monjalon <thomas@monjalon.net>,
David Young <dave@youngcopy.com>
Subject: [PATCH 0/1] docs:programmers guide index reflow
Date: Thu, 7 Dec 2023 21:11:07 -0500 [thread overview]
Message-ID: <20231208021108.2001-1-dave@youngcopy.com> (raw)
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%)
--
2.41.0.windows.1
next reply other threads:[~2023-12-08 2:11 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-08 2:11 David Young [this message]
2023-12-08 2:11 ` [PATCH 1/1] Modified Programmer's Guide index for better organization and readability David Young
2023-12-08 15:43 ` Dave Young
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231208021108.2001-1-dave@youngcopy.com \
--to=dave@youngcopy.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).