Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/134543/?format=api
{ "id": 134543, "url": "http://patchwork.dpdk.org/api/patches/134543/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20231123012633.2005-3-dave@youngcopy.com/", "project": { "id": 1, "url": "http://patchwork.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20231123012633.2005-3-dave@youngcopy.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20231123012633.2005-3-dave@youngcopy.com", "date": "2023-11-23T01:26:23", "name": "[v4,2/6] Section 2: Install and Build DPDK", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "ddfec57c5920598845b41e0d9f6b56ae8c45d08a", "submitter": { "id": 3122, "url": "http://patchwork.dpdk.org/api/people/3122/?format=api", "name": "Dave Young", "email": "dave@youngcopy.com" }, "delegate": { "id": 1, "url": "http://patchwork.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20231123012633.2005-3-dave@youngcopy.com/mbox/", "series": [ { "id": 30365, "url": "http://patchwork.dpdk.org/api/series/30365/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=30365", "date": "2023-11-23T01:26:21", "name": "docs: getting started guide consolidation", "version": 4, "mbox": "http://patchwork.dpdk.org/series/30365/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/134543/comments/", "check": "warning", "checks": "http://patchwork.dpdk.org/api/patches/134543/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 9A7984339F;\n\tThu, 23 Nov 2023 02:27:07 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id A4A7542D78;\n\tThu, 23 Nov 2023 02:27:01 +0100 (CET)", "from mail-yw1-f180.google.com (mail-yw1-f180.google.com\n [209.85.128.180])\n by mails.dpdk.org (Postfix) with ESMTP id 8A8AD42D55\n for <dev@dpdk.org>; Thu, 23 Nov 2023 02:26:57 +0100 (CET)", "by mail-yw1-f180.google.com with SMTP id\n 00721157ae682-5bbfc735572so758887b3.0\n for <dev@dpdk.org>; Wed, 22 Nov 2023 17:26:57 -0800 (PST)", "from localhost.localdomain\n ([2600:1700:20c0:a560:40f7:d2c:d53a:d071])\n by smtp.gmail.com with ESMTPSA id\n j184-20020a0dc7c1000000b005a815346d95sm89832ywd.71.2023.11.22.17.26.55\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Wed, 22 Nov 2023 17:26:55 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=youngcopy-com.20230601.gappssmtp.com; s=20230601; t=1700702816;\n x=1701307616;\n darn=dpdk.org;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:from:to:cc:subject:date\n :message-id:reply-to;\n bh=C1UUsNdXPdQgjdfOSf0ecgxqsoOeMVfdZrRmWPA7nkw=;\n b=PH1EGJzmBgKk69aczNvjNgB9L80kD5vwqDRCzQBGWbDcWgSmpPR2w2zF3kATxcvajh\n gR89GtfjiglXWgwREBVWpa6d+yVkBbYTGAE1yCXzlTp3ncN9Nff6WHIUr+UZ7VZ5HRoK\n PyUzTPitHxVTuWApNY4w+NXKKuC4wlcqEmarNdUyxh9umuX+ex6MuOUrgLQf3VH1B2NC\n tl4tF60Jk4p2T5YiS/LEMxQ2/mo1Zt2mYCY5z+zqW4q4pecQ5/2hT0Wb3nBEYh5F7nhC\n cvJHSVi/ba3K648/DJpIW3Gdr6/djL1TdpYCHKUXgXHyaBHzBRNrR1TOMyRDUeazUqi2\n 6uPw==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1700702816; x=1701307616;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n :subject:date:message-id:reply-to;\n bh=C1UUsNdXPdQgjdfOSf0ecgxqsoOeMVfdZrRmWPA7nkw=;\n b=cGntWECgU7KUvzEIxM/0TtIx09sEGG13hL+foNuZZNe2CfGqxGUJvR3sbeeo++IOOh\n BJsJtAxo5XJVvIsskHsjzjC4NZqiltcRh8K3i+XqXAfQ1h05s4ZjNxwf7Pn0MHvajrez\n pixilMiJOUQFlwVXTawGnawCyD4Cs81THJNJv7s7GvtUGebRkcRjD48fHUO8SDXQ1gI+\n UseZOKP2q17U88etdIv0RyFV4Ydnjx5uIkO25G8/vVjvHgZCcX09gMEsRxaw6QgNe+rP\n zaYXvmtreQPuuX/r83+KBC893IU4S5BcQBgFZ5AgdahiMPGvCa/5WrmF0w/frTIiMOj7\n /fAw==", "X-Gm-Message-State": "AOJu0YwutXRJ3IGgA1UPPVK66K9yTicbXykZ6K1/TLvXQ0/UsoKDt4r5\n LzQtW3i/ZjbGO5ML4I2AbT4BrJ83lAhynTbhM50=", "X-Google-Smtp-Source": "\n AGHT+IHut0VVWriLBZnfWEJ0HkDluNfqasmJvU8BfKQj54axnPXuwtSjxP2WHyfliMXYp94YFdsa0w==", "X-Received": "by 2002:a05:690c:2c06:b0:5cc:382c:bc78 with SMTP id\n eo6-20020a05690c2c0600b005cc382cbc78mr2789712ywb.2.1700702815954;\n Wed, 22 Nov 2023 17:26:55 -0800 (PST)", "From": "David Young <dave@youngcopy.com>", "To": "dev@dpdk.org", "Cc": "Bruce Richardson <bruce.richardson@intel.com>,\n Aaron Conole <aconole@redhat.com>, David Young <dave@youngcopy.com>", "Subject": "[PATCH v4 2/6] Section 2: Install and Build DPDK", "Date": "Wed, 22 Nov 2023 20:26:23 -0500", "Message-ID": "<20231123012633.2005-3-dave@youngcopy.com>", "X-Mailer": "git-send-email 2.41.0.windows.1", "In-Reply-To": "<20231123012633.2005-1-dave@youngcopy.com>", "References": "<20231103040202.2849-1-dave@youngcopy.com>\n <20231123012633.2005-1-dave@youngcopy.com>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "-Common Tools for All Distributions: The common tools installation instructions for\nall Linux distributions and FreeBSD have been removed. Instead,\nthe tools are now listed under each specific distribution.\n-Linux Distributions: The Linux distributions have been restructured to include\nAlpine, Debian, Ubuntu, Fedora, RedHat Enterprise Linux (RHEL), and openSUSE.\nEach distribution now has its own section with specific installation commands.\n-Windows: The Windows section remains largely unchanged, but the instructions for\nnavigating to the directory where the DPDK source code is located have been updated.\n-Building DPDK: The commands for setting up and compiling with the Meson build system\nhave been updated for both Linux, FreeBSD, and Windows.\n-Cross-Compilation Instructions: The cross-compilation instructions for\ndifferent architectures were left unchanged.\n-Formatting Changes: There are several formatting changes throughout the document,\nincluding the addition of notes and changes to the headers for better readability and organization.\n---\n .../building_from_sources.rst | 180 ++++++++++++++++++\n .../install_and_build/index.rst | 14 ++\n .../installing_prebuilt_packages.rst | 54 ++++++\n 3 files changed, 248 insertions(+)\n create mode 100644 doc/guides/getting_started_guide/install_and_build/building_from_sources.rst\n create mode 100644 doc/guides/getting_started_guide/install_and_build/index.rst\n create mode 100644 doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst", "diff": "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\nnew file mode 100644\nindex 0000000000..ab54521ac5\n--- /dev/null\n+++ b/doc/guides/getting_started_guide/install_and_build/building_from_sources.rst\n@@ -0,0 +1,180 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2010-2025 Intel Corporation.\n+\n+.. _building_from_sources:\n+\n+Building and Installing DPDK from Sources\n+=========================================\n+\n+This chapter provides a comprehensive guide for building DPDK from sources.\n+It covers the necessary steps, prerequisites, and considerations for different architectures and compilers.\n+\n+Required Tools\n+--------------\n+\n+To build DPDK, you'll need the following tools:\n+\n+- A C compiler like ``gcc`` (version 5+) or ``clang`` (version 3.6+)\n+- ``pkg-config`` or ``pkgconf``\n+- Python 3.6 or later\n+- ``meson`` (version 0.57.0) and ``ninja``\n+- ``pyelftools`` (version 0.22+)\n+\n+Platform-Specific Tool Installation\n+-----------------------------------\n+\n+Linux\n+^^^^^\n+\n+Alpine\n+\"\"\"\"\"\"\n+\n+.. code-block:: bash\n+\n+ sudo apk add alpine-sdk bsd-compat-headers gcc pkg-config python3 meson ninja pyelftools numactl-dev\n+\n+Debian, Ubuntu, and derivatives\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+.. code-block:: bash\n+\n+ sudo apt install build-essential gcc pkg-config python3 meson ninja pyelftools libnuma-dev\n+\n+Fedora and RedHat Enterprise Linux (RHEL)\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+.. code-block:: bash\n+\n+ sudo dnf groupinstall \"Development Tools\"\n+ sudo dnf install gcc pkg-config python3 meson ninja python3-pyelftools numactl-devel\n+\n+openSUSE\n+\"\"\"\"\"\"\"\"\n+\n+.. code-block:: bash\n+\n+ sudo zypper install -t pattern devel_basis\n+ sudo zypper install gcc pkg-config python3 meson ninja python3-pyelftools libnuma-devel\n+\n+FreeBSD\n+^^^^^^^\n+\n+.. code-block:: bash\n+\n+ pkg install pkgconf python3 meson ninja pyelftools\n+\n+.. note::\n+\n+ If you're using FreeBSD, make sure kernel sources are included during the FreeBSD installation.\n+\n+Windows System Requirements\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+Building the DPDK and its applications on Windows requires one of the following\n+environments:\n+\n+- The Clang-LLVM C compiler and Microsoft MSVC linker.\n+- The MinGW-w64 toolchain (either native or cross).\n+\n+The Meson Build system is used to prepare the sources for compilation with the Ninja backend.\n+\n+.. _clang_llvm:\n+\n+Option 1: Clang-LLVM C Compiler and Microsoft MSVC Linker\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+1. Install the Compiler: Download and install the Clang compiler from the \n+ `LLVM website <http://releases.llvm.org/>`_.\n+\n+2. Install the Linker: Download and install the Build Tools for Visual Studio from the\n+ `Microsoft website <https://visualstudio.microsoft.com/downloads/>`_.\n+ When installing build tools, select the “Visual C++ build tools” option and make sure\n+ the Windows SDK is selected.\n+\n+.. _mingw_w64_toolchain:\n+\n+Option 2: MinGW-w64 Toolchain\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+1. On Linux (for cross-compilation): Install MinGW-w64 via a package manager. \n+ Version 4.0.4 for Ubuntu 16.04 cannot be used due to a MinGW-w64 bug.\n+\n+2. On Windows: Obtain the latest version installer from the\n+ `MinGW-w64 repository <https://mingw-w64.org/doku.php>`_. \n+ Any thread model (POSIX or Win32) can be chosen, DPDK does not rely on it. \n+ Install to a folder without spaces in its name, like ``C:\\MinGW``. \n+ This path is assumed for the rest of this guide.\n+\n+Install the Build System\n+^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+Download and install the build system from the\n+`Meson website <http://mesonbuild.com/Getting-meson.html#installing-meson-and-ninja-with-the-msi-installer>`_.\n+A good option to choose is the MSI installer for both meson and ninja together.\n+Required version is Meson 0.57.x (baseline).\n+\n+Getting the DPDK Source\n+-----------------------\n+\n+Linux and FreeBSD\n+^^^^^^^^^^^^^^^^^\n+\n+.. code-block:: bash\n+\n+ wget https://fast.dpdk.org/rel/dpdk-20.11.tar.xz\n+ tar -xJf dpdk-20.11.tar.xz\n+ cd dpdk-20.11\n+\n+Windows\n+^^^^^^^\n+\n+Download the DPDK source code from `DPDK's official website <https://www.dpdk.org/>`_ or clone the repository using a Git client. Extract the downloaded archive, if applicable, and navigate to the DPDK directory.\n+\n+Navigate to the directory where the DPDK source code is located:\n+\n+.. code-block:: bash\n+\n+ cd C:\\path\\to\\dpdk-20.11\n+\n+Building DPDK\n+-------------\n+\n+.. note::\n+\n+ In all examples below, \"build\" is used as the name of the build directory. It is not part of the command itself.\n+\n+Linux and FreeBSD\n+^^^^^^^^^^^^^^^^^\n+\n+.. code-block:: bash\n+\n+ meson setup build\n+ meson compile -C build\n+\n+Windows\n+^^^^^^^\n+\n+**Option 1: Using Clang-LLVM**\n+\n+.. code-block:: bash\n+\n+ set CC=clang\n+ meson setup -Dexamples=helloworld build\n+ meson compile -C build\n+\n+**Option 2: Using MinGW-w64**\n+\n+.. code-block:: bash\n+\n+ set PATH=C:\\MinGW\\mingw64\\bin;%PATH%\n+ meson setup -Dexamples=helloworld build\n+ meson compile -C build\n+\n+.. note::\n+\n+ For detailed information on Meson build configuration options specific to DPDK, see :ref:`DPDK Meson Build Configuration Options <dpdk_meson_build_options>`.\n+\n+Cross-Compilation Instructions for Different Architectures\n+----------------------------------------------------------\n+\n+For instructions on building DPDK for ARM64, LoongArch, and RISC-V, refer to :ref:`cross_compile_dpdk`.\ndiff --git a/doc/guides/getting_started_guide/install_and_build/index.rst b/doc/guides/getting_started_guide/install_and_build/index.rst\nnew file mode 100644\nindex 0000000000..48e438282f\n--- /dev/null\n+++ b/doc/guides/getting_started_guide/install_and_build/index.rst\n@@ -0,0 +1,14 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2010-2025 Intel Corporation.\n+\n+.. _install_and_build:\n+\n+Install and Build DPDK\n+======================\n+\n+.. toctree::\n+ :maxdepth: 2\n+\n+ \n+ installing_prebuilt_packages\n+ building_from_sources\n\\ No newline at end of file\ndiff --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\nnew file mode 100644\nindex 0000000000..3e395d65f1\n--- /dev/null\n+++ b/doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst\n@@ -0,0 +1,54 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2010-2025 Intel Corporation.\n+\n+.. _installing_prebuilt_packages:\n+\n+Installing Pre-built Packages\n+=============================\n+\n+Pre-built packages provide a convenient way to install DPDK without the need to compile\n+the source code manually. These packages are created and maintained by the DPDK\n+community or OS vendors and are available for various operating systems and\n+distributions.\n+\n+Available Distributions\n+-----------------------\n+\n+Linux\n+^^^^^\n+\n+Pre-built DPDK packages are available for several popular Linux distributions,\n+including but not limited to:\n+\n+Alpine\n+\n+.. code-block:: bash\n+\n+ sudo apk add dpdk\n+\n+Debian and Ubuntu and derivatives\n+\n+.. code-block:: bash\n+\n+ sudo apt-get install dpdk\n+\n+Fedora and RedHat Enterprise Linux RHEL\n+\n+.. code-block:: bash\n+\n+ sudo dnf install dpdk\n+\n+openSUSE\n+\n+.. code-block:: bash\n+\n+ sudo zypper install dpdk\n+\n+FreeBSD\n+^^^^^^^\n+\n+To install DPDK on FreeBSD, use the following command:\n+\n+.. code-block:: bash\n+\n+ sudo pkg install dpdk\n\\ No newline at end of file\n", "prefixes": [ "v4", "2/6" ] }