docs: Unify Getting Started Guides

---
 doc/guides/getting_started_guide/intro.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 doc/guides/getting_started_guide/intro.rst

doc/guides/getting_started_guide/intro.rst new file +0 -0

new file mode 100644
index 0000000000..88bdd48849

Review

Quoted 6 lines · David Young

---
 doc/guides/getting_started_guide/intro.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 doc/guides/getting_started_guide/intro.rst

(quoted diff) +0 -0

b/doc/guides/getting_started_guide/intro.rst

doc/guides/getting_started_guide/intro.rst line 7

Quoted 12 lines

new file mode 100644
index 0000000000..88bdd48849

doc/guides/getting_started_guide/intro.rst new file +7 -0

@@ -0,0 +1,16 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2014 Intel Corporation.
+
+Introduction
+============
+
+Welcome to the unified getting started guide for the Data Plane

Development Kit (DPDK) covering Linux, FreeBSD, and Windows. DPDK is a set of libraries and

Quoted 1 line

'unified' makes sense only with the context of this effort, for anyone who is reading this for the first time it may not mean much, I suggest just drop it: "Welcome to the getting started guide for ..."

Quoted 1 line

+drivers that accelerate packet processing and allow the user to create

high-performance

doc/guides/getting_started_guide/intro.rst

Quoted 3 lines

doc/guides/getting_started_guide/intro.rst new file +3 -0

+networking applications.
+
+The guide is structured to provide basic step-by-step instructions with

OS-specific instructions for each operating system where necessary.

Quoted 1 line

+By the end of this guide, you should have a solid understanding of how

to implement and

Quoted 1 line

+use DPDK in your networking projects, regardless of the operating

system you are using.

doc/guides/getting_started_guide/intro.rst

Quoted 2 lines

doc/guides/getting_started_guide/intro.rst new file +2 -0

+
+We hope this guide serves as a valuable resource as you explore the

powerful

Quoted 2 lines

+capabilities of DPDK.
\ No newline at end of file

Last paragraph feels like marketing text :), I would be OK without it, but this is personal preference.

---
 .../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(+)
 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/install_and_build/windows_install_build.rst

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +13 -0

new file mode 100644
index 0000000000..e4ee8e436d
@@ -0,0 +1,108 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _building_from_sources:
+
+Building and Installing DPDK from Sources
+=========================================
+
+This chapter provides a comprehensive guide for building DPDK from sources on both
+Linux and FreeBSD platforms. It covers the necessary steps, prerequisites, 
+and considerations for different architectures and compilers.
+
+Required Tools

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +16 -0

+Here's how to install them:
+
+Linux
+^^^^^
+
+Alpine
+
+.. code-block:: bash
+
+   sudo apk add alpine-sdk bsd-compat-headers
+   pip install meson ninja
+
+Debian and Ubuntu and derivatives
+
+.. code-block:: bash
+

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +41 -0

+openSUSE
+
+.. code-block:: bash
+
+   sudo zypper install -t pattern devel_basis python3-pyelftools
+   pip install meson ninja
+
+FreeBSD
+^^^^^^^
+
+FreeBSD (as root)
+
+.. code-block:: bash
+
+   pkg install meson pkgconf py38-pyelftools
+
+Note: If you're using FreeBSD, you'll also need kernel sources. Make sure they're included during the FreeBSD installation.
+
+Getting the DPDK Source
+-----------------------
+
+Download the DPDK source code from the official repository 
+``https://fast.dpdk.org/rel/``.
+
+Use ``wget`` to grab the DPDK version::
+
+        wget https://fast.dpdk.org/rel/dpdk-<version>.tar.xz
+
+Extract the downloaded archive:
+
+.. code-block:: bash
+
+   tar -xvf dpdk-<version>.tar.gz
+
+Navigate to the DPDK directory:
+
+.. code-block:: bash
+
+   cd dpdk-<version>
+
+Building DPDK

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +8 -0

+   ldconfig
+
+For detailed information on Meson build configuration options specific to DPDK, see :ref:`DPDK Meson Build Configuration Options <dpdk_meson_build_options>`.
+
+Cross-Compilation Instructions for Different Architectures
+----------------------------------------------------------
+
+For instructions on building DPDK for ARM64, LoongArch, and RISC-V, refer to :ref:`cross_compile_dpdk`.

doc/guides/getting_started_guide/install_and_build/index.rst new file +0 -0

new file mode 100644
index 0000000000..f4d8740fb6

doc/guides/getting_started_guide/install_and_build/index.rst new file +12 -0

+.. _install_and_build:
+
+Install and Build DPDK
+======================
+
+.. toctree::
+    :maxdepth: 2
+
+    
+    installing_prebuilt_packages
+    building_from_sources
+    windows_install_build
\ No newline at end of file

doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst new file +54 -0

new file mode 100644
index 0000000000..3e395d65f1
@@ -0,0 +1,54 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _installing_prebuilt_packages:
+
+Installing Pre-built Packages
+=============================
+
+Pre-built packages provide a convenient way to install DPDK without the need to compile
+the source code manually. These packages are created and maintained by the DPDK
+community or OS vendors and are available for various operating systems and
+distributions.
+
+Available Distributions
+-----------------------
+
+Linux
+^^^^^
+
+Pre-built DPDK packages are available for several popular Linux distributions,
+including but not limited to:
+
+Alpine
+
+.. code-block:: bash
+
+   sudo apk add dpdk
+
+Debian and Ubuntu and derivatives
+
+.. code-block:: bash
+
+   sudo apt-get install dpdk
+
+Fedora and RedHat Enterprise Linux RHEL
+
+.. code-block:: bash
+
+   sudo dnf install dpdk
+
+openSUSE
+
+.. code-block:: bash
+
+   sudo zypper install dpdk
+
+FreeBSD
+^^^^^^^
+
+To install DPDK on FreeBSD, use the following command:
+
+.. code-block:: bash
+
+   sudo pkg install dpdk
\ No newline at end of file

doc/guides/getting_started_guide/install_and_build/windows_install_build.rst new file +10 -0

new file mode 100644
index 0000000000..ea0e131766
@@ -0,0 +1,93 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2015 Intel Corporation.
+
+.. _windows_install_build:
+
+Windows DPDK Build
+==================
+
+Before you begin the process of building DPDK on Windows, 
+make sure your system meets all the necessary requirements as outlined below.

doc/guides/getting_started_guide/install_and_build/windows_install_build.rst new file +39 -0

+The Meson Build system is used to prepare the sources for compilation with the Ninja backend.
+
+Option 1: Clang-LLVM C Compiler and Microsoft MSVC Linker
+---------------------------------------------------------
+
+1. Install the Compiler: Download and install the clang compiler from the 
+`LLVM website <http://releases.llvm.org/>`_.
+
+2. Install the Linker: Download and install the Build Tools for Visual Studio from the
+`Microsoft website <https://visualstudio.microsoft.com/downloads/>`_. 
+When installing build tools, select the “Visual C++ build tools” option and make sure
+the Windows SDK is selected.
+
+Option 2: MinGW-w64 Toolchain
+-----------------------------
+
+1. On Linux (for cross-compilation): Install MinGW-w64 via a package manager. 
+Version 4.0.4 for Ubuntu 16.04 cannot be used due to a MinGW-w64 bug.
+
+2. On Windows: Obtain the latest version installer from the
+`MinGW-w64 repository <https://mingw-w64.org/doku.php>`_. 
+Any thread model (POSIX or Win32) can be chosen, DPDK does not rely on it. 
+Install to a folder without spaces in its name, like ``C:\MinGW``. 
+This path is assumed for the rest of this guide.
+
+Install the Build System
+------------------------
+
+Download and install the build system from the
+`Meson website <http://mesonbuild.com/Getting-meson.html#installing-meson-and-ninja-with-the-msi-installer>`_. 
+A good option to choose is the MSI installer for both meson and ninja together.
+Recommended version is either Meson 0.57.0 (baseline) or the latest release.
+
+Install the Backend
+-------------------
+
+If using Ninja, download and install the backend from the
+`Ninja website <https://ninja-build.org/>`_ or install along with the meson build
+system. 

Quoted 31 lines · David Young

---
 .../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(+)
 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/install_and_build/windows_install_build.rst

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +13 -0

new file mode 100644
index 0000000000..e4ee8e436d
@@ -0,0 +1,108 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _building_from_sources:
+
+Building and Installing DPDK from Sources
+=========================================
+
+This chapter provides a comprehensive guide for building DPDK from sources on both
+Linux and FreeBSD platforms. It covers the necessary steps, prerequisites, 
+and considerations for different architectures and compilers.
+
+Required Tools

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst line 23

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +10 -0

