From c053d9e9629b2337093dfd344eb904f0aff703bd Mon Sep 17 00:00:00 2001 From: Sarosh Arif Date: Wed, 16 Sep 2020 16:14:38 +0500 Subject: [PATCH] doc: fix grammar This patch corrects a grammatical error by changing 'an DPDK' to 'a DPDK', so that the sentences can become grammatically accurate. Fixes: 2e486e26328c ("doc: remove Intel references from linux guide") Fixes: 48624fd96e7c ("doc: remove Intel references from prog guide") Fixes: e0c7c4731957 ("doc: remove Intel references from sample apps guide") Cc: stable@dpdk.org Signed-off-by: Sarosh Arif Reviewed-by: David Marchand --- doc/guides/linux_gsg/build_sample_apps.rst | 4 ++-- doc/guides/linux_gsg/enable_func.rst | 2 +- doc/guides/linux_gsg/linux_drivers.rst | 2 +- doc/guides/linux_gsg/sys_reqs.rst | 2 +- doc/guides/prog_guide/multi_proc_support.rst | 2 +- doc/guides/sample_app_ug/l3_forward_power_man.rst | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst index 043a1dcee1..994db4b6a0 100644 --- a/doc/guides/linux_gsg/build_sample_apps.rst +++ b/doc/guides/linux_gsg/build_sample_apps.rst @@ -4,7 +4,7 @@ Running Sample Applications =========================== -The chapter describes how to compile and run applications in an DPDK environment. +The chapter describes how to compile and run applications in a DPDK environment. It also provides a pointer to where sample applications are stored. .. note:: @@ -136,7 +136,7 @@ Each bit of the mask corresponds to the equivalent logical core number as report Since these logical core numbers, and their mapping to specific cores on specific NUMA sockets, can vary from platform to platform, it is recommended that the core layout for each platform be considered when choosing the coremask/corelist to use in each case. -On initialization of the EAL layer by an DPDK application, the logical cores to be used and their socket location are displayed. +On initialization of the EAL layer by a DPDK application, the logical cores to be used and their socket location are displayed. This information can also be determined for all cores on the system by examining the ``/proc/cpuinfo`` file, for example, by running cat ``/proc/cpuinfo``. The physical id attribute listed for each processor indicates the CPU socket to which it belongs. This can be useful when using other processors to understand the mapping of the logical cores to the sockets. diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst index aab32252ea..a2339a877b 100644 --- a/doc/guides/linux_gsg/enable_func.rst +++ b/doc/guides/linux_gsg/enable_func.rst @@ -114,7 +114,7 @@ In addition, C3 and C6 should be enabled as well for power management. The path Using Linux Core Isolation to Reduce Context Switches ----------------------------------------------------- -While the threads used by an DPDK application are pinned to logical cores on the system, +While the threads used by a DPDK application are pinned to logical cores on the system, it is possible for the Linux scheduler to run other tasks on those cores also. To help prevent additional workloads from running on those cores, it is possible to use the ``isolcpus`` Linux kernel parameter to isolate them from the general Linux scheduler. diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst index ef8798569a..2d750b4c33 100644 --- a/doc/guides/linux_gsg/linux_drivers.rst +++ b/doc/guides/linux_gsg/linux_drivers.rst @@ -148,7 +148,7 @@ Binding and Unbinding Network Ports to/from the Kernel Modules PMDs Which use the bifurcated driver should not be unbind from their kernel drivers. this section is for PMDs which use the UIO or VFIO drivers. As of release 1.4, DPDK applications no longer automatically unbind all supported network ports from the kernel driver in use. -Instead, in case the PMD being used use the UIO or VFIO drivers, all ports that are to be used by an DPDK application must be bound to the +Instead, in case the PMD being used use the UIO or VFIO drivers, all ports that are to be used by a DPDK application must be bound to the ``uio_pci_generic``, ``igb_uio`` or ``vfio-pci`` module before the application is run. For such PMDs, any network ports under Linux* control will be ignored and cannot be used by the application. diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst index 6ecdc04aa9..dadb23fc89 100644 --- a/doc/guides/linux_gsg/sys_reqs.rst +++ b/doc/guides/linux_gsg/sys_reqs.rst @@ -97,7 +97,7 @@ e.g. :doc:`../nics/index` Running DPDK Applications ------------------------- -To run an DPDK application, some customization may be required on the target machine. +To run a DPDK application, some customization may be required on the target machine. System Software ~~~~~~~~~~~~~~~ diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst index 57fd7425a1..6b0ac30c5b 100644 --- a/doc/guides/prog_guide/multi_proc_support.rst +++ b/doc/guides/prog_guide/multi_proc_support.rst @@ -75,7 +75,7 @@ and point to the same objects, in both processes. The EAL also supports an auto-detection mode (set by EAL ``--proc-type=auto`` flag ), -whereby an DPDK process is started as a secondary instance if a primary instance is already running. +whereby a DPDK process is started as a secondary instance if a primary instance is already running. Deployment Models ----------------- diff --git a/doc/guides/sample_app_ug/l3_forward_power_man.rst b/doc/guides/sample_app_ug/l3_forward_power_man.rst index 831f2bf58f..85a78a5c1e 100644 --- a/doc/guides/sample_app_ug/l3_forward_power_man.rst +++ b/doc/guides/sample_app_ug/l3_forward_power_man.rst @@ -49,7 +49,7 @@ to set the CPUFreq governor and set the frequency of specific cores. This application includes a P-state power management algorithm to generate a frequency hint to be sent to CPUFreq. The algorithm uses the number of received and available Rx packets on recent polls to make a heuristic decision to scale frequency up/down. -Specifically, some thresholds are checked to see whether a specific core running an DPDK polling thread needs to increase frequency +Specifically, some thresholds are checked to see whether a specific core running a DPDK polling thread needs to increase frequency a step up based on the near to full trend of polled Rx queues. Also, it decreases frequency a step if packet processed per loop is far less than the expected threshold or the thread's sleeping time exceeds a threshold. -- 2.20.1