From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id B0FA3A04FF for ; Mon, 21 Mar 2022 15:44:06 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A9AD54161A; Mon, 21 Mar 2022 15:44:06 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 926104161A for ; Mon, 21 Mar 2022 15:44:05 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1647873845; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=QXjxi37csZel6O2uJbM29HRSS9XMItxlJLjggp466aM=; b=Kq/+fsRXS2jFauehbzp0MoDGe4Lhx2qcCz2Lh0orOx5Uyz9+TF9fDAHnCO/2yciFlUSmG0 592tu/J4TiXL8qjix/LapB0flpcizDzz6NRWQB+J7+hhDyBcQItw/OAr6ONFCrkM8+kqlq IsBwUuHwwte2l/Ga/CS9TRdkMy/7KyI= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-303-mpyqI24LMVKQvfipT__aWg-1; Mon, 21 Mar 2022 10:43:57 -0400 X-MC-Unique: mpyqI24LMVKQvfipT__aWg-1 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id D3E20106655F; Mon, 21 Mar 2022 14:43:56 +0000 (UTC) Received: from rh.Home (unknown [10.39.195.33]) by smtp.corp.redhat.com (Postfix) with ESMTP id 07C6143E385; Mon, 21 Mar 2022 14:43:55 +0000 (UTC) From: Kevin Traynor To: Bruce Richardson Cc: dpdk stable Subject: patch 'doc: replace characters for (R) symbol in Linux guide' has been queued to stable release 21.11.1 Date: Mon, 21 Mar 2022 14:43:37 +0000 Message-Id: <20220321144340.64983-1-ktraynor@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=ktraynor@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Hi, FYI, your patch has been queued to stable release 21.11.1 Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet. It will be pushed if I get no objections before 03/22/22. So please shout if anyone has objections. Also note that after the patch there's a diff of the upstream commit vs the patch applied to the branch. This will indicate if there was any rebasing needed to apply to the stable branch. If there were code changes for rebasing (ie: not only metadata diffs), please double check that the rebase was correctly done. Queued patches are on a temporary branch at: https://github.com/kevintraynor/dpdk-stable This queued commit can be viewed at: https://github.com/kevintraynor/dpdk-stable/commit/713a4bc48c52058172520805373103c79ef17a3a Thanks. Kevin --- >From 713a4bc48c52058172520805373103c79ef17a3a Mon Sep 17 00:00:00 2001 From: Bruce Richardson Date: Wed, 16 Mar 2022 13:45:43 +0000 Subject: [PATCH] doc: replace characters for (R) symbol in Linux guide [ upstream commit c265d58619e7fc0f72441faafec56a2a8633a15b ] Some IDEs, such as eclipse, complained on save about the use of special characters in the (R) symbol in linux GSG doc. We can replace those with the equivalent "|reg|" text, and including isonum.txt. Signed-off-by: Bruce Richardson --- doc/guides/linux_gsg/enable_func.rst | 8 +++++--- doc/guides/linux_gsg/linux_drivers.rst | 6 ++++-- doc/guides/linux_gsg/sys_reqs.rst | 6 ++++-- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst index 7bd6b03f10..25f87f6b1a 100644 --- a/doc/guides/linux_gsg/enable_func.rst +++ b/doc/guides/linux_gsg/enable_func.rst @@ -2,4 +2,6 @@ Copyright(c) 2010-2014 Intel Corporation. +.. include:: + .. _Enabling_Additional_Functionality: @@ -120,13 +122,13 @@ Power Management and Power Saving Functionality ----------------------------------------------- -Enhanced Intel SpeedStep® Technology must be enabled in the platform BIOS if the power management feature of DPDK is to be used. +Enhanced Intel SpeedStep\ |reg| Technology must be enabled in the platform BIOS if the power management feature of DPDK is to be used. Otherwise, the sys file folder ``/sys/devices/system/cpu/cpu0/cpufreq`` will not exist, and the CPU frequency- based power management cannot be used. Consult the relevant BIOS documentation to determine how these settings can be accessed. -For example, on some Intel reference platform BIOS variants, the path to Enhanced Intel SpeedStep® Technology is:: +For example, on some Intel reference platform BIOS variants, the path to Enhanced Intel SpeedStep\ |reg| Technology is:: Advanced -> Processor Configuration - -> Enhanced Intel SpeedStep® Tech + -> Enhanced Intel SpeedStep\ |reg| Tech 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:: diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst index 2dd711bb37..56564286ac 100644 --- a/doc/guides/linux_gsg/linux_drivers.rst +++ b/doc/guides/linux_gsg/linux_drivers.rst @@ -4,4 +4,6 @@ All rights reserved. +.. include:: + .. _linux_gsg_linux_drivers: @@ -100,5 +102,5 @@ The token will be used for all PF and VF ports within the application. To make use of full VFIO functionality, both kernel and BIOS must support and be configured -to use IO virtualization (such as Intel® VT-d). +to use IO virtualization (such as Intel\ |reg| VT-d). .. note:: @@ -336,5 +338,5 @@ correctly for your system. If the kernel is configured correctly, one also has to make sure that -the BIOS configuration has virtualization features (such as Intel® VT-d). +the BIOS configuration has virtualization features (such as Intel\ |reg| VT-d). There is no standard way to check if the platform is configured correctly, so please check with your platform documentation to see if it has such features, diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst index d95a78d156..cfaa2db301 100644 --- a/doc/guides/linux_gsg/sys_reqs.rst +++ b/doc/guides/linux_gsg/sys_reqs.rst @@ -2,4 +2,6 @@ Copyright(c) 2010-2014 Intel Corporation. +.. include:: + System Requirements =================== @@ -73,8 +75,8 @@ Compilation of the DPDK **Optional Tools:** -* Intel® C++ Compiler (icc). For installation, additional libraries may be required. +* Intel\ |reg| C++ Compiler (icc). For installation, additional libraries may be required. See the icc Installation Guide found in the Documentation directory under the compiler installation. -* IBM® Advance ToolChain for Powerlinux. This is a set of open source development tools and runtime libraries +* IBM\ |reg| Advance ToolChain for Powerlinux. This is a set of open source development tools and runtime libraries which allows users to take leading edge advantage of IBM's latest POWER hardware features on Linux. To install it, see the IBM official installation document. -- 2.34.1 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2022-03-21 14:24:08.436475218 +0000 +++ 0001-doc-replace-characters-for-R-symbol-in-Linux-guide.patch 2022-03-21 14:24:08.411777655 +0000 @@ -1 +1 @@ -From c265d58619e7fc0f72441faafec56a2a8633a15b Mon Sep 17 00:00:00 2001 +From 713a4bc48c52058172520805373103c79ef17a3a Mon Sep 17 00:00:00 2001 @@ -5,0 +6,2 @@ +[ upstream commit c265d58619e7fc0f72441faafec56a2a8633a15b ] + @@ -10,2 +11,0 @@ -Cc: stable@dpdk.org - @@ -20 +20 @@ -index 44c3b05130..1df3ab0255 100644 +index 7bd6b03f10..25f87f6b1a 100644 @@ -30 +30 @@ -@@ -67,13 +69,13 @@ Power Management and Power Saving Functionality +@@ -120,13 +122,13 @@ Power Management and Power Saving Functionality @@ -48 +48 @@ -index 006a9df83e..ef6fec10d7 100644 +index 2dd711bb37..56564286ac 100644 @@ -73 +73 @@ -index b2eacac6dc..08d45898f0 100644 +index d95a78d156..cfaa2db301 100644 @@ -83 +83 @@ -@@ -69,8 +71,8 @@ Compilation of the DPDK +@@ -73,8 +75,8 @@ Compilation of the DPDK