+--------------
+
+To build DPDK, you'll need the following tools:
+
+- A C compiler like ``gcc`` (version 5+) or ``clang`` (version 3.6+)
+- ``pkg-config`` or ``pkgconf``
+- Python 3.6 or later
+- ``meson`` (version 0.53.2+) and ``ninja``
+- ``pyelftools`` (version 0.22+)
+

Is 'libnuma' also a dependency?

When I remove it in my platform and build DPDK again, getting following in meson stage:

"
config/meson.build:419:4: ERROR: Problem encountered:
No NUMA library (development package) found, yet DPDK configured for multiple NUMA nodes.
Please install libnuma, or set 'max_numa_nodes' option to '1' to build without NUMA support.
"

Quoted 18 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +16 -0

+Here's how to install them:
+
+Linux
+^^^^^
+
+Alpine
+
+.. code-block:: bash
+
+   sudo apk add alpine-sdk bsd-compat-headers
+   pip install meson ninja
+
+Debian and Ubuntu and derivatives
+
+.. code-block:: bash
+

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst line 49

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +10 -0

+   sudo apt install build-essential
+   pip install meson ninja
+
+Fedora and RedHat Enterprise Linux RHEL
+
+.. code-block:: bash
+
+   sudo dnf groupinstall "Development Tools"
+   pip install meson ninja
+

Above are missing some of the dependencies above, just to confirm if they are installed by default?
And even if so, if we should provide explicit commands to install all, to be sure?

Quoted 46 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +46 -0

+openSUSE
+
+.. code-block:: bash
+
+   sudo zypper install -t pattern devel_basis python3-pyelftools
+   pip install meson ninja
+
+FreeBSD
+^^^^^^^
+
+FreeBSD (as root)
+
+.. code-block:: bash
+
+   pkg install meson pkgconf py38-pyelftools
+
+Note: If you're using FreeBSD, you'll also need kernel sources. Make sure they're included during the FreeBSD installation.
+
+Getting the DPDK Source
+-----------------------
+
+Download the DPDK source code from the official repository 
+``https://fast.dpdk.org/rel/``.
+
+Use ``wget`` to grab the DPDK version::
+
+        wget https://fast.dpdk.org/rel/dpdk-<version>.tar.xz
+
+Extract the downloaded archive:
+
+.. code-block:: bash
+
+   tar -xvf dpdk-<version>.tar.gz
+
+Navigate to the DPDK directory:
+
+.. code-block:: bash
+
+   cd dpdk-<version>
+
+Building DPDK
+-------------
+
+Configure the build based on your needs, hardware, and environment. 
+This might include setting specific flags or options. For example: “meson setup -Dbuildtype=debugoptimized build”. Then compile using “ninja” and install using “meson install”.
+

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +5 -0

+.. code-block:: bash
+
+   ninja -C build
+   cd build
+   sudo ninja install>

Above mentions from "meson install", here using "ninja install", should we unify it to one?

---
 .../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(+)
 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/install_and_build/windows_install_build.rst

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +1 -0

new file mode 100644
index 0000000000..e4ee8e436d
@@ -0,0 +1,108 @@
+..  SPDX-License-Identifier: BSD-3-Clause

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +97 -0

+
+Required Tools
+--------------
+
+To build DPDK, you'll need the following tools:
+
+- A C compiler like ``gcc`` (version 5+) or ``clang`` (version 3.6+)
+- ``pkg-config`` or ``pkgconf``
+- Python 3.6 or later
+- ``meson`` (version 0.53.2+) and ``ninja``
+- ``pyelftools`` (version 0.22+)
+
+Here's how to install them:
+
+Linux
+^^^^^
+
+Alpine
+
+.. code-block:: bash
+
+   sudo apk add alpine-sdk bsd-compat-headers
+   pip install meson ninja
+
+Debian and Ubuntu and derivatives
+
+.. code-block:: bash
+
+   sudo apt install build-essential
+   pip install meson ninja
+
+Fedora and RedHat Enterprise Linux RHEL
+
+.. code-block:: bash
+
+   sudo dnf groupinstall "Development Tools"
+   pip install meson ninja
+
+openSUSE
+
+.. code-block:: bash
+
+   sudo zypper install -t pattern devel_basis python3-pyelftools
+   pip install meson ninja
+
+FreeBSD
+^^^^^^^
+
+FreeBSD (as root)
+
+.. code-block:: bash
+
+   pkg install meson pkgconf py38-pyelftools
+
+Note: If you're using FreeBSD, you'll also need kernel sources. Make sure they're included during the FreeBSD installation.
+
+Getting the DPDK Source
+-----------------------
+
+Download the DPDK source code from the official repository 
+``https://fast.dpdk.org/rel/``.
+
+Use ``wget`` to grab the DPDK version::
+
+        wget https://fast.dpdk.org/rel/dpdk-<version>.tar.xz
+
+Extract the downloaded archive:
+
+.. code-block:: bash
+
+   tar -xvf dpdk-<version>.tar.gz
+
+Navigate to the DPDK directory:
+
+.. code-block:: bash
+
+   cd dpdk-<version>
+
+Building DPDK
+-------------
+
+Configure the build based on your needs, hardware, and environment. 
+This might include setting specific flags or options. For example: “meson setup -Dbuildtype=debugoptimized build”. Then compile using “ninja” and install using “meson install”.
+
+.. code-block:: bash
+
+   ninja -C build
+   cd build
+   sudo ninja install
+   ldconfig
+
+For detailed information on Meson build configuration options specific to DPDK, see :ref:`DPDK Meson Build Configuration Options <dpdk_meson_build_options>`.
+
+Cross-Compilation Instructions for Different Architectures
+----------------------------------------------------------
+
+For instructions on building DPDK for ARM64, LoongArch, and RISC-V, refer to :ref:`cross_compile_dpdk`.

doc/guides/getting_started_guide/install_and_build/index.rst new file +15 -0

new file mode 100644
index 0000000000..f4d8740fb6
@@ -0,0 +1,15 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _install_and_build:
+
+Install and Build DPDK
+======================
+
+.. toctree::
+    :maxdepth: 2
+
+    
+    installing_prebuilt_packages
+    building_from_sources
+    windows_install_build
\ No newline at end of file

doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst new file +54 -0

new file mode 100644
index 0000000000..3e395d65f1
@@ -0,0 +1,54 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _installing_prebuilt_packages:
+
+Installing Pre-built Packages
+=============================
+
+Pre-built packages provide a convenient way to install DPDK without the need to compile
+the source code manually. These packages are created and maintained by the DPDK
+community or OS vendors and are available for various operating systems and
+distributions.
+
+Available Distributions
+-----------------------
+
+Linux
+^^^^^
+
+Pre-built DPDK packages are available for several popular Linux distributions,
+including but not limited to:
+
+Alpine
+
+.. code-block:: bash
+
+   sudo apk add dpdk
+
+Debian and Ubuntu and derivatives
+
+.. code-block:: bash
+
+   sudo apt-get install dpdk
+
+Fedora and RedHat Enterprise Linux RHEL
+
+.. code-block:: bash
+
+   sudo dnf install dpdk
+
+openSUSE
+
+.. code-block:: bash
+
+   sudo zypper install dpdk
+
+FreeBSD
+^^^^^^^
+
+To install DPDK on FreeBSD, use the following command:
+
+.. code-block:: bash
+
+   sudo pkg install dpdk
\ No newline at end of file

doc/guides/getting_started_guide/install_and_build/windows_install_build.rst new file +8 -0

new file mode 100644
index 0000000000..ea0e131766
@@ -0,0 +1,93 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2015 Intel Corporation.
+
+.. _windows_install_build:
+
+Windows DPDK Build
+==================
+

doc/guides/getting_started_guide/install_and_build/windows_install_build.rst new file +24 -0

+- The MinGW-w64 toolchain (either native or cross).
+
+The Meson Build system is used to prepare the sources for compilation with the Ninja backend.
+
+Option 1: Clang-LLVM C Compiler and Microsoft MSVC Linker
+---------------------------------------------------------
+
+1. Install the Compiler: Download and install the clang compiler from the 
+`LLVM website <http://releases.llvm.org/>`_.
+
+2. Install the Linker: Download and install the Build Tools for Visual Studio from the
+`Microsoft website <https://visualstudio.microsoft.com/downloads/>`_. 
+When installing build tools, select the “Visual C++ build tools” option and make sure
+the Windows SDK is selected.
+
+Option 2: MinGW-w64 Toolchain
+-----------------------------
+
+1. On Linux (for cross-compilation): Install MinGW-w64 via a package manager. 
+Version 4.0.4 for Ubuntu 16.04 cannot be used due to a MinGW-w64 bug.
+
+2. On Windows: Obtain the latest version installer from the
+`MinGW-w64 repository <https://mingw-w64.org/doku.php>`_. 
+Any thread model (POSIX or Win32) can be chosen, DPDK does not rely on it. 

