Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/134542/?format=api
{ "id": 134542, "url": "http://patchwork.dpdk.org/api/patches/134542/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20231123012633.2005-2-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-2-dave@youngcopy.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20231123012633.2005-2-dave@youngcopy.com", "date": "2023-11-23T01:26:22", "name": "[v4,1/6] Section 1: Introduction", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "2469b4fea361f17ad0fc16f50b17816a168e603b", "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-2-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/134542/comments/", "check": "warning", "checks": "http://patchwork.dpdk.org/api/patches/134542/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 E4DD34339F;\n\tThu, 23 Nov 2023 02:27:00 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id A2F9B42D55;\n\tThu, 23 Nov 2023 02:27:00 +0100 (CET)", "from mail-oi1-f173.google.com (mail-oi1-f173.google.com\n [209.85.167.173])\n by mails.dpdk.org (Postfix) with ESMTP id 0162342D55\n for <dev@dpdk.org>; Thu, 23 Nov 2023 02:26:56 +0100 (CET)", "by mail-oi1-f173.google.com with SMTP id\n 5614622812f47-3b83d69c7c9so66097b6e.0\n for <dev@dpdk.org>; Wed, 22 Nov 2023 17:26:56 -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.53\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Wed, 22 Nov 2023 17:26:53 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=youngcopy-com.20230601.gappssmtp.com; s=20230601; t=1700702815;\n x=1701307615;\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=6U37Fuwa62g4bJCEmPfVtDjzlWmL3D7/b4zYt/7bxQQ=;\n b=tjjzjv0/unnUSgQumbpgn9lB5vpU0nkwf9P8KF+wJRNhDCVc3FoPYFQl+3PlQl5VBi\n p76DZnYfA83P9xSDZJooWUL7DGegeAVia0X4LVWNC33KUUwPkCrs82n+/XYHoqXhnEZ4\n 4J/+RNBgvJRrN+pobn69K1dTHiF2c3wMJqGRxLmE6lkGRpw6wFN9HHo9VA0Jwcshfu8L\n f7JIoqeAMWEKaSQ6UdNiHjfFSZwx/pRgc2e2DRqqoi+QWlWWiwvOsbp0JW05YnRoGg7i\n EdnS+aUzvQc32U/6VbsNL+G8pxAvg54LjZ75vMzCphwowOqD4JdDMxQMANEcNdMZwvLa\n FSog==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1700702815; x=1701307615;\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=6U37Fuwa62g4bJCEmPfVtDjzlWmL3D7/b4zYt/7bxQQ=;\n b=l9N1XnCF4t5zm9ufAPNlpW+5QxkAoZ8UMm+enOu9ZHu6QgybJdCmUn4e8DfnaVsY5Z\n Phm8Srj6WvRPhoRIjqvp2hvY3Dy2Kp6Fep34squ95oOwUpI807CTUur0tFdfpuFi1cEm\n hY5xsfCVM3mvvZMUC851bi/ygy6UusqtW8o1heKxl7gB+Iww8JosD6+5bQ2pRx4zTF+B\n +hvSFLbp6iDqZjVIod4nK/BrSIgMvk4dPDO/DSD7+n/uKjWZ3Iv2Fs5ty6ZVE5QE1D9M\n yVTYR+82UcSAWzHH20eHyKZwaZMJfisrVd8zDxLc0EeIl9HyMw9+yC/BuuEeHZIZDCy1\n YgOA==", "X-Gm-Message-State": "AOJu0YwWS8DKVTjuNl6cIoYL4eBN8jK1iJ/ExiMG3ymwXfmYsxd7KXuZ\n 0tj2lXN89sh3Oz+q0kr3MfC6dDb3hh0JNINl/Jk=", "X-Google-Smtp-Source": "\n AGHT+IG2iVoJzkn0BTQ+GtgMRNQzos+Pq0jKQXtCFQbUoEkZ7IZ1IzXIZCZlyIJ2fUDKrr5V9A/QrA==", "X-Received": "by 2002:a05:6358:338b:b0:16b:96fc:650e with SMTP id\n i11-20020a056358338b00b0016b96fc650emr5004947rwd.3.1700702815136;\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 1/6] Section 1: Introduction", "Date": "Wed, 22 Nov 2023 20:26:22 -0500", "Message-ID": "<20231123012633.2005-2-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": "Added link to Getting Started Guide in index.rst\n\nMoved run_apps.rst to GSG index\n\nRemoved run_apps/index.rst - no longer needed\n\nAdded run_apps.rst to index\n\n-Reformatted the introduction paragraph for better readability.\n-Clarified that the guide provides basic step-by-step instructions with OS-specific instructions\nincluded only where necessary for each operating system.\n-Emphasized that by the end of this guide, the user should have a solid understanding of how to\nimplement and use DPDK in their networking projects, regardless of the operating system they are using.\n\nMoved run_apps into GSG root directory\n---\n doc/guides/getting_started_guide/index.rst | 18 +++\n doc/guides/getting_started_guide/intro.rst | 13 ++\n doc/guides/getting_started_guide/run_apps.rst | 114 ++++++++++++++++++\n doc/guides/index.rst | 1 +\n 4 files changed, 146 insertions(+)\n create mode 100644 doc/guides/getting_started_guide/index.rst\n create mode 100644 doc/guides/getting_started_guide/intro.rst\n create mode 100644 doc/guides/getting_started_guide/run_apps.rst", "diff": "diff --git a/doc/guides/getting_started_guide/index.rst b/doc/guides/getting_started_guide/index.rst\nnew file mode 100644\nindex 0000000000..3d7c0eb6ee\n--- /dev/null\n+++ b/doc/guides/getting_started_guide/index.rst\n@@ -0,0 +1,18 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2010-2025 Intel Corporation.\n+\n+.. _getting_started_guide:\n+\n+Getting Started Guide\n+=====================\n+\n+.. toctree::\n+ :maxdepth: 2\n+ :numbered:\n+\n+ intro\n+ install_and_build/index\n+ system_setup\n+ run_apps\n+ appendix/index\n+ glossary\ndiff --git a/doc/guides/getting_started_guide/intro.rst b/doc/guides/getting_started_guide/intro.rst\nnew file mode 100644\nindex 0000000000..3560d705d0\n--- /dev/null\n+++ b/doc/guides/getting_started_guide/intro.rst\n@@ -0,0 +1,13 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2010-2014 Intel Corporation.\n+\n+Introduction\n+============\n+\n+Welcome to the getting started guide for the Data Plane Development Kit (DPDK) covering Linux, \n+FreeBSD, and Windows. DPDK is a set of libraries and drivers that accelerate packet processing \n+and allow the user to create high-performance networking applications.\n+\n+The guide is structured to provide basic step-by-step instructions with OS-specific instructions included only where necessary for each operating system. \n+By the end of this guide, you should have a solid understanding of how to implement\n+and use DPDK in your networking projects, regardless of the operating system you are using.\ndiff --git a/doc/guides/getting_started_guide/run_apps.rst b/doc/guides/getting_started_guide/run_apps.rst\nnew file mode 100644\nindex 0000000000..d9ef1a6f96\n--- /dev/null\n+++ b/doc/guides/getting_started_guide/run_apps.rst\n@@ -0,0 +1,114 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2010-2025 Intel Corporation.\n+\n+.. _run_apps:\n+\n+Running Applications\n+====================\n+\n+Running Applications on Linux and FreeBSD\n+-----------------------------------------\n+\n+Compiling and Running Sample Applications\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+To compile a sample application:\n+\n+1. Navigate to the application's directory in the DPDK distribution.\n+2. Execute the ``make`` command on Linux or ``gmake`` on FreeBSD.\n+\n+For instance, to compile the ``helloworld`` application:\n+\n+::\n+\n+ cd examples/helloworld\n+ make # On Linux\n+ gmake # On FreeBSD\n+\n+.. note::\n+ If DPDK is not installed system-wide, \n+ you can compile the examples as part of the DPDK build itself. \n+ If DPDK is not installed system-wide, you can compile the examples as part of the DPDK build \n+ itself. Use the meson build option ``-Dexamples=helloworld`` to compile specific examples \n+ or ``-Dexamples=all`` to compile all examples.\n+\n+To run the application, use:\n+\n+::\n+\n+ ./build/helloworld -l 0-2\n+\n+The ``-l`` option indicates the cores on which the application should run.\n+This command runs the `helloworld` application on cores 0, 1, and 2.\n+\n+Sample Applications Overview\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+For a comprehensive list of sample applications and their guides, \n+refer to the `DPDK Sample Applications User Guides <https://doc.dpdk.org/guides/sample_app_ug/index.html>`_.\n+\n+EAL Parameters\n+--------------\n+\n+Every DPDK application is linked with the DPDK target environment’s \n+Environmental Abstraction Layer (EAL) library. The most essential EAL option is ``-l CORELIST``, which specifies the cores the application should run on. For example:\n+\n+- ``-l 1-3`` to run on 3 cores: 1, 2, and 3.\n+- ``-l 8,16`` to run on 2 cores: 8 and 16.\n+- ``-l 1-7,9-15`` to run on 14 cores: 1 through 7 and 9 through 15.\n+\n+Please refer to the `EAL parameters section <eal_parameters>` section for a more comprehensive list of options.\n+\n+Running Without Root Privileges\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+Refer to :ref:`running_dpdk_apps_without_root`.\n+\n+Running Applications on Windows\n+-------------------------------\n+\n+Running DPDK applications on Windows involves a few different steps. \n+This guide provides detailed instructions on how to run the helloworld example\n+application, which can be used as a reference for running other DPDK applications.\n+\n+Grant Lock Pages in Memory Privilege\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+Use of hugepages (\"large pages\" in Windows terminology) requires\n+``SeLockMemoryPrivilege`` for the user running an application. \n+This privilege allows the DPDK application to keep data in physical memory, \n+preventing the system from paging the data to virtual memory. \n+This can significantly improve the performance of your DPDK applications.\n+\n+To grant this privilege:\n+\n+1. Open Local Security Policy snap-in, either through Control Panel / Computer Management / Local Security Policy, or by pressing Win+R, typing ``secpol``, and pressing Enter.\n+2. Open Local Policies / User Rights Assignment / Lock pages in memory.\n+3. Add desired users or groups to the list of grantees.\n+\n+The privilege is applied upon the next logon. If the privilege has been granted to the\n+current user, a logoff is required before it is available. \n+More details can be found in the `Large-Page Support in MSDN <https://docs.microsoft.com/en-us/windows/win32/memory/large-page-support>`_.\n+\n+Running the helloworld Example\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+After setting up the drivers, you can run the helloworld example to verify your setup.\n+Here are the steps:\n+\n+1. Navigate to the examples in the build directory::\n+\n+ cd C:\\\\Users\\\\me\\\\dpdk\\\\build\\\\examples\n+\n+2. Run the helloworld application::\n+\n+ dpdk-helloworld.exe -l 0-3\n+\n+The output should display a hello message from each core, like this:\n+\n+::\n+\n+ hello from core 1\n+ hello from core 3\n+ hello from core 0\n+ hello from core 2\ndiff --git a/doc/guides/index.rst b/doc/guides/index.rst\nindex 244b99624c..51a47d3a51 100644\n--- a/doc/guides/index.rst\n+++ b/doc/guides/index.rst\n@@ -7,6 +7,7 @@ DPDK documentation\n .. toctree::\n :maxdepth: 1\n \n+ getting_started_guide/index\n linux_gsg/index\n freebsd_gsg/index\n windows_gsg/index\n", "prefixes": [ "v4", "1/6" ] }