[PATCH v4 0/6] docs: getting started guide consolidation
David Young
dave at youngcopy.com
Thu Nov 23 02:26:21 CET 2023
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
More information about the dev
mailing list