doc/guides/getting_started_guide/install_and_build/windows_install_build.rst new file +15 -0

+
+Once you have verified that your system meets these requirements, 
+you can proceed with the following steps to build DPDK.
+
+Build the Code
+--------------
+
+The build environment is setup to build the EAL and the helloworld example by default.
+To compile the examples, the flag -Dexamples is required.
+
+**Option 1. Native Build on Windows**
+
+When using Clang-LLVM, specifying the compiler might be required to complete the meson
+command::
+

doc/guides/getting_started_guide/install_and_build/windows_install_build.rst new file +8 -0

+
+**Option 2. Cross-Compile with MinGW-w64**
+
+The cross-file option must be specified for Meson. 
+Depending on the distribution, paths in this file may need adjustments::
+
+        meson --cross-file config/x86/cross-mingw -Dexamples=helloworld build
+        ninja -C build
\ No newline at end of file

Signature · 1 line

2.41.0.windows.1

Quoted 7 lines · David Young

---
 .../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(+)
 create mode 100644

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 1 line

 create mode 100644

doc/guides/getting_started_guide/install_and_build/index.rst

Quoted 1 line

 create mode 100644

doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst

Quoted 1 line

 create mode 100644

doc/guides/getting_started_guide/install_and_build/windows_install_build.rst

Quoted 2 lines

diff --git

a/doc/guides/getting_started_guide/install_and_build/building_from_sources.rst b/doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 4 lines

new file mode 100644
index 0000000000..e4ee8e436d
--- /dev/null
+++

b/doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst line 9

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +9 -0

@@ -0,0 +1,108 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _building_from_sources:
+
+Building and Installing DPDK from Sources
+=========================================
+
+This chapter provides a comprehensive guide for building DPDK from

sources on both

Review line 10

Quoted 1 line

(quoted diff) +1 -0

+Linux and FreeBSD platforms. It covers the necessary steps,

prerequisites,

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst line 11

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +1 -0

+and considerations for different architectures and compilers.

when the title of the section is general it shouldn't mention a specific OS in the content. if the content is OS specific then the parent section or the title of the section should identify to which OS it applies. in general it would be nice to convey that windows is an equally supported platform to the other operating systems.

i know it's a bit of a dance i hope you can help interpret what i'm trying to convey.

Quoted 45 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +45 -0

+
+Required Tools
+--------------
+
+To build DPDK, you'll need the following tools:
+
+- A C compiler like ``gcc`` (version 5+) or ``clang`` (version 3.6+)
+- ``pkg-config`` or ``pkgconf``
+- Python 3.6 or later
+- ``meson`` (version 0.53.2+) and ``ninja``
+- ``pyelftools`` (version 0.22+)
+
+Here's how to install them:
+
+Linux
+^^^^^
+
+Alpine
+
+.. code-block:: bash
+
+   sudo apk add alpine-sdk bsd-compat-headers
+   pip install meson ninja
+
+Debian and Ubuntu and derivatives
+
+.. code-block:: bash
+
+   sudo apt install build-essential
+   pip install meson ninja
+
+Fedora and RedHat Enterprise Linux RHEL
+
+.. code-block:: bash
+
+   sudo dnf groupinstall "Development Tools"
+   pip install meson ninja
+
+openSUSE
+
+.. code-block:: bash
+
+   sudo zypper install -t pattern devel_basis python3-pyelftools
+   pip install meson ninja
+

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +10 -0

+FreeBSD
+^^^^^^^
+
+FreeBSD (as root)
+
+.. code-block:: bash
+
+   pkg install meson pkgconf py38-pyelftools
+
+Note: If you're using FreeBSD, you'll also need kernel sources. Make

sure they're included during the FreeBSD installation.

Quoted 18 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +18 -0

+
+Getting the DPDK Source
+-----------------------
+
+Download the DPDK source code from the official repository
+``https://fast.dpdk.org/rel/`` <https://fast.dpdk.org/rel/>.
+
+Use ``wget`` to grab the DPDK version::
+
+        wget https://fast.dpdk.org/rel/dpdk-<version>.tar.xz
+
+Extract the downloaded archive:
+
+.. code-block:: bash
+
+   tar -xvf dpdk-<version>.tar.gz
+
+Navigate to the DPDK directory:

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +10 -0

+
+.. code-block:: bash
+
+   cd dpdk-<version>
+
+Building DPDK
+-------------
+
+Configure the build based on your needs, hardware, and environment.
+This might include setting specific flags or options. For example:

“meson setup -Dbuildtype=debugoptimized build”. Then compile using “ninja” and install using “meson install”.

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 9 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +9 -0

+
+.. code-block:: bash
+
+   ninja -C build
+   cd build
+   sudo ninja install
+   ldconfig
+
+For detailed information on Meson build configuration options specific

to DPDK, see :ref:DPDK Meson Build Configuration Options <dpdk_meson_build_options>.

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +5 -0

+
+Cross-Compilation Instructions for Different Architectures
+----------------------------------------------------------
+
+For instructions on building DPDK for ARM64, LoongArch, and RISC-V,

refer to :ref:cross_compile_dpdk.

Quoted 1 line

diff --git

a/doc/guides/getting_started_guide/install_and_build/index.rst b/doc/guides/getting_started_guide/install_and_build/index.rst

Quoted 21 lines

new file mode 100644
index 0000000000..f4d8740fb6

doc/guides/getting_started_guide/install_and_build/index.rst new file +15 -0

@@ -0,0 +1,15 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _install_and_build:
+
+Install and Build DPDK
+======================
+
+.. toctree::
+    :maxdepth: 2
+
+
+    installing_prebuilt_packages
+    building_from_sources
+    windows_install_build
\ No newline at end of file

Quoted 1 line

diff --git

a/doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst b/doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst

Quoted 4 lines

new file mode 100644
index 0000000000..3e395d65f1
--- /dev/null
+++

b/doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst

doc/guides/getting_started_guide/install_and_build/index.rst line 9

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +9 -0

@@ -0,0 +1,54 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _installing_prebuilt_packages:
+
+Installing Pre-built Packages
+=============================
+
+Pre-built packages provide a convenient way to install DPDK without the

need to compile

doc/guides/getting_started_guide/install_and_build/index.rst line 10

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+the source code manually. These packages are created and maintained by

the DPDK

doc/guides/getting_started_guide/install_and_build/index.rst line 11

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+community or OS vendors and are available for various operating systems

and

doc/guides/getting_started_guide/install_and_build/index.rst line 20

Quoted 9 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +9 -0

+distributions.
+
+Available Distributions
+-----------------------
+
+Linux
+^^^^^
+
+Pre-built DPDK packages are available for several popular Linux

distributions,

Quoted 35 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +34 -0

+including but not limited to:
+
+Alpine
+
+.. code-block:: bash
+
+   sudo apk add dpdk
+
+Debian and Ubuntu and derivatives
+
+.. code-block:: bash
+
+   sudo apt-get install dpdk
+
+Fedora and RedHat Enterprise Linux RHEL
+
+.. code-block:: bash
+
+   sudo dnf install dpdk
+
+openSUSE
+
+.. code-block:: bash
+
+   sudo zypper install dpdk
+
+FreeBSD
+^^^^^^^
+
+To install DPDK on FreeBSD, use the following command:
+
+.. code-block:: bash
+
+   sudo pkg install dpdk
\ No newline at end of file

Quoted 1 line

diff --git

a/doc/guides/getting_started_guide/install_and_build/windows_install_build.rst b/doc/guides/getting_started_guide/install_and_build/windows_install_build.rst

Quoted 4 lines

new file mode 100644
index 0000000000..ea0e131766
--- /dev/null
+++

b/doc/guides/getting_started_guide/install_and_build/windows_install_build.rst

doc/guides/getting_started_guide/install_and_build/index.rst line 10

Quoted 11 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +10 -0

@@ -0,0 +1,93 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2015 Intel Corporation.
+
+.. _windows_install_build:
+
+Windows DPDK Build
+==================
+
+Before you begin the process of building DPDK on Windows,
+make sure your system meets all the necessary requirements as outlined

below.

doc/guides/getting_started_guide/install_and_build/index.rst line 15

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+
+Windows System Requirements
+---------------------------
+
+Building the DPDK and its applications on Windows requires one of the

following

doc/guides/getting_started_guide/install_and_build/index.rst line 18

Quoted 3 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +3 -0

+environments:
+
+- The Clang-LLVM C compiler and Microsoft MSVC linker.

