Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/108738/?format=api
{ "id": 108738, "url": "https://patches.dpdk.org/api/patches/108738/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20220316134551.1099599-2-bruce.richardson@intel.com/", "project": { "id": 1, "url": "https://patches.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": "<20220316134551.1099599-2-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20220316134551.1099599-2-bruce.richardson@intel.com", "date": "2022-03-16T13:45:43", "name": "[v2,1/9] doc: replace special characters for (R) symbol in Linux GSG", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "086e4f06b2ba0263ca441cac330f90bd056f3582", "submitter": { "id": 20, "url": "https://patches.dpdk.org/api/people/20/?format=api", "name": "Bruce Richardson", "email": "bruce.richardson@intel.com" }, "delegate": { "id": 1, "url": "https://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20220316134551.1099599-2-bruce.richardson@intel.com/mbox/", "series": [ { "id": 22162, "url": "https://patches.dpdk.org/api/series/22162/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=22162", "date": "2022-03-16T13:45:42", "name": "Improve Linux drivers GSG section", "version": 2, "mbox": "https://patches.dpdk.org/series/22162/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/108738/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/108738/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 299F7A0032;\n\tWed, 16 Mar 2022 14:46:11 +0100 (CET)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 0583E41151;\n\tWed, 16 Mar 2022 14:46:07 +0100 (CET)", "from mga14.intel.com (mga14.intel.com [192.55.52.115])\n by mails.dpdk.org (Postfix) with ESMTP id CCDF540395;\n Wed, 16 Mar 2022 14:46:03 +0100 (CET)", "from orsmga005.jf.intel.com ([10.7.209.41])\n by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 16 Mar 2022 06:46:02 -0700", "from silpixa00399126.ir.intel.com ([10.237.223.34])\n by orsmga005.jf.intel.com with ESMTP; 16 Mar 2022 06:46:01 -0700" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n d=intel.com; i=@intel.com; q=dns/txt; s=Intel;\n t=1647438364; x=1678974364;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=w42y0b+vp/x5rgqV86/n/k3hG7cBj8/I10n/LtBAeSk=;\n b=SsMnsR8UqCFWZEaQ7ZQ+g2qffUzrOR6hmfnd3b8G+R4jKcPqGSsJAAhp\n P7p3c+JPVQDmIau22TIy3i4KnPflJKlNktwwwoZfUCNV7FJJ5NMJWcrLh\n Xo2ppktfptukQod3TtmZNRWnV2Z3fZtfYrEgvSFJdrnQb0GFM4OkXojcI\n lhPgHMsq2jpsFBwGXzOtSDbip7ZguaRSHRyHiVS26nS/bWjrSX17x9771\n NhWRCbzZoZtpTxyvmBe5lCDEvrmp+gS7WaEbuFddDMMPF+U/HC0bROruj\n VGW8N3GdKzHOcLK+0XX/XT1lkVmNu/0pv7xOf9omBUm9PxshVDeW/+A5x g==;", "X-IronPort-AV": [ "E=McAfee;i=\"6200,9189,10286\"; a=\"256780535\"", "E=Sophos;i=\"5.90,186,1643702400\"; d=\"scan'208\";a=\"256780535\"", "E=Sophos;i=\"5.90,186,1643702400\"; d=\"scan'208\";a=\"714606475\"" ], "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org", "Cc": "Bruce Richardson <bruce.richardson@intel.com>,\n\tstable@dpdk.org", "Subject": "[PATCH v2 1/9] doc: replace special characters for (R) symbol in\n Linux GSG", "Date": "Wed, 16 Mar 2022 13:45:43 +0000", "Message-Id": "<20220316134551.1099599-2-bruce.richardson@intel.com>", "X-Mailer": "git-send-email 2.32.0", "In-Reply-To": "<20220316134551.1099599-1-bruce.richardson@intel.com>", "References": "<20220302172217.472279-1-bruce.richardson@intel.com>\n <20220316134551.1099599-1-bruce.richardson@intel.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": "Some IDEs, such as eclipse, complained on save about the use of special\ncharacters in the (R) symbol in linux GSG doc. We can replace those with\nthe equivalent \"|reg|\" text, and including isonum.txt.\n\nCc: stable@dpdk.org\n\nSigned-off-by: Bruce Richardson <bruce.richardson@intel.com>\n---\n doc/guides/linux_gsg/enable_func.rst | 8 +++++---\n doc/guides/linux_gsg/linux_drivers.rst | 6 ++++--\n doc/guides/linux_gsg/sys_reqs.rst | 6 ++++--\n 3 files changed, 13 insertions(+), 7 deletions(-)\n\n--\n2.32.0", "diff": "diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst\nindex 44c3b05130..1df3ab0255 100644\n--- a/doc/guides/linux_gsg/enable_func.rst\n+++ b/doc/guides/linux_gsg/enable_func.rst\n@@ -1,6 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2010-2014 Intel Corporation.\n\n+.. include:: <isonum.txt>\n+\n .. _Enabling_Additional_Functionality:\n\n Enabling Additional Functionality\n@@ -66,15 +68,15 @@ system objects' permissions should be adjusted:\n Power Management and Power Saving Functionality\n -----------------------------------------------\n\n-Enhanced Intel SpeedStep® Technology must be enabled in the platform BIOS if the power management feature of DPDK is to be used.\n+Enhanced Intel SpeedStep\\ |reg| Technology must be enabled in the platform BIOS if the power management feature of DPDK is to be used.\n Otherwise, the sys file folder ``/sys/devices/system/cpu/cpu0/cpufreq`` will not exist, and the CPU frequency- based power management cannot be used.\n Consult the relevant BIOS documentation to determine how these settings can be accessed.\n\n-For example, on some Intel reference platform BIOS variants, the path to Enhanced Intel SpeedStep® Technology is::\n+For example, on some Intel reference platform BIOS variants, the path to Enhanced Intel SpeedStep\\ |reg| Technology is::\n\n Advanced\n -> Processor Configuration\n- -> Enhanced Intel SpeedStep® Tech\n+ -> Enhanced Intel SpeedStep\\ |reg| Tech\n\n In addition, C3 and C6 should be enabled as well for power management. The path of C3 and C6 on the same platform BIOS is::\n\ndiff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst\nindex 006a9df83e..ef6fec10d7 100644\n--- a/doc/guides/linux_gsg/linux_drivers.rst\n+++ b/doc/guides/linux_gsg/linux_drivers.rst\n@@ -3,6 +3,8 @@\n Copyright 2017 Mellanox Technologies, Ltd\n All rights reserved.\n\n+.. include:: <isonum.txt>\n+\n .. _linux_gsg_linux_drivers:\n\n Linux Drivers\n@@ -99,7 +101,7 @@ The token will be used for all PF and VF ports within the application.\n\n To make use of full VFIO functionality,\n both kernel and BIOS must support and be configured\n-to use IO virtualization (such as Intel® VT-d).\n+to use IO virtualization (such as Intel\\ |reg| VT-d).\n\n .. note::\n\n@@ -335,7 +337,7 @@ Please refer to earlier sections on how to configure kernel parameters\n correctly for your system.\n\n If the kernel is configured correctly, one also has to make sure that\n-the BIOS configuration has virtualization features (such as Intel® VT-d).\n+the BIOS configuration has virtualization features (such as Intel\\ |reg| VT-d).\n There is no standard way to check if the platform is configured correctly,\n so please check with your platform documentation to see if it has such features,\n and how to enable them.\ndiff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst\nindex b2eacac6dc..08d45898f0 100644\n--- a/doc/guides/linux_gsg/sys_reqs.rst\n+++ b/doc/guides/linux_gsg/sys_reqs.rst\n@@ -1,6 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2010-2014 Intel Corporation.\n\n+.. include:: <isonum.txt>\n+\n System Requirements\n ===================\n\n@@ -68,10 +70,10 @@ Compilation of the DPDK\n\n **Optional Tools:**\n\n-* Intel® C++ Compiler (icc). For installation, additional libraries may be required.\n+* Intel\\ |reg| C++ Compiler (icc). For installation, additional libraries may be required.\n See the icc Installation Guide found in the Documentation directory under the compiler installation.\n\n-* IBM® Advance ToolChain for Powerlinux. This is a set of open source development tools and runtime libraries\n+* IBM\\ |reg| Advance ToolChain for Powerlinux. This is a set of open source development tools and runtime libraries\n which allows users to take leading edge advantage of IBM's latest POWER hardware features on Linux. To install\n it, see the IBM official installation document.\n\n", "prefixes": [ "v2", "1/9" ] }