Re: [dpdk-dev] [PATCH v2] doc: fix grammatical error

[David Marchand <david.marchand@redhat.com>]

On Wed, Sep 16, 2020 at 1:16 PM Sarosh Arif <sarosh.arif@emumba.com> wrote:
>
> This patch corrects a grammatical error by changing 'an DPDK' to 'a DPDK',
> so that the sentences can become grammatically accurate.
>
> Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
> ---
>  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 2882883f9..da3eea306 100644
> --- a/doc/guides/linux_gsg/build_sample_apps.rst
> +++ b/doc/guides/linux_gsg/build_sample_apps.rst
> @@ -4,7 +4,7 @@
>  Compiling and 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 b2bda80bb..ad11bc9e4 100644
> --- a/doc/guides/linux_gsg/enable_func.rst
> +++ b/doc/guides/linux_gsg/enable_func.rst
> @@ -112,7 +112,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 185074013..ccd93464a 100644
> --- a/doc/guides/linux_gsg/linux_drivers.rst
> +++ b/doc/guides/linux_gsg/linux_drivers.rst
> @@ -159,7 +159,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 6b9f573fc..5997ab06b 100644
> --- a/doc/guides/linux_gsg/sys_reqs.rst
> +++ b/doc/guides/linux_gsg/sys_reqs.rst
> @@ -101,7 +101,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 a84083b96..1a4a9e2d4 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 0cc6f2e62..7a9730197 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.25.1
>

Reviewed-by: David Marchand <david.marchand@redhat.com>


-- 
David Marchand