would it be overly objectionable to state specific LLVM >= 16.0.x as required?

doc/guides/getting_started_guide/install_and_build/index.rst line 21

Quoted 3 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +3 -0

+- The MinGW-w64 toolchain (either native or cross).
+
+The Meson Build system is used to prepare the sources for compilation

with the Ninja backend.

doc/guides/getting_started_guide/install_and_build/index.rst line 26

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+
+Option 1: Clang-LLVM C Compiler and Microsoft MSVC Linker
+---------------------------------------------------------
+
+1. Install the Compiler: Download and install the clang compiler from

the

doc/guides/getting_started_guide/install_and_build/index.rst line 29

Quoted 3 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +3 -0

+`LLVM website <http://releases.llvm.org/>`_.
+
+2. Install the Linker: Download and install the Build Tools for Visual

Studio from the

doc/guides/getting_started_guide/install_and_build/index.rst line 31

Quoted 2 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +2 -0

+`Microsoft website <https://visualstudio.microsoft.com/downloads/>`_.
+When installing build tools, select the “Visual C++ build tools” option

and make sure

doc/guides/getting_started_guide/install_and_build/index.rst line 37

Quoted 6 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +6 -0

+the Windows SDK is selected.
+
+Option 2: MinGW-w64 Toolchain
+-----------------------------
+
+1. On Linux (for cross-compilation): Install MinGW-w64 via a package

manager.

doc/guides/getting_started_guide/install_and_build/index.rst line 42

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+Version 4.0.4 for Ubuntu 16.04 cannot be used due to a MinGW-w64 bug.
+
+2. On Windows: Obtain the latest version installer from the
+`MinGW-w64 repository <https://mingw-w64.org/doku.php>`_.
+Any thread model (POSIX or Win32) can be chosen, DPDK does not rely on

it.

doc/guides/getting_started_guide/install_and_build/index.rst line 50

Quoted 8 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +8 -0

+Install to a folder without spaces in its name, like ``C:\MinGW``.
+This path is assumed for the rest of this guide.
+
+Install the Build System
+------------------------
+
+Download and install the build system from the
+`Meson website <

http://mesonbuild.com/Getting-meson.html#installing-meson-and-ninja-with-the-msi-installer>`_.

doc/guides/getting_started_guide/install_and_build/index.rst line 51

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+A good option to choose is the MSI installer for both meson and ninja

together.

doc/guides/getting_started_guide/install_and_build/index.rst line 52

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+Recommended version is either Meson 0.57.0 (baseline) or the latest

release.

s/Recommended/Required/ is 0.57.0 i do not believe their latest release works?

doc/guides/getting_started_guide/install_and_build/index.rst line 58

Quoted 6 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +6 -0

+
+Install the Backend
+-------------------
+
+If using Ninja, download and install the backend from the
+`Ninja website <https://ninja-build.org/>`_ or install along with the

meson build

doc/guides/getting_started_guide/install_and_build/index.rst line 59

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+system.

i'm not sure we need to mention the installation of the ninja backend since you acquire it along with meson 0.57.0? anyone call me wrong on this or does windows use any other backend that we are aware? if not i think we can delete the 'install the backend' section entirely.

doc/guides/getting_started_guide/install_and_build/index.rst line 67

Quoted 8 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +8 -0

+
+Once you have verified that your system meets these requirements,
+you can proceed with the following steps to build DPDK.
+
+Build the Code
+--------------
+
+The build environment is setup to build the EAL and the helloworld

example by default.

doc/guides/getting_started_guide/install_and_build/index.rst line 72

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+To compile the examples, the flag -Dexamples is required.
+
+**Option 1. Native Build on Windows**
+
+When using Clang-LLVM, specifying the compiler might be required to

complete the meson

doc/guides/getting_started_guide/install_and_build/index.rst line 77

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+command::
+
+        set CC=clang
+
+When using MinGW-w64, it is sufficient to have toolchain executables in

PATH::

doc/guides/getting_started_guide/install_and_build/index.rst line 84

Quoted 7 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +7 -0

+
+        set PATH=C:\MinGW\mingw64\bin;%PATH%
+
+To compile the examples::
+
+        cd C:\Users\me\dpdk
+        meson -Dexamples=helloworld build

meson setup -Dexamples=helloworld build

doc/guides/getting_started_guide/install_and_build/index.rst line 85

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+        ninja -C build

meson compile -C build

doc/guides/getting_started_guide/install_and_build/index.rst line 92

Quoted 7 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +7 -0

+
+**Option 2. Cross-Compile with MinGW-w64**
+
+The cross-file option must be specified for Meson.
+Depending on the distribution, paths in this file may need adjustments::
+
+        meson --cross-file config/x86/cross-mingw -Dexamples=helloworld

build

Quoted 4 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -1

+        ninja -C build
\ No newline at end of file
--

2.41.0.windows.1

Tyler, can you provide an example of the OS specific section/title you're thinking would make sense to use?

Can you confirm the following?

1. The Clang-LLVM C compiler (version >= 16.0.x)
2. Meson Build system (Required version: 0.57.0)
3. Updated commands:

# Previous Command
meson -Dexamples=helloworld build
# Updated Command
meson setup -Dexamples=helloworld build

# Previous Command
ninja -C build
# Updated Command
meson compile -C build

4. Since Ninja is bundled with Meson 0.57.0, a separate section for its installation may not be necessary. Is this correct?

Thanks!
David Young
Professional Copywriter/Technical Writer
Young Copy
+1 (678) 500-9550
https://www.youngcopy.com

Quoted 386 lines · Tyler Retzlaff

Quoted 7 lines · David Young

---
 .../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(+)
 create mode 100644

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 1 line

 create mode 100644

doc/guides/getting_started_guide/install_and_build/index.rst

Quoted 1 line

 create mode 100644

doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst

Quoted 1 line

 create mode 100644

doc/guides/getting_started_guide/install_and_build/windows_install_build.rst

Quoted 2 lines

diff --git

a/doc/guides/getting_started_guide/install_and_build/building_from_sources.rst b/doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 4 lines

new file mode 100644
index 0000000000..e4ee8e436d
--- /dev/null
+++

b/doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst line 9

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +9 -0

@@ -0,0 +1,108 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _building_from_sources:
+
+Building and Installing DPDK from Sources
+=========================================
+
+This chapter provides a comprehensive guide for building DPDK from

sources on both

Review line 10

Quoted 1 line

(quoted diff) +1 -0

+Linux and FreeBSD platforms. It covers the necessary steps,

prerequisites,

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst line 11

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +1 -0

+and considerations for different architectures and compilers.

when the title of the section is general it shouldn't mention a specific OS in the content. if the content is OS specific then the parent section or the title of the section should identify to which OS it applies. in general it would be nice to convey that windows is an equally supported platform to the other operating systems.

i know it's a bit of a dance i hope you can help interpret what i'm trying to convey.

Quoted 45 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +45 -0

+
+Required Tools
+--------------
+
+To build DPDK, you'll need the following tools:
+
+- A C compiler like ``gcc`` (version 5+) or ``clang`` (version 3.6+)
+- ``pkg-config`` or ``pkgconf``
+- Python 3.6 or later
+- ``meson`` (version 0.53.2+) and ``ninja``
+- ``pyelftools`` (version 0.22+)
+
+Here's how to install them:
+
+Linux
+^^^^^
+
+Alpine
+
+.. code-block:: bash
+
+   sudo apk add alpine-sdk bsd-compat-headers
+   pip install meson ninja
+
+Debian and Ubuntu and derivatives
+
+.. code-block:: bash
+
+   sudo apt install build-essential
+   pip install meson ninja
+
+Fedora and RedHat Enterprise Linux RHEL
+
+.. code-block:: bash
+
+   sudo dnf groupinstall "Development Tools"
+   pip install meson ninja
+
+openSUSE
+
+.. code-block:: bash
+
+   sudo zypper install -t pattern devel_basis python3-pyelftools
+   pip install meson ninja
+

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +10 -0

+FreeBSD
+^^^^^^^
+
+FreeBSD (as root)
+
+.. code-block:: bash
+
+   pkg install meson pkgconf py38-pyelftools
+
+Note: If you're using FreeBSD, you'll also need kernel sources. Make

sure they're included during the FreeBSD installation.

Quoted 18 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +18 -0

+
+Getting the DPDK Source
+-----------------------
+
+Download the DPDK source code from the official repository
+``https://fast.dpdk.org/rel/`` <https://fast.dpdk.org/rel/>.
+
+Use ``wget`` to grab the DPDK version::
+
+        wget https://fast.dpdk.org/rel/dpdk-<version>.tar.xz
+
+Extract the downloaded archive:
+
+.. code-block:: bash
+
+   tar -xvf dpdk-<version>.tar.gz
+
+Navigate to the DPDK directory:

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +10 -0

