From: David Young <dave@youngcopy.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>,
Aaron Conole <aconole@redhat.com>,
David Young <dave@youngcopy.com>
Subject: [PATCH v4 0/6] docs: getting started guide consolidation
Date: Wed, 22 Nov 2023 20:26:21 -0500 [thread overview]
Message-ID: <20231123012633.2005-1-dave@youngcopy.com> (raw)
In-Reply-To: <20231103040202.2849-1-dave@youngcopy.com>
This patch series introduces significant updates to the DPDK Getting Started
Guide, enhancing user accessibility and content clarity:
1-Structural Improvements:
Integrated links to the Getting Started Guide in the main index.
Relocated run_apps.rst to the GSG index and removed run_apps/index.rst.
2-Refined Introduction:
Revised the introduction for improved clarity.
Highlighted step-by-step instructions adaptable for various operating systems.
3-Installation and Build Process Updates:
Redesigned installation instructions, categorizing tools under specific Linux
distributions and FreeBSD.
Updated Windows section with intuitive navigation and refreshed DPDK building
instructions in line with the latest Meson build system.
4-Technical Enhancements:
Updated unicode representations with isonum.txt.
Refined the hugepages section with corrected information and additional guidance.
Streamlined VFIO section instructions for network port binding using dpdk-devbind.py.
5-New Additions and Content Streamlining:
Introduced a guide on hugepages for various architectures.
Focused on IOMMU support for VFIO on Linux, along with simplified FreeBSD content.
Introduced reference tags (.. _vfio_platform:, .. _bifurcated_driver:,
.. _uio:) for improved document navigation.
6-Glossary and Navigation Enhancement:
Enhanced glossary formatting for readability.
Employed structured term definitions with .. glossary:: directive.
Expanded term definitions with links to content pages and integrated hyperlinks.
David Young (6):
Section 1: Introduction
Section 2: Install and Build DPDK
Section 3: Setting up a System to Run DPDK Applications
Section 4: Running Applications
Section 5: Appendix
Section 6: Glossary
.../appendix/cross_compile_dpdk.rst | 37 +++
.../appendix/dpdk_meson_build_options.rst | 57 ++++
.../hugepages_different_architectures.rst | 56 ++++
.../getting_started_guide/appendix/index.rst | 18 ++
.../running_dpdk_apps_without_root.rst | 24 ++
.../appendix/vfio_advanced.rst | 301 ++++++++++++++++++
doc/guides/getting_started_guide/glossary.rst | 78 +++++
doc/guides/getting_started_guide/index.rst | 18 ++
.../building_from_sources.rst | 180 +++++++++++
.../install_and_build/index.rst | 14 +
.../installing_prebuilt_packages.rst | 54 ++++
doc/guides/getting_started_guide/intro.rst | 13 +
doc/guides/getting_started_guide/run_apps.rst | 114 +++++++
.../getting_started_guide/run_apps/index.rst | 10 +
.../run_apps/run_apps.rst | 118 +++++++
.../getting_started_guide/system_setup.rst | 197 ++++++++++++
doc/guides/index.rst | 1 +
17 files changed, 1290 insertions(+)
create mode 100644 doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst
create mode 100644 doc/guides/getting_started_guide/appendix/dpdk_meson_build_options.rst
create mode 100644 doc/guides/getting_started_guide/appendix/hugepages_different_architectures.rst
create mode 100644 doc/guides/getting_started_guide/appendix/index.rst
create mode 100644 doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst
create mode 100644 doc/guides/getting_started_guide/appendix/vfio_advanced.rst
create mode 100644 doc/guides/getting_started_guide/glossary.rst
create mode 100644 doc/guides/getting_started_guide/index.rst
create mode 100644 doc/guides/getting_started_guide/install_and_build/building_from_sources.rst
create mode 100644 doc/guides/getting_started_guide/install_and_build/index.rst
create mode 100644 doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst
create mode 100644 doc/guides/getting_started_guide/intro.rst
create mode 100644 doc/guides/getting_started_guide/run_apps.rst
create mode 100644 doc/guides/getting_started_guide/run_apps/index.rst
create mode 100644 doc/guides/getting_started_guide/run_apps/run_apps.rst
create mode 100644 doc/guides/getting_started_guide/system_setup.rst
--
2.41.0.windows.1
next prev parent reply other threads:[~2023-11-23 1:26 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-03 4:01 [PATCH v3 0/7] " David Young
2023-11-03 4:01 ` [PATCH v3 1/7] Section 1: Introduction David Young
2023-11-03 13:11 ` Bruce Richardson
2023-11-03 4:01 ` [PATCH v3 2/7] Section 2: Install and Build DPDK David Young
2023-11-03 13:55 ` Bruce Richardson
2023-11-03 4:01 ` [PATCH v3 3/7] Section 3: Setting up a System to Run DPDK Applications David Young
2023-11-03 14:17 ` Bruce Richardson
2023-11-03 4:01 ` [PATCH v3 4/7] Section 4: Running Applications David Young
2023-11-03 15:13 ` Bruce Richardson
2023-11-03 4:01 ` [PATCH v3 5/7] Section 5: Appendix David Young
2023-11-03 15:23 ` Bruce Richardson
2023-11-16 1:28 ` Dave Young
2023-11-17 13:04 ` Bruce Richardson
2023-11-03 4:01 ` [PATCH v3 6/7] Added link to Getting Started Guide in index.rst David Young
2023-11-03 13:32 ` Bruce Richardson
2023-11-03 14:22 ` Bruce Richardson
2023-11-08 1:47 ` Dave Young
2023-11-08 2:06 ` Dave Young
2023-11-03 4:01 ` [PATCH v3 7/7] Section 6: Glossary David Young
2023-11-03 15:26 ` Bruce Richardson
2023-11-23 1:26 ` David Young [this message]
2023-11-23 1:26 ` [PATCH v4 1/6] Section 1: Introduction David Young
2023-11-23 1:26 ` [PATCH v4 2/6] Section 2: Install and Build DPDK David Young
2023-11-23 1:26 ` [PATCH v4 3/6] Section 3: Setting up a System to Run DPDK Applications David Young
2023-11-23 1:26 ` [PATCH v4 4/6] Section 4: Running Applications David Young
2023-11-23 1:26 ` [PATCH v4 5/6] Section 5: Appendix David Young
2023-11-23 1:26 ` [PATCH v4 6/6] Section 6: Glossary David Young
2023-12-01 15:17 ` [PATCH v4 0/6] docs: getting started guide consolidation Thomas Monjalon
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=20231123012633.2005-1-dave@youngcopy.com \
--to=dave@youngcopy.com \
--cc=aconole@redhat.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
/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).