ry.
- 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
---
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
-Glossary Introduction Formatting: Refined the introduction's formatting for
clarity.
-Directive Implementation: Used .. glossary:: directive for structured term
definitions.
-Term Definitions and Linking: Expanded definitions for terms like BIOS,
Bifurcated Driver, Clang-LLVM, etc., with referen
Added new guide on hugepages for different architectures
Added hugepages_different_architectures to index
-Content Streamlining: Removed initial detailed instructions on setting up DPDK
for non-root users.
Emphasized that running DPDK as non-root on Linux requires IOMMU support
through vfio.
-Li
---
.../getting_started_guide/run_apps/index.rst | 10 ++
.../run_apps/run_apps.rst | 118 ++
2 files changed, 128 insertions(+)
create mode 100644 doc/guides/getting_started_guide/run_apps/index.rst
create mode 100644 doc/guides/getting_started_guide/run_ap
Replaced .. |reg| unicode:: U+000AE with .. include::
Added a reference to the section memory_setup_reserving_hugepages
-Corrected the sentence “To check if hugepages are are on your system” to
“To check if hugepages are reserved on your system”
-Updated the instructions for checking if your distr
-Common Tools for All Distributions: The common tools installation instructions
for
all Linux distributions and FreeBSD have been removed. Instead,
the tools are now listed under each specific distribution.
-Linux Distributions: The Linux distributions have been restructured to include
Alpine, Deb
Added link to Getting Started Guide in index.rst
Moved run_apps.rst to GSG index
Removed run_apps/index.rst - no longer needed
Added run_apps.rst to index
-Reformatted the introduction paragraph for better readability.
-Clarified that the guide provides basic step-by-step instructions with
OS-
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
---
doc/guides/getting_started_guide/glossary.rst | 75 +++
1 file changed, 75 insertions(+)
create mode 100644 doc/guides/getting_started_guide/glossary.rst
diff --git a/doc/guides/getting_started_guide/glossary.rst
b/doc/guides/getting_started_guide/glossary.rst
new file mode
---
doc/guides/index.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 244b99624c..51a47d3a51 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -7,6 +7,7 @@ DPDK documentation
.. toctree::
:maxdepth: 1
+ getting_started
---
.../appendix/cross_compile_dpdk.rst | 37 +++
.../appendix/dpdk_meson_build_options.rst | 57
.../getting_started_guide/appendix/index.rst | 17 +
.../running_dpdk_apps_without_root.rst| 36 +++
.../appendix/vfio_advanced.rst| 295 +++
---
.../getting_started_guide/system_setup.rst| 195 ++
1 file changed, 195 insertions(+)
create mode 100644 doc/guides/getting_started_guide/system_setup.rst
diff --git a/doc/guides/getting_started_guide/system_setup.rst
b/doc/guides/getting_started_guide/system_setup.rst
n
---
.../getting_started_guide/run_apps/index.rst | 10 ++
.../run_apps/run_apps.rst | 118 ++
2 files changed, 128 insertions(+)
create mode 100644 doc/guides/getting_started_guide/run_apps/index.rst
create mode 100644 doc/guides/getting_started_guide/run_ap
Section 2: Install and Build DPDK - Updated based on feedback; Merged
windows_install_build.rst into building_from_sources.rst; Updated Meson 0.57.x
to be required for Windows.
---
.../building_from_sources.rst | 174 ++
.../install_and_build/index.rst
Edited copy to be simpler based on feedback.
---
doc/guides/getting_started_guide/intro.rst | 13 +
1 file changed, 13 insertions(+)
create mode 100644 doc/guides/getting_started_guide/intro.rst
diff --git a/doc/guides/getting_started_guide/intro.rst
b/doc/guides/getting_started_gui
Updated based on latest v1 and v2 feedback.
David Young (7):
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
Added link to Getting Started Guide in index.rst
Section
Merged windows_install_build.rst into building_from_sources.rst
---
.../building_from_sources.rst | 124 ++
.../install_and_build/index.rst | 3 +-
.../windows_install_build.rst | 93 -
3 files changed, 96 insertions(+),
---
doc/guides/index.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 244b99624c..51a47d3a51 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -7,6 +7,7 @@ DPDK documentation
.. toctree::
:maxdepth: 1
+ getting_started
---
doc/guides/getting_started_guide/intro.rst | 7 ++-
1 file changed, 2 insertions(+), 5 deletions(-)
diff --git a/doc/guides/getting_started_guide/intro.rst
b/doc/guides/getting_started_guide/intro.rst
index 88bdd48849..538b3bacec 100644
--- a/doc/guides/getting_started_guide/intro.rst
++
This is version 2 of the patch series for updating the DPDK Documentation.
Thank you to everyone who provided feedback on the first version.
Changes since v1:
- Removed unnecessary verbiage from Section 1: Introduction
- Merged windows_install_build.rst into building_from_sources.rst
- Updated S
---
doc/guides/getting_started_guide/glossary.rst | 75 +++
1 file changed, 75 insertions(+)
create mode 100644 doc/guides/getting_started_guide/glossary.rst
diff --git a/doc/guides/getting_started_guide/glossary.rst
b/doc/guides/getting_started_guide/glossary.rst
new file mode
---
.../appendix/cross_compile_dpdk.rst | 37 +++
.../appendix/dpdk_meson_build_options.rst | 57
.../getting_started_guide/appendix/index.rst | 17 +
.../running_dpdk_apps_without_root.rst| 36 +++
.../appendix/vfio_advanced.rst| 295 +++
---
.../getting_started_guide/run_apps/index.rst | 10 ++
.../run_apps/run_apps.rst | 118 ++
2 files changed, 128 insertions(+)
create mode 100644 doc/guides/getting_started_guide/run_apps/index.rst
create mode 100644 doc/guides/getting_started_guide/run_ap
---
.../getting_started_guide/system_setup.rst| 195 ++
1 file changed, 195 insertions(+)
create mode 100644 doc/guides/getting_started_guide/system_setup.rst
diff --git a/doc/guides/getting_started_guide/system_setup.rst
b/doc/guides/getting_started_guide/system_setup.rst
n
---
.../building_from_sources.rst | 108 ++
.../install_and_build/index.rst | 15 +++
.../installing_prebuilt_packages.rst | 54 +
.../windows_install_build.rst | 93 +++
4 files changed, 270 insertions(+
---
doc/guides/getting_started_guide/intro.rst | 16
1 file changed, 16 insertions(+)
create mode 100644 doc/guides/getting_started_guide/intro.rst
diff --git a/doc/guides/getting_started_guide/intro.rst
b/doc/guides/getting_started_guide/intro.rst
new file mode 100644
index 00
The separate Getting Started Guides for Linux, FreeBSD, and Windows have been
consolidated into a single, streamlined guide to simplify the user experience
and facilitate easier maintenance.
David Young (6):
Section 1: Introduction
Section 2: Install and Build DPDK
Section 3: Setting up a
pkg update to maintain access to the most recent DPDK versions.
Signed-off-by: David Young
---
doc/guides/freebsd_gsg/install_from_ports.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/doc/guides/freebsd_gsg/install_from_ports.rst
b/doc/guides/freebsd_gsg/install_from
e make it clear which version is to be installed. The page previously
showed 'pkg install dpdk' without specifying the version.
Signed-off-by: David Young
---
doc/guides/freebsd_gsg/install_from_ports.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git
---
doc/guides/freebsd_gsg/install_from_ports.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/doc/guides/freebsd_gsg/install_from_ports.rst
b/doc/guides/freebsd_gsg/install_from_ports.rst
index d946f3f3b2..ae866cd879 100644
--- a/doc/guides/freebsd_gsg/install_from_po
31 matches
Mail list logo