+
+.. code-block:: bash
+
+   cd dpdk-<version>
+
+Building DPDK
+-------------
+
+Configure the build based on your needs, hardware, and environment.
+This might include setting specific flags or options. For example:

“meson setup -Dbuildtype=debugoptimized build”. Then compile using “ninja” and install using “meson install”.

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 9 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +9 -0

+
+.. code-block:: bash
+
+   ninja -C build
+   cd build
+   sudo ninja install
+   ldconfig
+
+For detailed information on Meson build configuration options specific

to DPDK, see :ref:DPDK Meson Build Configuration Options <dpdk_meson_build_options>.

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/building_from_sources.rst new file +5 -0

+
+Cross-Compilation Instructions for Different Architectures
+----------------------------------------------------------
+
+For instructions on building DPDK for ARM64, LoongArch, and RISC-V,

refer to :ref:cross_compile_dpdk.

Quoted 1 line

diff --git

a/doc/guides/getting_started_guide/install_and_build/index.rst b/doc/guides/getting_started_guide/install_and_build/index.rst

Quoted 21 lines

new file mode 100644
index 0000000000..f4d8740fb6

doc/guides/getting_started_guide/install_and_build/index.rst new file +15 -0

@@ -0,0 +1,15 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _install_and_build:
+
+Install and Build DPDK
+======================
+
+.. toctree::
+    :maxdepth: 2
+
+
+    installing_prebuilt_packages
+    building_from_sources
+    windows_install_build
\ No newline at end of file

Quoted 1 line

diff --git

a/doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst b/doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst

Quoted 4 lines

new file mode 100644
index 0000000000..3e395d65f1
--- /dev/null
+++

b/doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst

doc/guides/getting_started_guide/install_and_build/index.rst line 9

Quoted 10 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +9 -0

@@ -0,0 +1,54 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _installing_prebuilt_packages:
+
+Installing Pre-built Packages
+=============================
+
+Pre-built packages provide a convenient way to install DPDK without the

need to compile

doc/guides/getting_started_guide/install_and_build/index.rst line 10

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+the source code manually. These packages are created and maintained by

the DPDK

doc/guides/getting_started_guide/install_and_build/index.rst line 11

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+community or OS vendors and are available for various operating systems

and

doc/guides/getting_started_guide/install_and_build/index.rst line 20

Quoted 9 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +9 -0

+distributions.
+
+Available Distributions
+-----------------------
+
+Linux
+^^^^^
+
+Pre-built DPDK packages are available for several popular Linux

distributions,

Quoted 35 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +34 -0

+including but not limited to:
+
+Alpine
+
+.. code-block:: bash
+
+   sudo apk add dpdk
+
+Debian and Ubuntu and derivatives
+
+.. code-block:: bash
+
+   sudo apt-get install dpdk
+
+Fedora and RedHat Enterprise Linux RHEL
+
+.. code-block:: bash
+
+   sudo dnf install dpdk
+
+openSUSE
+
+.. code-block:: bash
+
+   sudo zypper install dpdk
+
+FreeBSD
+^^^^^^^
+
+To install DPDK on FreeBSD, use the following command:
+
+.. code-block:: bash
+
+   sudo pkg install dpdk
\ No newline at end of file

Quoted 1 line

diff --git

a/doc/guides/getting_started_guide/install_and_build/windows_install_build.rst b/doc/guides/getting_started_guide/install_and_build/windows_install_build.rst

Quoted 4 lines

new file mode 100644
index 0000000000..ea0e131766
--- /dev/null
+++

b/doc/guides/getting_started_guide/install_and_build/windows_install_build.rst

doc/guides/getting_started_guide/install_and_build/index.rst line 10

Quoted 11 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +10 -0

@@ -0,0 +1,93 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2015 Intel Corporation.
+
+.. _windows_install_build:
+
+Windows DPDK Build
+==================
+
+Before you begin the process of building DPDK on Windows,
+make sure your system meets all the necessary requirements as outlined

below.

doc/guides/getting_started_guide/install_and_build/index.rst line 15

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+
+Windows System Requirements
+---------------------------
+
+Building the DPDK and its applications on Windows requires one of the

following

doc/guides/getting_started_guide/install_and_build/index.rst line 18

Quoted 3 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +3 -0

+environments:
+
+- The Clang-LLVM C compiler and Microsoft MSVC linker.

would it be overly objectionable to state specific LLVM >= 16.0.x as required?

doc/guides/getting_started_guide/install_and_build/index.rst line 21

Quoted 3 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +3 -0

+- The MinGW-w64 toolchain (either native or cross).
+
+The Meson Build system is used to prepare the sources for compilation

with the Ninja backend.

doc/guides/getting_started_guide/install_and_build/index.rst line 26

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+
+Option 1: Clang-LLVM C Compiler and Microsoft MSVC Linker
+---------------------------------------------------------
+
+1. Install the Compiler: Download and install the clang compiler from

the

doc/guides/getting_started_guide/install_and_build/index.rst line 29

Quoted 3 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +3 -0

+`LLVM website <http://releases.llvm.org/>`_.
+
+2. Install the Linker: Download and install the Build Tools for Visual

Studio from the

doc/guides/getting_started_guide/install_and_build/index.rst line 31

Quoted 2 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +2 -0

+`Microsoft website <https://visualstudio.microsoft.com/downloads/>`_.
+When installing build tools, select the “Visual C++ build tools” option

and make sure

doc/guides/getting_started_guide/install_and_build/index.rst line 37

Quoted 6 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +6 -0

+the Windows SDK is selected.
+
+Option 2: MinGW-w64 Toolchain
+-----------------------------
+
+1. On Linux (for cross-compilation): Install MinGW-w64 via a package

manager.

doc/guides/getting_started_guide/install_and_build/index.rst line 42

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+Version 4.0.4 for Ubuntu 16.04 cannot be used due to a MinGW-w64 bug.
+
+2. On Windows: Obtain the latest version installer from the
+`MinGW-w64 repository <https://mingw-w64.org/doku.php>`_.
+Any thread model (POSIX or Win32) can be chosen, DPDK does not rely on

it.

doc/guides/getting_started_guide/install_and_build/index.rst line 50

Quoted 8 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +8 -0

+Install to a folder without spaces in its name, like ``C:\MinGW``.
+This path is assumed for the rest of this guide.
+
+Install the Build System
+------------------------
+
+Download and install the build system from the
+`Meson website <

http://mesonbuild.com/Getting-meson.html#installing-meson-and-ninja-with-the-msi-installer>`_.

doc/guides/getting_started_guide/install_and_build/index.rst line 51

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+A good option to choose is the MSI installer for both meson and ninja

together.

doc/guides/getting_started_guide/install_and_build/index.rst line 52

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+Recommended version is either Meson 0.57.0 (baseline) or the latest

release.

s/Recommended/Required/ is 0.57.0 i do not believe their latest release works?

doc/guides/getting_started_guide/install_and_build/index.rst line 58

Quoted 6 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +6 -0

+
+Install the Backend
+-------------------
+
+If using Ninja, download and install the backend from the
+`Ninja website <https://ninja-build.org/>`_ or install along with the

meson build

doc/guides/getting_started_guide/install_and_build/index.rst line 59

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+system.

i'm not sure we need to mention the installation of the ninja backend since you acquire it along with meson 0.57.0? anyone call me wrong on this or does windows use any other backend that we are aware? if not i think we can delete the 'install the backend' section entirely.

doc/guides/getting_started_guide/install_and_build/index.rst line 67

Quoted 8 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +8 -0

+
+Once you have verified that your system meets these requirements,
+you can proceed with the following steps to build DPDK.
+
+Build the Code
+--------------
+
+The build environment is setup to build the EAL and the helloworld

example by default.

doc/guides/getting_started_guide/install_and_build/index.rst line 72

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+To compile the examples, the flag -Dexamples is required.
+
+**Option 1. Native Build on Windows**
+
+When using Clang-LLVM, specifying the compiler might be required to

complete the meson

doc/guides/getting_started_guide/install_and_build/index.rst line 77

Quoted 5 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +5 -0

+command::
+
+        set CC=clang
+
+When using MinGW-w64, it is sufficient to have toolchain executables in

PATH::

doc/guides/getting_started_guide/install_and_build/index.rst line 84

Quoted 7 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +7 -0

+
+        set PATH=C:\MinGW\mingw64\bin;%PATH%
+
+To compile the examples::
+
+        cd C:\Users\me\dpdk
+        meson -Dexamples=helloworld build

meson setup -Dexamples=helloworld build

doc/guides/getting_started_guide/install_and_build/index.rst line 85

