[dpdk-stable] patch 'lib: fix doxygen typos' has been queued to LTS release 17.11.10

[luca.boccassi@gmail.com]

Hi,

FYI, your patch has been queued to LTS release 17.11.10

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/21/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.

Thanks.

Luca Boccassi

---
From ae1448029c443303ddd569c7fafa1258600ed5f8 Mon Sep 17 00:00:00 2001
From: Kevin Traynor <ktraynor@redhat.com>
Date: Wed, 13 Nov 2019 16:10:15 +0000
Subject: [PATCH] lib: fix doxygen typos

[ upstream commit baf023a8edfa70122c96eefa59a8bbd940d034bc ]

Fix these as they are user visible. Found with codespell.

Fixes: af75078fece3 ("first public release")
Fixes: c2361bab70c5 ("eal: compute IOVA mode based on PA availability")
Fixes: 0880c40113ef ("drivers: advertise kmod dependencies in pmdinfo")
Fixes: 56b6ef874f80 ("efd: new Elastic Flow Distributor library")
Fixes: 5a5f3178d4a8 ("power: return error when environment already set")

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
Reviewed-by: David Marchand <david.marchand@redhat.com>
---
 lib/librte_eal/common/eal_common_log.c  | 2 +-
 lib/librte_eal/common/eal_hugepages.h   | 2 +-
 lib/librte_eal/common/include/rte_dev.h | 2 +-
 lib/librte_efd/rte_efd.c                | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/lib/librte_eal/common/eal_common_log.c b/lib/librte_eal/common/eal_common_log.c
