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.