Quoted 1 line

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -0

+        ninja -C build

meson compile -C build

doc/guides/getting_started_guide/install_and_build/index.rst line 92

Quoted 7 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +7 -0

+
+**Option 2. Cross-Compile with MinGW-w64**
+
+The cross-file option must be specified for Meson.
+Depending on the distribution, paths in this file may need adjustments::
+
+        meson --cross-file config/x86/cross-mingw -Dexamples=helloworld

build

Quoted 4 lines

doc/guides/getting_started_guide/install_and_build/index.rst new file +1 -1

+        ninja -C build
\ No newline at end of file
--

2.41.0.windows.1

---
 .../getting_started_guide/system_setup.rst    | 195 ++++++++++++++++++
 1 file changed, 195 insertions(+)
 create mode 100644 doc/guides/getting_started_guide/system_setup.rst

doc/guides/getting_started_guide/system_setup.rst new file +4 -0

new file mode 100644
index 0000000000..fa9d249ec7
@@ -0,0 +1,195 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _memory_setup:

doc/guides/getting_started_guide/system_setup.rst new file +22 -0

+.. contents:: Table of Contents
+   :local:
+
+System Setup for Linux
+----------------------
+
+Memory Setup: Reserving Hugepages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For Linux, DPDK requires hugepages be reserved for its use on the system. To check if hugepages are are on your system, you can run the following command::
+
+        grep HugePages_Total /proc/meminfo
+
+If hugepages are not reserved, you will need to reserve them by following these steps:
+
+1. Determine the number of hugepages you want to allocate. For example, to allocate 1024 hugepages of 2MB each, you can use the following command::
+
+        echo 1024 | sudo tee /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
+
+2. To make the hugepages configuration persistent across reboots, add the following line to your `/etc/sysctl.conf` file, adjusting the number of hugepages as needed::
+
+        vm.nr_hugepages = 1024

Quoted 15 lines · David Young

---
 .../getting_started_guide/system_setup.rst    | 195 ++++++++++++++++++
 1 file changed, 195 insertions(+)
 create mode 100644 doc/guides/getting_started_guide/system_setup.rst

doc/guides/getting_started_guide/system_setup.rst new file +4 -0

new file mode 100644
index 0000000000..fa9d249ec7
@@ -0,0 +1,195 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _memory_setup:

doc/guides/getting_started_guide/system_setup.rst line 14

Quoted 10 lines

doc/guides/getting_started_guide/system_setup.rst new file +10 -0

+
+.. |reg| unicode:: U+000AE
+
+Setting up a System to Run DPDK Applications
+============================================
+
+This section provides step-by-step instructions for setting up your system to run DPDK applications. It covers system configurations for Linux, FreeBSD, and Windows. Each section details the necessary memory and device setups for these operating systems.
+
+Navigate to the section that corresponds to your operating system to begin the setup process.
+

Not sure above sentences adds value.

Quoted 23 lines

doc/guides/getting_started_guide/system_setup.rst new file +22 -0

+.. contents:: Table of Contents
+   :local:
+
+System Setup for Linux
+----------------------
+
+Memory Setup: Reserving Hugepages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For Linux, DPDK requires hugepages be reserved for its use on the system. To check if hugepages are are on your system, you can run the following command::
+
+        grep HugePages_Total /proc/meminfo
+
+If hugepages are not reserved, you will need to reserve them by following these steps:
+
+1. Determine the number of hugepages you want to allocate. For example, to allocate 1024 hugepages of 2MB each, you can use the following command::
+
+        echo 1024 | sudo tee /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
+
+2. To make the hugepages configuration persistent across reboots, add the following line to your `/etc/sysctl.conf` file, adjusting the number of hugepages as needed::
+
+        vm.nr_hugepages = 1024

doc/guides/getting_started_guide/system_setup.rst line 46

Quoted 10 lines

doc/guides/getting_started_guide/system_setup.rst new file +10 -0

+
+3. Most distributions make hugepages available via `/dev/hugepages`, so this step may not be necessary. If you need to manually mount the hugepages filesystem, add the following line to your `/etc/fstab` file::
+
+        nodev /mnt/huge hugetlbfs defaults 0 0
+
+   Then, create the mount directory and mount the filesystem::
+
+        mkdir -p /mnt/huge
+        mount -a
+

We have './usertools/dpdk-hugepages.py' script for this, which I am using regularly.

Script is wrapper to what described above, so I think good to explain basics, but also may worth mentioning from script, it is more user friendly than above instructions.

Quoted 7 lines · Ferruh Yigit

Review

Quoted 6 lines · David Young

---
 .../getting_started_guide/system_setup.rst    | 195 ++++++++++++++++++
 1 file changed, 195 insertions(+)
 create mode 100644 doc/guides/getting_started_guide/system_setup.rst

(quoted diff) +0 -0

b/doc/guides/getting_started_guide/system_setup.rst

Quoted 8 lines

Quoted 8 lines

new file mode 100644
index 0000000000..fa9d249ec7

doc/guides/getting_started_guide/system_setup.rst new file +3 -0

@@ -0,0 +1,195 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+

Quoted 8 lines

doc/guides/getting_started_guide/system_setup.rst

Quoted 8 lines

doc/guides/getting_started_guide/system_setup.rst new file +8 -0

+.. _memory_setup:
+
+.. |reg| unicode:: U+000AE
+
+Setting up a System to Run DPDK Applications
+============================================
+
+This section provides step-by-step instructions for setting up your

system to run DPDK applications. It covers system configurations for Linux, FreeBSD, and Windows. Each section details the necessary memory and device setups for these operating systems.

Quoted 2 lines

doc/guides/getting_started_guide/system_setup.rst line 13

Quoted 2 lines

doc/guides/getting_started_guide/system_setup.rst new file +2 -0

+
+Navigate to the section that corresponds to your operating system to

begin the setup process.

Quoted 6 lines

doc/guides/getting_started_guide/system_setup.rst line 14

Quoted 1 line

doc/guides/getting_started_guide/system_setup.rst new file +1 -0

+

Not sure above sentences adds value.

Quoted 10 lines

doc/guides/getting_started_guide/system_setup.rst

Quoted 10 lines

doc/guides/getting_started_guide/system_setup.rst new file +10 -0

+.. contents:: Table of Contents
+   :local:
+
+System Setup for Linux
+----------------------
+
+Memory Setup: Reserving Hugepages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For Linux, DPDK requires hugepages be reserved for its use on the

system. To check if hugepages are are on your system, you can run the following command::

Quoted 4 lines

doc/guides/getting_started_guide/system_setup.rst

Quoted 4 lines

doc/guides/getting_started_guide/system_setup.rst new file +4 -0

+
+        grep HugePages_Total /proc/meminfo
+
+If hugepages are not reserved, you will need to reserve them by

following these steps:

Quoted 2 lines

doc/guides/getting_started_guide/system_setup.rst line 30

Quoted 2 lines

doc/guides/getting_started_guide/system_setup.rst new file +2 -0

+
+1. Determine the number of hugepages you want to allocate. For

example, to allocate 1024 hugepages of 2MB each, you can use the following command::

Quoted 2 lines

doc/guides/getting_started_guide/system_setup.rst line 32

Quoted 2 lines

doc/guides/getting_started_guide/system_setup.rst new file +2 -0

+
+        echo 1024 | sudo tee

/sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages

Quoted 2 lines

doc/guides/getting_started_guide/system_setup.rst line 34

Quoted 2 lines

doc/guides/getting_started_guide/system_setup.rst new file +2 -0

+
+2. To make the hugepages configuration persistent across reboots, add

the following line to your /etc/sysctl.conf file, adjusting the number of hugepages as needed::

Quoted 4 lines

doc/guides/getting_started_guide/system_setup.rst

Quoted 4 lines

doc/guides/getting_started_guide/system_setup.rst new file +4 -0

+
+        vm.nr_hugepages = 1024
+
+3. Most distributions make hugepages available via `/dev/hugepages`,

so this step may not be necessary. If you need to manually mount the hugepages filesystem, add the following line to your /etc/fstab file::

Quoted 14 lines

doc/guides/getting_started_guide/system_setup.rst line 46

Quoted 9 lines

doc/guides/getting_started_guide/system_setup.rst new file +8 -0

+
+        nodev /mnt/huge hugetlbfs defaults 0 0
+
+   Then, create the mount directory and mount the filesystem::
+
+        mkdir -p /mnt/huge
+        mount -a
+

We have './usertools/dpdk-hugepages.py' script for this, which I am using regularly.

Quoted 4 lines

Script is wrapper to what described above, so I think good to explain basics, but also may worth mentioning from script, it is more user friendly than above instructions.

