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 F0978A0093 for ; Thu, 17 Mar 2022 13:06:33 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E6EF4410EC; Thu, 17 Mar 2022 13:06:33 +0100 (CET) Received: from mail-wm1-f43.google.com (mail-wm1-f43.google.com [209.85.128.43]) by mails.dpdk.org (Postfix) with ESMTP id 33E9E410EC for ; Thu, 17 Mar 2022 13:06:33 +0100 (CET) Received: by mail-wm1-f43.google.com with SMTP id p184-20020a1c29c1000000b0037f76d8b484so3021809wmp.5 for ; Thu, 17 Mar 2022 05:06:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=+rTaxvU8dNkmNHmlgKNyeSvK0RVz/Xsdxw5I0Vqwkoo=; b=JxlFZQCqXfzmvXLjjFRjass9MV+AZcC3fdQHr4gi7tL0GxPYjFjxGNZpjh017iO67V Mu12sURwM27p3h/ojNKAyfvKeT1EZx1zXDejiWNHTZnxJE3Xzdvbvyz/Uw0ABaNurMdi t8+2H1STtExuvt7D1V6fXqvnZL/hr3ojM9aWH1EAnI5qG3GKkJvvhE/6D1Xn4d+pthIv SKYCC502H6/GgLnprL+MkDj6zc21QcOSRhJFbpym7oAF/wNY1JbrEj923ax361BGMgkW RfSubU9sj5K5Q8CVT60EWopQkyYrj9+Kvj1VZOlaM7bq3/KckLrgrudgYZHbHVlISJv5 oNOw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=+rTaxvU8dNkmNHmlgKNyeSvK0RVz/Xsdxw5I0Vqwkoo=; b=fxWEwMv/6jCaSZn+nzfWypXebCRyOFvmj7j0T39NYJ/IXZ9yUBDivctt2tIEVJyosi igZ/poHk766oDJnVSAleCG7U3iEVD48OXF8251Wdlgq4EsjkbmQOmrhPJjXtNVJsbgY+ sWyqlkgxgOkCOXigUqP0fPR2iU/BssCNo+aMSX7b5DXsScLtjZ/1znqPYhe+IEzO6dZH GPOxQRWICTMMGneCi7af5+1g19xTOC4mpzkuxqi1I/32YQlQNWYsNmgVbYSAabP3DjAp NHJI2Ad9S8XKULXmdEiOC+tRPOQOleoqzbjdeVuWdqVDhcum4U3tQs1D/aF2sUZsKlNx 1Khg== X-Gm-Message-State: AOAM532YjCmKYTAulcTSFC9gfFYMdEeThCxxUwqh1hosFwkNGJ/1H7lj TvRqOEQIg7sHC9nwYKtfv9BKslc0mto= X-Google-Smtp-Source: ABdhPJwbWoH4CwTyeSlh5QcEaQv5c2P2gTs3B1QXZSJL1MNgySkKjP9ki+sGfBvehQrOLDAB05NFSA== X-Received: by 2002:a05:600c:4f07:b0:38c:72f0:1c30 with SMTP id l7-20020a05600c4f0700b0038c72f01c30mr4916577wmq.204.1647518792816; Thu, 17 Mar 2022 05:06:32 -0700 (PDT) Received: from localhost ([2a01:4b00:f41a:3600:360b:9754:2e3a:c344]) by smtp.gmail.com with ESMTPSA id ay9-20020a5d6f09000000b001f1f3330fc5sm4179415wrb.28.2022.03.17.05.06.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 17 Mar 2022 05:06:32 -0700 (PDT) From: luca.boccassi@gmail.com To: Bruce Richardson Cc: dpdk stable Subject: patch 'doc: replace characters for (R) symbol in Linux guide' has been queued to stable release 20.11.5 Date: Thu, 17 Mar 2022 12:06:25 +0000 Message-Id: <20220317120627.917448-2-luca.boccassi@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220317120627.917448-1-luca.boccassi@gmail.com> References: <20220315133233.635559-9-luca.boccassi@gmail.com> <20220317120627.917448-1-luca.boccassi@gmail.com> MIME-Version: 1.0 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 20.11.5 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/19/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/bluca/dpdk-stable This queued commit can be viewed at: https://github.com/bluca/dpdk-stable/commit/5bc5bab0dc396b444e963bba02bd0dd7ed9938e8 Thanks. Luca Boccassi --- >From 5bc5bab0dc396b444e963bba02bd0dd7ed9938e8 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 @@ -1,6 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. +.. include:: + .. _Enabling_Additional_Functionality: Enabling Additional Functionality @@ -119,15 +121,15 @@ system objects' permissions should be adjusted: 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 c6b6881ea2..bacfd552ab 100644 --- a/doc/guides/linux_gsg/linux_drivers.rst +++ b/doc/guides/linux_gsg/linux_drivers.rst @@ -3,6 +3,8 @@ Copyright 2017 Mellanox Technologies, Ltd All rights reserved. +.. include:: + .. _linux_gsg_linux_drivers: Linux Drivers @@ -93,7 +95,7 @@ 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:: @@ -329,7 +331,7 @@ Please refer to earlier sections on how to configure kernel parameters 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, and how to enable them. diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst index be714adf22..50a86d5a2e 100644 --- a/doc/guides/linux_gsg/sys_reqs.rst +++ b/doc/guides/linux_gsg/sys_reqs.rst @@ -1,6 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. +.. include:: + System Requirements =================== @@ -66,10 +68,10 @@ 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-17 12:05:30.378137942 +0000 +++ 0002-doc-replace-characters-for-R-symbol-in-Linux-guide.patch 2022-03-17 12:05:30.300855283 +0000 @@ -1 +1 @@ -From c265d58619e7fc0f72441faafec56a2a8633a15b Mon Sep 17 00:00:00 2001 +From 5bc5bab0dc396b444e963bba02bd0dd7ed9938e8 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 @@ -32 +32 @@ -@@ -66,15 +68,15 @@ system objects' permissions should be adjusted: +@@ -119,15 +121,15 @@ system objects' permissions should be adjusted: @@ -52 +52 @@ -index 006a9df83e..ef6fec10d7 100644 +index c6b6881ea2..bacfd552ab 100644 @@ -64 +64 @@ -@@ -99,7 +101,7 @@ The token will be used for all PF and VF ports within the application. +@@ -93,7 +95,7 @@ The token will be used for all PF and VF ports within the application. @@ -73 +73 @@ -@@ -335,7 +337,7 @@ Please refer to earlier sections on how to configure kernel parameters +@@ -329,7 +331,7 @@ Please refer to earlier sections on how to configure kernel parameters @@ -83 +83 @@ -index b2eacac6dc..08d45898f0 100644 +index be714adf22..50a86d5a2e 100644 @@ -95 +95 @@ -@@ -68,10 +70,10 @@ Compilation of the DPDK +@@ -66,10 +68,10 @@ Compilation of the DPDK