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 <bruce.richard...@intel.com>
---
doc/guides/linux_gsg/enable_func.rst | 16 +++++++++-------
doc/guides/linux_gsg/linux_drivers.rst | 6 ++++--
doc/guides/linux_gsg/sys_reqs.rst | 10 ++++++----
3 files changed, 19 insertions(+), 13 deletions(-)
diff --git a/doc/guides/linux_gsg/enable_func.rst
b/doc/guides/linux_gsg/enable_func.rst
index 7bd6b03f10..b5c4c652d7 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:: <isonum.txt>
+
.. _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::
@@ -165,10 +167,10 @@ It should be loaded using the insmod command::
See the "Kernel NIC Interface Sample Application" chapter in the *DPDK
Sample Applications User Guide* for more details.
-Using Linux IOMMU Pass-Through to Run DPDK with Intel® VT-d
------------------------------------------------------------
+Using Linux IOMMU Pass-Through to Run DPDK with Intel\ |reg| VT-d
+------------------------------------------------------------------
-To enable Intel® VT-d in a Linux kernel, a number of kernel configuration
options must be set. These include:
+To enable Intel\ |reg| VT-d in a Linux kernel, a number of kernel
configuration options must be set. These include:
* ``IOMMU_SUPPORT``
@@ -176,7 +178,7 @@ To enable Intel® VT-d in a Linux kernel, a number of kernel
configuration optio
* ``INTEL_IOMMU``
-In addition, to run the DPDK with Intel® VT-d, the ``iommu=pt`` kernel
parameter must be used when using ``igb_uio`` driver.
+In addition, to run the DPDK with Intel\ |reg| VT-d, the ``iommu=pt`` kernel
parameter must be used when using ``igb_uio`` driver.
This results in pass-through of the DMAR (DMA Remapping) lookup in the host.
Also, if ``INTEL_IOMMU_DEFAULT_ON`` is not set in the kernel, the
``intel_iommu=on`` kernel parameter must be used too.
This ensures that the Intel IOMMU is being initialized as expected.
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
@@ -3,6 +3,8 @@
Copyright 2017 Mellanox Technologies, Ltd
All rights reserved.
+.. include:: <isonum.txt>
+
.. _linux_gsg_linux_drivers:
Linux Drivers
@@ -99,7 +101,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::
@@ -335,7 +337,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 d95a78d156..9dccd54d9c 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:: <isonum.txt>
+
System Requirements
===================
@@ -8,8 +10,8 @@ This chapter describes the packages required to compile the
DPDK.
.. note::
- If the DPDK is being used on an Intel® Communications Chipset 89xx Series
platform,
- please consult the *Intel® Communications Chipset 89xx Series Software for
Linux Getting Started Guide*.
+ If the DPDK is being used on an Intel\ |reg| Communications Chipset 89xx
Series platform,
+ please consult the *Intel\ |reg| Communications Chipset 89xx Series
Software for Linux Getting Started Guide*.
BIOS Setting Prerequisite on x86
--------------------------------
@@ -72,10 +74,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.32.0