Actually, if script can do all the basics - something I believe Stephen and Thomas also pointed out on a slack review earlier - then we should just drop the manual steps from here. If we think the script is sufficiently robust, we can drop them from the doc entirely, or if not, move them to an appendix which we reference here.

/Bruce

---
 .../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_apps/run_apps.rst

doc/guides/getting_started_guide/run_apps/index.rst new file +10 -0

new file mode 100644
index 0000000000..f033cac5f0
@@ -0,0 +1,10 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+Running Applications
+====================
+
+.. toctree::
+    :maxdepth: 2
+
+    run_apps
\ No newline at end of file

doc/guides/getting_started_guide/run_apps/run_apps.rst new file +12 -0

new file mode 100644
index 0000000000..339d4c0a68
@@ -0,0 +1,118 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _run_apps:
+
+Running Applications
+====================
+
+The following instructions apply to Linux, FreeBSD, and Windows.
+
+.. contents:: Table of Contents
+   :local:

---
 .../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 ++++++++++++++++++
 5 files changed, 442 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/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

doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst new file +37 -0

new file mode 100644
index 0000000000..3e4efe23a4
@@ -0,0 +1,37 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _cross_compile_dpdk:
+
+Cross-compiling DPDK for Different Architectures on Linux
+=========================================================
+
+Cross-compiling DPDK for different architectures follows a similar process. Here are the general steps:
+
+1. **Get Compiler and Libraries**: Obtain the cross-compiler toolchain and any required libraries specific to the target architecture.
+
+2. **Build Using Cross-File**: Use Meson to set up the build with a cross-file specific to the target architecture, and then build with Ninja.
+
+Prerequisites
+-------------
+
+- NUMA Library (if required)
+- Meson and Ninja
+- pkg-config for the target architecture
+- Specific GNU or LLVM/Clang toolchain for the target architecture
+
+Cross-Compiling DPDK
+--------------------
+
+1. **Set Up the Cross Toolchain**: Download and extract the toolchain for the target architecture. Add it to the PATH.
+
+2. **Compile Any Required Libraries**: Compile libraries like NUMA if required.
+
+3. **Cross-Compile DPDK with Meson**:
+
+   .. code-block:: bash
+
+      meson setup cross-build --cross-file <target_machine_configuration>
+      ninja -C cross-build
+
+Refer to the specific sections for ARM64, LoongArch, and RISC-V for detailed instructions and architecture-specific considerations.
\ No newline at end of file

doc/guides/getting_started_guide/appendix/dpdk_meson_build_options.rst new file +57 -0

new file mode 100644
index 0000000000..6669f98371
@@ -0,0 +1,57 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _dpdk_meson_build_options:
+
+DPDK Meson Build Configuration Options
+======================================
+
+DPDK provides a number of build configuration options that can be adjusted using the Meson build system. These options can be listed by running ``meson configure`` inside a configured build
+folder.
+
+Changing the Build Type
+-----------------------
+
+To change the build type from the default "release" to a regular "debug" build,
+you can either:
+
+- Pass ``-Dbuildtype=debug`` or ``--buildtype=debug`` to meson when configuring the build folder initially.
+- Run ``meson configure -Dbuildtype=debug`` inside the build folder after the initial meson run.
+
+Platform Options
+----------------
+
+The "platform" option specifies a set of configuration parameters that will be used. 
+The valid values are:
+
+- ``-Dplatform=native`` will tailor the configuration to the build machine.
+- ``-Dplatform=generic`` will use configuration that works on all machines of the same architecture as the build machine.
+- ``-Dplatform=<SoC>`` will use configuration optimized for a particular SoC.
+
+Consult the "socs" dictionary in ``config/arm/meson.build`` to see which SoCs are supported.
+
+Overriding Platform Parameters
+------------------------------
+
+The values determined by the platform parameter may be overwritten. For example,
+to set the ``max_lcores`` value to 256, you can either:
+
+- Pass ``-Dmax_lcores=256`` to meson when configuring the build folder initially.
+- Run ``meson configure -Dmax_lcores=256`` inside the build folder after the initial meson run.
+
+Building Sample Applications
+----------------------------
+
+Some of the DPDK sample applications in the examples directory can be automatically built as
+part of a meson build. To do so, pass a comma-separated list of the examples to build to the
+``-Dexamples`` meson option as below::
+
+    meson setup -Dexamples=l2fwd,l3fwd build
+
+There is also a special value "all" to request that all example applications whose dependencies
+are met on the current system are built. When ``-Dexamples=all`` is set as a meson option,
+meson will check each example application to see if it can be built, and add all which can be
+built to the list of tasks in the ninja build configuration file.
+
+For a complete list of options, run ``meson configure`` inside your configured build
+folder.
\ No newline at end of file

doc/guides/getting_started_guide/appendix/index.rst new file +17 -0

new file mode 100644
index 0000000000..23bb1fcf78
@@ -0,0 +1,17 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _appendix:
+
+Appendix
+========
+
+This section covers specific guides related to DPDK.
+
+.. toctree::
+    :maxdepth: 2
+
+    dpdk_meson_build_options
+    running_dpdk_apps_without_root
+    vfio_advanced
+    cross_compile_dpdk
\ No newline at end of file

doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst new file +18 -0

new file mode 100644
index 0000000000..9f214bbdc8
@@ -0,0 +1,36 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _running_dpdk_apps_without_root:
+
+Running DPDK Applications Without Root Privileges
+=================================================
+
+Although applications using the DPDK use network ports and other hardware resources
+directly, with a number of small permission adjustments, 
+it is possible to run these applications as a user other than “root”. 
+To do so, the ownership, or permissions, on the following file system objects should be
+adjusted so the user account being used to run the DPDK application has
+access to them:
+
+Linux
+-----
+

\ No newline at end of file

doc/guides/getting_started_guide/appendix/vfio_advanced.rst new file +9 -0

new file mode 100644
index 0000000000..1cdb138eb7
@@ -0,0 +1,295 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _vfio_advanced:
+
+.. |reg| unicode:: U+000AE
+
+VFIO Advanced
+=============

Quoted 4 lines · David Young

---
 .../appendix/cross_compile_dpdk.rst           |  37 +++
 .../appendix/dpdk_meson_build_options.rst     |  57 ++++
 .../getting_started_guide/appendix/index.rst  |  17 +

Quoted 9 lines

 .../running_dpdk_apps_without_root.rst        |  36 +++
 .../appendix/vfio_advanced.rst                | 295 ++++++++++++++++++
 5 files changed, 442 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/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

These files are put under 'appendix' folder,
and I can see these documents are linked from other 'getting started guide' documentations, which I assume the reason to put these under 'appendix' folder.
But these are not limited to getting started, perhaps we can do a better organization of them out of getting started appendix.

Quoted 35 lines

doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst new file +29 -0

new file mode 100644
index 0000000000..3e4efe23a4
@@ -0,0 +1,37 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _cross_compile_dpdk:
+
+Cross-compiling DPDK for Different Architectures on Linux
+=========================================================
+
+Cross-compiling DPDK for different architectures follows a similar process. Here are the general steps:
+
+1. **Get Compiler and Libraries**: Obtain the cross-compiler toolchain and any required libraries specific to the target architecture.
+
+2. **Build Using Cross-File**: Use Meson to set up the build with a cross-file specific to the target architecture, and then build with Ninja.
+
+Prerequisites
+-------------
+
+- NUMA Library (if required)
+- Meson and Ninja
+- pkg-config for the target architecture
+- Specific GNU or LLVM/Clang toolchain for the target architecture
+
+Cross-Compiling DPDK
+--------------------
+
+1. **Set Up the Cross Toolchain**: Download and extract the toolchain for the target architecture. Add it to the PATH.
+
+2. **Compile Any Required Libraries**: Compile libraries like NUMA if required.
+

doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst line 37

Quoted 8 lines

doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst new file +8 -0

+3. **Cross-Compile DPDK with Meson**:
+
+   .. code-block:: bash
+
+      meson setup cross-build --cross-file <target_machine_configuration>
+      ninja -C cross-build
+
+Refer to the specific sections for ARM64, LoongArch, and RISC-V for detailed instructions and architecture-specific considerations.

Quoted 114 lines

\ No newline at end of file

doc/guides/getting_started_guide/appendix/dpdk_meson_build_options.rst new file +57 -0