index 4b2409a828..88a3e101d0 100644
--- a/lib/librte_eal/common/eal_common_log.c
+++ b/lib/librte_eal/common/eal_common_log.c
@@ -56,7 +56,7 @@ struct rte_logs rte_logs = {
 static FILE *default_log_stream;
 
 /**
- * This global structure stores some informations about the message
+ * This global structure stores some information about the message
  * that is currently being processed by one lcore
  */
 struct log_cur_msg {
diff --git a/lib/librte_eal/common/eal_hugepages.h b/lib/librte_eal/common/eal_hugepages.h
index 68369f2669..31d745d851 100644
--- a/lib/librte_eal/common/eal_hugepages.h
+++ b/lib/librte_eal/common/eal_hugepages.h
@@ -41,7 +41,7 @@
 #define MAX_HUGEPAGE_PATH PATH_MAX
 
 /**
- * Structure used to store informations about hugepages that we mapped
+ * Structure used to store information about hugepages that we mapped
  * through the files in hugetlbfs.
  */
 struct hugepage_file {
diff --git a/lib/librte_eal/common/include/rte_dev.h b/lib/librte_eal/common/include/rte_dev.h
index bc6e5926f5..6f21fde94d 100644
--- a/lib/librte_eal/common/include/rte_dev.h
+++ b/lib/librte_eal/common/include/rte_dev.h
@@ -281,7 +281,7 @@ __attribute__((used)) = str
  *   "pci:v8086:d*:sv*:sd*"  all PCI devices supported by this driver
  *                           whose vendor id is 0x8086.
  *
- * The format of the kernel modules list is a parenthesed expression
+ * The format of the kernel modules list is a parenthesized expression
  * containing logical-and (&) and logical-or (|).
  *
  * The device pattern and the kmod expression are separated by a space.
diff --git a/lib/librte_efd/rte_efd.c b/lib/librte_efd/rte_efd.c
index 34e0920980..f449180a95 100644
--- a/lib/librte_efd/rte_efd.c
+++ b/lib/librte_efd/rte_efd.c
@@ -208,7 +208,7 @@ struct efd_offline_group_rules {
 	/**< Array with all values of the keys of the group. */
 
 	uint8_t bin_id[EFD_MAX_GROUP_NUM_RULES];
-	/**< Stores the bin for each correspending key to
+	/**< Stores the bin for each corresponding key to
 	 * avoid having to recompute it
 	 */
 };
-- 
2.20.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2019-12-19 14:32:31.196313318 +0000
+++ 0122-lib-fix-doxygen-typos.patch	2019-12-19 14:32:26.321302108 +0000
@@ -1,8 +1,10 @@
-From baf023a8edfa70122c96eefa59a8bbd940d034bc Mon Sep 17 00:00:00 2001
+From ae1448029c443303ddd569c7fafa1258600ed5f8 Mon Sep 17 00:00:00 2001
 From: Kevin Traynor <ktraynor@redhat.com>
 Date: Wed, 13 Nov 2019 16:10:15 +0000
 Subject: [PATCH] lib: fix doxygen typos
 
+[ upstream commit baf023a8edfa70122c96eefa59a8bbd940d034bc ]
+
 Fix these as they are user visible. Found with codespell.
 
 Fixes: af75078fece3 ("first public release")
@@ -10,24 +12,21 @@
 Fixes: 0880c40113ef ("drivers: advertise kmod dependencies in pmdinfo")
 Fixes: 56b6ef874f80 ("efd: new Elastic Flow Distributor library")
 Fixes: 5a5f3178d4a8 ("power: return error when environment already set")
-Cc: stable@dpdk.org
 
 Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
 Reviewed-by: David Marchand <david.marchand@redhat.com>
 ---
  lib/librte_eal/common/eal_common_log.c  | 2 +-
  lib/librte_eal/common/eal_hugepages.h   | 2 +-
- lib/librte_eal/common/include/rte_bus.h | 2 +-
  lib/librte_eal/common/include/rte_dev.h | 2 +-
  lib/librte_efd/rte_efd.c                | 2 +-
- lib/librte_power/rte_power.h            | 2 +-
- 6 files changed, 6 insertions(+), 6 deletions(-)
+ 4 files changed, 4 insertions(+), 4 deletions(-)
 
 diff --git a/lib/librte_eal/common/eal_common_log.c b/lib/librte_eal/common/eal_common_log.c
-index e0a7bef034..c0efd5214f 100644
+index 4b2409a828..88a3e101d0 100644
 --- a/lib/librte_eal/common/eal_common_log.c
 +++ b/lib/librte_eal/common/eal_common_log.c
-@@ -45,7 +45,7 @@ static struct rte_eal_opt_loglevel_list opt_loglevel_list =
+@@ -56,7 +56,7 @@ struct rte_logs rte_logs = {
  static FILE *default_log_stream;
  
  /**
@@ -37,10 +36,10 @@
   */
  struct log_cur_msg {
 diff --git a/lib/librte_eal/common/eal_hugepages.h b/lib/librte_eal/common/eal_hugepages.h
-index 4582f19cfb..1b560d3379 100644
+index 68369f2669..31d745d851 100644
 --- a/lib/librte_eal/common/eal_hugepages.h
 +++ b/lib/librte_eal/common/eal_hugepages.h
-@@ -12,7 +12,7 @@
+@@ -41,7 +41,7 @@
  #define MAX_HUGEPAGE_PATH PATH_MAX
  
  /**
@@ -49,24 +48,11 @@
   * through the files in hugetlbfs.
   */
  struct hugepage_file {
-diff --git a/lib/librte_eal/common/include/rte_bus.h b/lib/librte_eal/common/include/rte_bus.h
-index d6a2494f68..d3034d0edf 100644
---- a/lib/librte_eal/common/include/rte_bus.h
-+++ b/lib/librte_eal/common/include/rte_bus.h
-@@ -364,7 +364,7 @@ struct rte_bus *rte_bus_find_by_name(const char *busname);
- 
- /**
-  * Get the common iommu class of devices bound on to buses available in the
-- * system. RTE_IOVA_DC means that no preferrence has been expressed.
-+ * system. RTE_IOVA_DC means that no preference has been expressed.
-  *
-  * @return
-  *     enum rte_iova_mode value.
 diff --git a/lib/librte_eal/common/include/rte_dev.h b/lib/librte_eal/common/include/rte_dev.h
-index c25e09e3d9..a5c35f00c0 100644
+index bc6e5926f5..6f21fde94d 100644
 --- a/lib/librte_eal/common/include/rte_dev.h
 +++ b/lib/librte_eal/common/include/rte_dev.h
-@@ -230,7 +230,7 @@ __attribute__((used)) = str
+@@ -281,7 +281,7 @@ __attribute__((used)) = str
   *   "pci:v8086:d*:sv*:sd*"  all PCI devices supported by this driver
   *                           whose vendor id is 0x8086.
   *
@@ -76,10 +62,10 @@
   *
   * The device pattern and the kmod expression are separated by a space.
 diff --git a/lib/librte_efd/rte_efd.c b/lib/librte_efd/rte_efd.c
-index d3d0195784..4deeb17924 100644
+index 34e0920980..f449180a95 100644
 --- a/lib/librte_efd/rte_efd.c
 +++ b/lib/librte_efd/rte_efd.c
-@@ -181,7 +181,7 @@ struct efd_offline_group_rules {
+@@ -208,7 +208,7 @@ struct efd_offline_group_rules {
  	/**< Array with all values of the keys of the group. */
  
  	uint8_t bin_id[EFD_MAX_GROUP_NUM_RULES];
@@ -88,19 +74,6 @@
  	 * avoid having to recompute it
  	 */
  };
-diff --git a/lib/librte_power/rte_power.h b/lib/librte_power/rte_power.h
-index 01f88588b5..427058b811 100644
---- a/lib/librte_power/rte_power.h
-+++ b/lib/librte_power/rte_power.h
-@@ -26,7 +26,7 @@ enum power_management_env {PM_ENV_NOT_SET, PM_ENV_ACPI_CPUFREQ, PM_ENV_KVM_VM,
- /**
-  * Set the default power management implementation. If this is not called prior
-  * to rte_power_init(), then auto-detect of the environment will take place.
-- * It is thread safe. New env can be set only in unitialized state
-+ * It is thread safe. New env can be set only in uninitialized state
-  * (thus rte_power_unset_env must be called if different env was already set).
-  *
-  * @param env
 -- 
 2.20.1