[dpdk-stable] patch 'doc/guides: clean repeated words' has been queued to LTS release 18.11.6
Kevin Traynor
ktraynor at redhat.com
Wed Dec 11 22:26:20 CET 2019
Hi,
FYI, your patch has been queued to LTS release 18.11.6
Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/17/19. 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/kevintraynor/dpdk-stable-queue
This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/98e4dae7d0a00b2ccbc809983b3f0866f748044a
Thanks.
Kevin.
---
>From 98e4dae7d0a00b2ccbc809983b3f0866f748044a Mon Sep 17 00:00:00 2001
From: David Marchand <david.marchand at redhat.com>
Date: Tue, 12 Nov 2019 20:33:41 +0100
Subject: [PATCH] doc/guides: clean repeated words
[ upstream commit f43d3dbbd90c9e195d26d18ac7da9ca2854c3f1e ]
Shoot repeated words in all our guides.
Signed-off-by: David Marchand <david.marchand at redhat.com>
Acked-by: Kevin Traynor <ktraynor at redhat.com>
---
doc/guides/contributing/coding_style.rst | 8 ++++----
doc/guides/cryptodevs/zuc.rst | 2 +-
doc/guides/linux_gsg/nic_perf_intel_platform.rst | 2 +-
doc/guides/nics/fm10k.rst | 2 +-
doc/guides/prog_guide/env_abstraction_layer.rst | 2 +-
.../prog_guide/generic_segmentation_offload_lib.rst | 2 +-
doc/guides/prog_guide/kernel_nic_interface.rst | 2 +-
doc/guides/prog_guide/packet_classif_access_ctrl.rst | 4 ++--
doc/guides/prog_guide/rte_flow.rst | 2 +-
doc/guides/prog_guide/rte_security.rst | 4 ++--
doc/guides/rel_notes/release_17_11.rst | 2 +-
doc/guides/rel_notes/release_18_02.rst | 2 +-
doc/guides/sample_app_ug/ethtool.rst | 2 +-
doc/guides/sample_app_ug/performance_thread.rst | 2 +-
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
15 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index 656563dde..b848be5fb 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -632,8 +632,8 @@ In the DPDK environment, use the logging interface provided:
/* log in debug level */
rte_log_set_global_level(RTE_LOG_DEBUG);
- RTE_LOG(DEBUG, my_logtype1, "this is is a debug level message\n");
- RTE_LOG(INFO, my_logtype1, "this is is a info level message\n");
- RTE_LOG(WARNING, my_logtype1, "this is is a warning level message\n");
- RTE_LOG(WARNING, my_logtype2, "this is is a debug level message (not displayed)\n");
+ RTE_LOG(DEBUG, my_logtype1, "this is a debug level message\n");
+ RTE_LOG(INFO, my_logtype1, "this is a info level message\n");
+ RTE_LOG(WARNING, my_logtype1, "this is a warning level message\n");
+ RTE_LOG(WARNING, my_logtype2, "this is a debug level message (not displayed)\n");
/* log in info level */
diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
index e38989968..dcd3ab0a5 100644
--- a/doc/guides/cryptodevs/zuc.rst
+++ b/doc/guides/cryptodevs/zuc.rst
@@ -29,5 +29,5 @@ Limitations
* ZUC (EEA3) supported only if cipher length, cipher offset fields are byte-aligned.
* ZUC PMD cannot be built as a shared library, due to limitations in
- in the underlying library.
+ the underlying library.
diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
index cf5c9e0db..4e9afbdbc 100644
--- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
+++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
@@ -153,5 +153,5 @@ Configurations before running DPDK
mount -t hugetlbfs nodev /mnt/huge
-2. Check the CPU layout using using the DPDK ``cpu_layout`` utility:
+2. Check the CPU layout using the DPDK ``cpu_layout`` utility:
.. code-block:: console
diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst
index 20a1cde53..4e178c2cc 100644
--- a/doc/guides/nics/fm10k.rst
+++ b/doc/guides/nics/fm10k.rst
@@ -120,5 +120,5 @@ Switch manager
The Intel FM10000 family of NICs integrate a hardware switch and multiple host
interfaces. The FM10000 PMD driver only manages host interfaces. For the
-switch component another switch driver has to be loaded prior to to the
+switch component another switch driver has to be loaded prior to the
FM10000 PMD driver. The switch driver can be acquired from Intel support.
Only Testpoint is validated with DPDK, the latest version that has been
diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst
index 2bb77b019..a7536a80e 100644
--- a/doc/guides/prog_guide/env_abstraction_layer.rst
+++ b/doc/guides/prog_guide/env_abstraction_layer.rst
@@ -221,5 +221,5 @@ matter of supplying the correct socket ID to DPDK allocator, either directly
structure-specific allocation API's such as ``rte_ring_create``).
-Since there is no way DPDK can verify whether memory are is available or valid,
+Since there is no way DPDK can verify whether memory is available or valid,
this responsibility falls on the shoulders of the user. All multiprocess
synchronization is also user's responsibility, as well as ensuring that all
diff --git a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst
index 0cfc1198c..73e768740 100644
--- a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst
+++ b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst
@@ -207,5 +207,5 @@ To segment an outgoing packet, an application must:
- The GSO library use the value of an mbuf's ``ol_flags`` attribute to
- to determine how a packet should be segmented. It is the application's
+ determine how a packet should be segmented. It is the application's
responsibility to ensure that these flags are set.
diff --git a/doc/guides/prog_guide/kernel_nic_interface.rst b/doc/guides/prog_guide/kernel_nic_interface.rst
index 9c1483adc..ccf03a41d 100644
--- a/doc/guides/prog_guide/kernel_nic_interface.rst
+++ b/doc/guides/prog_guide/kernel_nic_interface.rst
@@ -244,5 +244,5 @@ to create a separate thread or secondary process to periodically call
The KNI interfaces can be deleted by a DPDK application with
``rte_kni_release()``. All KNI interfaces not explicitly deleted will be
-deleted when the the ``/dev/kni`` device is closed, either explicitly with
+deleted when the ``/dev/kni`` device is closed, either explicitly with
``rte_kni_close()`` or when the DPDK application is closed.
diff --git a/doc/guides/prog_guide/packet_classif_access_ctrl.rst b/doc/guides/prog_guide/packet_classif_access_ctrl.rst
index 395b3ec47..9e08a8e3f 100644
--- a/doc/guides/prog_guide/packet_classif_access_ctrl.rst
+++ b/doc/guides/prog_guide/packet_classif_access_ctrl.rst
@@ -155,5 +155,5 @@ To define classification for the IPv6 2-tuple: <protocol, IPv6 source address> o
.. code-block:: c
- struct struct ipv6_hdr {
+ struct ipv6_hdr {
uint32_t vtc_flow; /* IP version, traffic class & flow label. */
uint16_t payload_len; /* IP packet length - includes sizeof(ip_header). */
@@ -168,5 +168,5 @@ The following array of field definitions can be used:
.. code-block:: c
- struct struct rte_acl_field_def ipv6_2tuple_defs[5] = {
+ struct rte_acl_field_def ipv6_2tuple_defs[5] = {
{
.type = RTE_ACL_FIELD_TYPE_BITMASK,
diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index 9c6fc5e82..cbfeee870 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -1525,5 +1525,5 @@ The shared flag indicates whether the counter is unique to the flow rule the
action is specified with, or whether it is a shared counter.
-For a count action with the shared flag set, then then a global device
+For a count action with the shared flag set, then a global device
namespace is assumed for the counter id, so that any matched flow rules using
a count action with the same counter id on the same port will contribute to
diff --git a/doc/guides/prog_guide/rte_security.rst b/doc/guides/prog_guide/rte_security.rst
index 7d0734a37..f77fb89dc 100644
--- a/doc/guides/prog_guide/rte_security.rst
+++ b/doc/guides/prog_guide/rte_security.rst
@@ -52,5 +52,5 @@ packet. e.g. In case of IPsec, the IPsec tunnel headers (if any),
ESP/AH headers will remain in the packet but the received packet
contains the decrypted data where the encrypted data was when the packet
-arrived. The driver Rx path check the descriptors and and based on the
+arrived. The driver Rx path check the descriptors and based on the
crypto status sets additional flags in the rte_mbuf.ol_flags field.
@@ -66,5 +66,5 @@ relevant security protocol headers. Only the data will not be
encrypted by the software. The driver will accordingly configure the
tx descriptors. The hardware device will encrypt the data before sending the
-the packet out.
+packet out.
.. note::
diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst
index 6448b6cb1..1f3b45ef6 100644
--- a/doc/guides/rel_notes/release_17_11.rst
+++ b/doc/guides/rel_notes/release_17_11.rst
@@ -476,5 +476,5 @@ API Changes
Two ``mbuf`` flags have been added to indicate that the VLAN
- identifier has been saved in in the ``mbuf`` structure. For instance:
+ identifier has been saved in the ``mbuf`` structure. For instance:
- If VLAN is not stripped and TCI is saved: ``PKT_RX_VLAN``
diff --git a/doc/guides/rel_notes/release_18_02.rst b/doc/guides/rel_notes/release_18_02.rst
index 8e403118a..3523ea7fd 100644
--- a/doc/guides/rel_notes/release_18_02.rst
+++ b/doc/guides/rel_notes/release_18_02.rst
@@ -211,5 +211,5 @@ New Features
operations by allowing applications to interact with device using opaque
structures/buffers. Also, southbound APIs provide a means of integrating devices
- either as as part of a physical bus (PCI, FSLMC etc) or through ``vdev``.
+ either as part of a physical bus (PCI, FSLMC etc) or through ``vdev``.
See the :doc:`../prog_guide/rawdev` programmer's guide for more details.
diff --git a/doc/guides/sample_app_ug/ethtool.rst b/doc/guides/sample_app_ug/ethtool.rst
index 47e09f6ed..8f7fc6ca6 100644
--- a/doc/guides/sample_app_ug/ethtool.rst
+++ b/doc/guides/sample_app_ug/ethtool.rst
@@ -41,5 +41,5 @@ The application is console-driven using the cmdline DPDK interface:
From this interface the available commands and descriptions of what
-they do as as follows:
+they do as follows:
* ``drvinfo``: Print driver info
diff --git a/doc/guides/sample_app_ug/performance_thread.rst b/doc/guides/sample_app_ug/performance_thread.rst
index 96f0fc6fd..a0ff18ffd 100644
--- a/doc/guides/sample_app_ug/performance_thread.rst
+++ b/doc/guides/sample_app_ug/performance_thread.rst
@@ -281,5 +281,5 @@ interconnected via software rings.
On initialization an L-thread scheduler is started on every EAL thread. On all
-but the master EAL thread only a a dummy L-thread is initially started.
+but the master EAL thread only a dummy L-thread is initially started.
The L-thread started on the master EAL thread then spawns other L-threads on
different L-thread schedulers according the command line parameters.
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 37d5d876b..c327d1f4d 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -34,5 +34,5 @@ If you type a partial command and hit ``<TAB>`` you get a list of the available
.. note::
- Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes::
+ Some examples in this document are too long to fit on one line are shown wrapped at `"\\"` for display purposes::
testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
@@ -2575,5 +2575,5 @@ Traffic Management
The following section shows functions for configuring traffic management on
-on the ethernet device through the use of generic TM API.
+the ethernet device through the use of generic TM API.
show port traffic management capability
--
2.21.0
---
Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- - 2019-12-11 21:24:14.940436094 +0000
+++ 0028-doc-guides-clean-repeated-words.patch 2019-12-11 21:24:12.654651486 +0000
@@ -1 +1 @@
-From f43d3dbbd90c9e195d26d18ac7da9ca2854c3f1e Mon Sep 17 00:00:00 2001
+From 98e4dae7d0a00b2ccbc809983b3f0866f748044a Mon Sep 17 00:00:00 2001
@@ -6 +6 @@
-Shoot repeated words in all our guides.
+[ upstream commit f43d3dbbd90c9e195d26d18ac7da9ca2854c3f1e ]
@@ -8 +8 @@
-Cc: stable at dpdk.org
+Shoot repeated words in all our guides.
@@ -17,2 +16,0 @@
- doc/guides/prog_guide/bbdev.rst | 2 +-
- doc/guides/prog_guide/cryptodev_lib.rst | 4 ++--
@@ -27,2 +24,0 @@
- doc/guides/rel_notes/release_19_02.rst | 4 ++--
- doc/guides/rel_notes/release_19_11.rst | 2 +-
@@ -30,2 +25,0 @@
- doc/guides/sample_app_ug/ipsec_secgw.rst | 2 +-
- doc/guides/sample_app_ug/ntb.rst | 2 +-
@@ -34,2 +28 @@
- doc/guides/tools/proc_info.rst | 2 +-
- 22 files changed, 30 insertions(+), 30 deletions(-)
+ 15 files changed, 21 insertions(+), 21 deletions(-)
@@ -38 +31 @@
-index e95a1a2be..a6843de5a 100644
+index 656563dde..b848be5fb 100644
@@ -55 +48 @@
-index 69a5218b1..002e986da 100644
+index e38989968..dcd3ab0a5 100644
@@ -66 +59 @@
-index 0c25ec03d..c554c2159 100644
+index cf5c9e0db..4e9afbdbc 100644
@@ -69 +62 @@
-@@ -151,5 +151,5 @@ Configurations before running DPDK
+@@ -153,5 +153,5 @@ Configurations before running DPDK
@@ -87,29 +79,0 @@
-diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst
-index d49184967..d39167af1 100644
---- a/doc/guides/prog_guide/bbdev.rst
-+++ b/doc/guides/prog_guide/bbdev.rst
-@@ -1070,5 +1070,5 @@ the code block size ``K``.
-
- The first CB Virtual Circular Buffer (VCB) index is given by ``r`` but the
--the number of the remaining CB VCBs is calculated automatically by BBDEV
-+number of the remaining CB VCBs is calculated automatically by BBDEV
- and passed down to the driver.
-
-diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst
-index bf0ee79f8..ac1643774 100644
---- a/doc/guides/prog_guide/cryptodev_lib.rst
-+++ b/doc/guides/prog_guide/cryptodev_lib.rst
-@@ -499,5 +499,5 @@ operations such as cipher encrypt and authentication generate, the next pointer
- allows transform to be chained together. Crypto devices which support chaining
- must publish the chaining of symmetric Crypto operations feature flag. Allocation of the
--xform structure is in the the application domain. To allow future API extensions in a
-+xform structure is in the application domain. To allow future API extensions in a
- backwardly compatible manner, e.g. addition of a new parameter, the application should
- zero the full xform struct before populating it.
-@@ -894,5 +894,5 @@ to specify the details of the asymmetric Crypto operation. Next pointer within
- xform allows transform to be chained together. Also it is important to note that
- the order in which the transforms are passed indicates the order of the chaining. Allocation
--of the xform structure is in the the application domain. To allow future API extensions in a
-+of the xform structure is in the application domain. To allow future API extensions in a
- backwardly compatible manner, e.g. addition of a new parameter, the application should
- zero the full xform struct before populating it.
@@ -117 +81 @@
-index 6e59faeea..cd8e3003e 100644
+index 2bb77b019..a7536a80e 100644
@@ -120,2 +84,2 @@
-@@ -250,5 +250,5 @@ manual memory management.
- + Using heap API's for externally allocated memory
+@@ -221,5 +221,5 @@ matter of supplying the correct socket ID to DPDK allocator, either directly
+ structure-specific allocation API's such as ``rte_ring_create``).
@@ -123,4 +87,4 @@
--Using using a set of malloc heap API's is the recommended way to use externally
-+Using a set of malloc heap API's is the recommended way to use externally
- allocated memory in DPDK. In this way, support for externally allocated memory
- is implemented through overloading the socket ID - externally allocated heaps
+-Since there is no way DPDK can verify whether memory are is available or valid,
++Since there is no way DPDK can verify whether memory is available or valid,
+ this responsibility falls on the shoulders of the user. All multiprocess
+ synchronization is also user's responsibility, as well as ensuring that all
@@ -139 +103 @@
-index 2fd58e117..e12634ddc 100644
+index 9c1483adc..ccf03a41d 100644
@@ -142 +106 @@
-@@ -255,5 +255,5 @@ to create a separate thread or secondary process to periodically call
+@@ -244,5 +244,5 @@ to create a separate thread or secondary process to periodically call
@@ -150 +114 @@
-index c16b11af4..2945eacf5 100644
+index 395b3ec47..9e08a8e3f 100644
@@ -156,2 +120,2 @@
-- struct struct rte_ipv6_hdr {
-+ struct rte_ipv6_hdr {
+- struct struct ipv6_hdr {
++ struct ipv6_hdr {
@@ -168 +132 @@
-index ac0020e44..a254c81ef 100644
+index 9c6fc5e82..cbfeee870 100644
@@ -171 +135 @@
-@@ -1651,5 +1651,5 @@ The shared flag indicates whether the counter is unique to the flow rule the
+@@ -1525,5 +1525,5 @@ The shared flag indicates whether the counter is unique to the flow rule the
@@ -218,27 +181,0 @@
-diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
-index b353620b7..ace1534ef 100644
---- a/doc/guides/rel_notes/release_19_02.rst
-+++ b/doc/guides/rel_notes/release_19_02.rst
-@@ -266,9 +266,9 @@ ABI Changes
- to include the following fields: ``queue ID``, ``traffic class``, ``color``.
-
--* cryptodev: as shown in the the 18.11 deprecation notice, the structure
-+* cryptodev: as shown in the 18.11 deprecation notice, the structure
- ``rte_cryptodev_qp_conf`` has added two parameters for symmetric session
- mempool and symmetric session private data mempool.
-
--* cryptodev: as shown in the the 18.11 deprecation notice, the structure
-+* cryptodev: as shown in the 18.11 deprecation notice, the structure
- ``rte_cryptodev_sym_session`` has been updated to contain more information
- to ensure safely accessing the session and session private data.
-diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
-index 682c1bdf3..c0045a91f 100644
---- a/doc/guides/rel_notes/release_19_11.rst
-+++ b/doc/guides/rel_notes/release_19_11.rst
-@@ -98,5 +98,5 @@ New Features
-
- * Added new API ``rte_eth_dev_set_ptypes`` that allows an application to
-- inform PMD about about reduced range of packet types to handle.
-+ inform PMD about reduced range of packet types to handle.
- * This scheme will allow PMDs to avoid lookup to internal ptype table on Rx
- and thereby improve Rx performance if application wishes do so.
@@ -256,22 +192,0 @@
-diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst
-index ae8cce235..d6d8d4468 100644
---- a/doc/guides/sample_app_ug/ipsec_secgw.rst
-+++ b/doc/guides/sample_app_ug/ipsec_secgw.rst
-@@ -159,5 +159,5 @@ Where:
- will be discarded. Fragment lifetime should be decreased when
- there is a high fragmented traffic loss in high bandwidth networks.
-- Should be lower for for low number of reassembly buckets.
-+ Should be lower for low number of reassembly buckets.
- Valid values: from 1 ns to 10 s. Default value: 10000000 (10 s).
-
-diff --git a/doc/guides/sample_app_ug/ntb.rst b/doc/guides/sample_app_ug/ntb.rst
-index df16af86c..93fb752f2 100644
---- a/doc/guides/sample_app_ug/ntb.rst
-+++ b/doc/guides/sample_app_ug/ntb.rst
-@@ -83,5 +83,5 @@ The application is console-driven using the cmdline DPDK interface:
-
- From this interface the available commands and descriptions of what
--they do as as follows:
-+they do as follows:
-
- * ``send [filepath]``: Send file to the peer host. Need to be in
@@ -279 +194 @@
-index ac6ee8ac2..5fed46465 100644
+index 96f0fc6fd..a0ff18ffd 100644
@@ -290 +205 @@
-index 48473d8e2..6779822e1 100644
+index 37d5d876b..c327d1f4d 100644
@@ -300 +215 @@
-@@ -2761,5 +2761,5 @@ Traffic Management
+@@ -2575,5 +2575,5 @@ Traffic Management
@@ -307,11 +221,0 @@
-diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
-index 2ea1b59c2..0390b9c58 100644
---- a/doc/guides/tools/proc_info.rst
-+++ b/doc/guides/tools/proc_info.rst
-@@ -64,5 +64,5 @@ ring. For invalid or no ring name, whole list is dump.
- The show-mempool parameter display current allocation of all mempool
- debug information. Specifying the name allows to display details for specific
--specific mempool. For invalid or no mempool name, whole list is dump.
-+mempool. For invalid or no mempool name, whole list is dump.
-
- **--iter-mempool=name**
More information about the stable
mailing list