new file mode 100644
index 0000000000..6669f98371
@@ -0,0 +1,57 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _dpdk_meson_build_options:
+
+DPDK Meson Build Configuration Options
+======================================
+
+DPDK provides a number of build configuration options that can be adjusted using the Meson build system. These options can be listed by running ``meson configure`` inside a configured build
+folder.
+
+Changing the Build Type
+-----------------------
+
+To change the build type from the default "release" to a regular "debug" build,
+you can either:
+
+- Pass ``-Dbuildtype=debug`` or ``--buildtype=debug`` to meson when configuring the build folder initially.
+- Run ``meson configure -Dbuildtype=debug`` inside the build folder after the initial meson run.
+
+Platform Options
+----------------
+
+The "platform" option specifies a set of configuration parameters that will be used. 
+The valid values are:
+
+- ``-Dplatform=native`` will tailor the configuration to the build machine.
+- ``-Dplatform=generic`` will use configuration that works on all machines of the same architecture as the build machine.
+- ``-Dplatform=<SoC>`` will use configuration optimized for a particular SoC.
+
+Consult the "socs" dictionary in ``config/arm/meson.build`` to see which SoCs are supported.
+
+Overriding Platform Parameters
+------------------------------
+
+The values determined by the platform parameter may be overwritten. For example,
+to set the ``max_lcores`` value to 256, you can either:
+
+- Pass ``-Dmax_lcores=256`` to meson when configuring the build folder initially.
+- Run ``meson configure -Dmax_lcores=256`` inside the build folder after the initial meson run.
+
+Building Sample Applications
+----------------------------
+
+Some of the DPDK sample applications in the examples directory can be automatically built as
+part of a meson build. To do so, pass a comma-separated list of the examples to build to the
+``-Dexamples`` meson option as below::
+
+    meson setup -Dexamples=l2fwd,l3fwd build
+
+There is also a special value "all" to request that all example applications whose dependencies
+are met on the current system are built. When ``-Dexamples=all`` is set as a meson option,
+meson will check each example application to see if it can be built, and add all which can be
+built to the list of tasks in the ninja build configuration file.
+
+For a complete list of options, run ``meson configure`` inside your configured build
+folder.
\ No newline at end of file

doc/guides/getting_started_guide/appendix/index.rst new file +17 -0

new file mode 100644
index 0000000000..23bb1fcf78
@@ -0,0 +1,17 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _appendix:
+
+Appendix
+========
+
+This section covers specific guides related to DPDK.
+
+.. toctree::
+    :maxdepth: 2
+
+    dpdk_meson_build_options
+    running_dpdk_apps_without_root
+    vfio_advanced
+    cross_compile_dpdk
\ No newline at end of file

doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst new file +18 -0

new file mode 100644
index 0000000000..9f214bbdc8
@@ -0,0 +1,36 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _running_dpdk_apps_without_root:
+
+Running DPDK Applications Without Root Privileges
+=================================================
+
+Although applications using the DPDK use network ports and other hardware resources
+directly, with a number of small permission adjustments, 
+it is possible to run these applications as a user other than “root”. 
+To do so, the ownership, or permissions, on the following file system objects should be
+adjusted so the user account being used to run the DPDK application has
+access to them:
+
+Linux
+-----
+

doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst line 28

Quoted 10 lines

doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst new file +10 -0

+1. **Create a DPDK User Group**: Create a new user group for DPDK and add the desired user to this group.
+
+2. **Set Up Hugepages**: Configure hugepages for the user.
+
+3. **Bind the NIC to a User-Space Driver**: Use the DPDK tool ``dpdk-devbind.py`` to bind the NIC to a user-space driver like ``vfio-pci`` or ``igb_uio``.
+
+4. **Set Permissions for UIO/VFIO Devices**: Change the ownership and permissions of the UIO or VFIO devices to allow access by the DPDK user group.
+
+5. **Run the DPDK Application**: Run the desired DPDK application as the user who has been added to the DPDK group.
+

I think we need a sample commands, additional to description, on how to run an application as a non-priviledged user.

doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst line 36

Quoted 9 lines

doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst new file +8 -0

+FreeBSD
+-------
+
+- The userspace-io device files in ``/dev``, for example, ``/dev/uio0``, ``/dev/uio1``, and so on
+- The userspace contiguous memory device: ``/dev/contigmem``
+
+
+Refer to the `DPDK Release Notes <https://doc.dpdk.org/guides/rel_notes/index.html>`_ for supported applications.

Applications that run without root privileges? Do we have that kind of list in release notes?

Quoted 16 lines

\ No newline at end of file

doc/guides/getting_started_guide/appendix/vfio_advanced.rst new file +9 -0

new file mode 100644
index 0000000000..1cdb138eb7
@@ -0,0 +1,295 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+.. _vfio_advanced:
+
+.. |reg| unicode:: U+000AE
+
+VFIO Advanced
+=============

doc/guides/getting_started_guide/appendix/vfio_advanced.rst line 19

Quoted 10 lines

doc/guides/getting_started_guide/appendix/vfio_advanced.rst new file +10 -0

+
+
+.. contents:: Table of Contents
+   :local:
+
+.. _vfio_no_iommu_mode:
+
+VFIO no-IOMMU mode
+------------------
+

I guess this is the only documentation specific to "VFIO", (and title is VFIO advanced), I think it can be better to start with describing VFIO, instead of starting with no-iommu mode.

Quoted 4 lines · David Young

---
 .../appendix/cross_compile_dpdk.rst           |  37 +++
 .../appendix/dpdk_meson_build_options.rst     |  57 ++++
 .../getting_started_guide/appendix/index.rst  |  17 +

Quoted 9 lines

 .../running_dpdk_apps_without_root.rst        |  36 +++
 .../appendix/vfio_advanced.rst                | 295 ++++++++++++++++++
 5 files changed, 442 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/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

These files are put under 'appendix' folder,
and I can see these documents are linked from other 'getting started guide' documentations, which I assume the reason to put these under 'appendix' folder.
But these are not limited to getting started, perhaps we can do a better organization of them out of getting started appendix.

---
 doc/guides/getting_started_guide/glossary.rst | 75 +++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 doc/guides/getting_started_guide/glossary.rst

doc/guides/getting_started_guide/glossary.rst new file +2 -0

new file mode 100644
index 0000000000..7fcfe16f38
@@ -0,0 +1,75 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.

doc/guides/getting_started_guide/glossary.rst new file +22 -0

+**Bifurcated Driver**
+
+A driver model that splits functionality between kernel and userspace, often used in high-performance networking.
+
+**Clang-LLVM**
+
+A compiler toolchain that includes the Clang C compiler and LLVM linker, used for building DPDK on Windows.
+
+**contigmem Module**
+
+A module in FreeBSD that provides physically contiguous memory allocation used by DPDK.
+
+**DMA (Direct Memory Access)**
+
+A feature that allows hardware devices to access the main system memory directly, without involving the CPU.
+
+**EAL (Environment Abstraction Layer)**
+
+The layer within DPDK that abstracts environmental specifics and provides a standard programming interface.
+
+**hugepages**
+

doc/guides/getting_started_guide/glossary.rst new file +6 -0

+**NIC (Network Interface Card)**
+
+A hardware component that connects a computer to a network.
+
+**nic_uio Module**
+

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.

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 System to Run DPDK Applications Section 4: Running Applications
Section 5: Appendix
Section 6: Glossary

Hello David,

Quoted 5 lines · David Young

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.

Quoted 7 lines

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

From my understanding, existing copyright banners should be preserved by this reorganisation work.
Yet I noticed a few Copyright banners dated 2025, please double check and fix them.

Bruce, Thomas,
An open question, if new docs are created, who should this work be attributed to? the dpdk contributors?

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 System to Run DPDK Applications Section 4: Running Applications
Section 5: Appendix
Section 6: Glossary

Quoted 1 line · David Young

The separate Getting Started Guides for Linux, FreeBSD, and Windows have

been

Quoted 1 line

consolidated into a single, streamlined guide to simplify the user

experience

Quoted 10 lines

and facilitate easier maintenance.

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

Hi David,

New documentations are not in the toctree, so they are not accessible by the links in the left column.
Sphinx generates warning for this:
WARNING: document isn't included in any toctree

Also existing per platform documentation is not removed yet.

I assume both above done intentionally for the development phase of this documentation, but this is just a reminder in-case not.

And not all context seems moved from existing per platform getting started guides, is there are plan to keep them around for a while as reference, or move that context to other files?

Thanks,
ferruh

Quoted 8 lines · David Young

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 System to Run DPDK Applications Section 4:
Running Applications Section 5: Appendix Section 6: Glossary

Hi David,

New documentations are not in the toctree, so they are not accessible by the links in the left column. Sphinx generates warning for this:
WARNING: document isn't included in any toctree

Also existing per platform documentation is not removed yet.

I assume both above done intentionally for the development phase of this documentation, but this is just a reminder in-case not.

And not all context seems moved from existing per platform getting started guides, is there are plan to keep them around for a while as reference, or move that context to other files?