lib: fix doxygen typos
authorKevin Traynor <ktraynor@redhat.com>
Wed, 13 Nov 2019 16:10:15 +0000 (16:10 +0000)
committerDavid Marchand <david.marchand@redhat.com>
Tue, 19 Nov 2019 21:03:38 +0000 (22:03 +0100)
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")
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
lib/librte_eal/common/eal_hugepages.h
lib/librte_eal/common/include/rte_bus.h
lib/librte_eal/common/include/rte_dev.h
lib/librte_efd/rte_efd.c
lib/librte_power/rte_power.h

index e0a7bef..c0efd52 100644 (file)
@@ -45,7 +45,7 @@ static struct rte_eal_opt_loglevel_list opt_loglevel_list =
 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 {
index 4582f19..1b560d3 100644 (file)
@@ -12,7 +12,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 {
index d6a2494..d3034d0 100644 (file)
@@ -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.
index c25e09e..a5c35f0 100644 (file)
@@ -230,7 +230,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.
index d3d0195..4deeb17 100644 (file)
@@ -181,7 +181,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
         */
 };
index 01f8858..427058b 100644 (file)
@@ -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