Skip to contentSkip to conversation

lib: fix log typos

PATCH New Kevin Traynor 2 participants 8 messages Nov 13, 2019 – Nov 20, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 lib: fix log typos

Found with codespell.

Fixes bacaa2754017 ("eal: add channel for multi-process communication")
Fixes f05e26051c15 ("eal: add IPC asynchronous request")
Fixes 0cbce3a167f1 ("vfio: skip DMA map failure if already mapped")
Fixes 445c6528b55f ("power: common interface for guest and host")
Fixes e6c6dc0f96c8 ("power: add p-state driver compatibility")
Fixes 8f972312b8f4 ("vhost: support vhost-user")

---
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]

---
 lib/librte_eal/common/eal_common_proc.c | 4 ++--
 lib/librte_eal/linux/eal/eal_vfio.c     | 4 ++--
 lib/librte_power/power_acpi_cpufreq.c   | 4 ++--
 lib/librte_power/power_pstate_cpufreq.c | 6 +++---
 lib/librte_vhost/socket.c               | 2 +-
 5 files changed, 10 insertions(+), 10 deletions(-)
lib/librte_eal/common/eal_common_proc.c +2 -2
index cbe8d10fc..935e8fefe 100644
@@ -284,5 +284,5 @@ read_msg(struct mp_msg_internal *m, struct sockaddr_un *s)
 
 	if (msglen != buflen || (msgh.msg_flags & (MSG_TRUNC | MSG_CTRUNC))) {
-		RTE_LOG(ERR, EAL, "truncted msg\n");
+		RTE_LOG(ERR, EAL, "truncated msg\n");
 		return -1;
 	}
@@ -1072,5 +1072,5 @@ rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
 
 	if (gettimeofday(&now, NULL) < 0) {
-		RTE_LOG(ERR, EAL, "Faile to get current time\n");
+		RTE_LOG(ERR, EAL, "Failed to get current time\n");
 		rte_errno = errno;
 		return -1;
lib/librte_eal/linux/eal/eal_vfio.c +2 -2
index 28e10cdc4..95f615c2e 100644
@@ -1295,5 +1295,5 @@ vfio_type1_dma_mem_map(int vfio_container_fd, uint64_t vaddr, uint64_t iova,
 			if (errno == EEXIST) {
 				RTE_LOG(DEBUG, EAL,
-					" Memory segment is allready mapped,"
+					" Memory segment is already mapped,"
 					" skipping");
 			} else {
@@ -1380,5 +1380,5 @@ vfio_spapr_dma_do_map(int vfio_container_fd, uint64_t vaddr, uint64_t iova,
 			if (errno == EBUSY) {
 				RTE_LOG(DEBUG, EAL,
-					" Memory segment is allready mapped,"
+					" Memory segment is already mapped,"
 					" skipping");
 			} else {
lib/librte_power/power_acpi_cpufreq.c +2 -2
index 7c386f891..22989244a 100644
@@ -31,5 +31,5 @@
 #define FOPEN_OR_ERR_RET(f, retval) do { \
 		if ((f) == NULL) { \
-			RTE_LOG(ERR, POWER, "File not openned\n"); \
+			RTE_LOG(ERR, POWER, "File not opened\n"); \
 			return retval; \
 		} \
@@ -110,5 +110,5 @@ set_freq_internal(struct rte_power_info *pi, uint32_t idx)
 		return 0;
 
-	POWER_DEBUG_TRACE("Freqency[%u] %u to be set for lcore %u\n",
+	POWER_DEBUG_TRACE("Frequency[%u] %u to be set for lcore %u\n",
 			idx, pi->freqs[idx], pi->lcore_id);
 	if (fseek(pi->f, 0, SEEK_SET) < 0) {
lib/librte_power/power_pstate_cpufreq.c +3 -3
index ecbcb3ac9..8f095e0ab 100644
@@ -34,5 +34,5 @@
 #define FOPEN_OR_ERR_RET(f, retval) do { \
 		if ((f) == NULL) { \
-			RTE_LOG(ERR, POWER, "File not openned\n"); \
+			RTE_LOG(ERR, POWER, "File not opened\n"); \
 			return retval; \
 		} \
@@ -288,5 +288,5 @@ set_freq_internal(struct pstate_power_info *pi, uint32_t idx)
 		}
 
-		POWER_DEBUG_TRACE("Freqency '%u' to be set for lcore %u\n",
+		POWER_DEBUG_TRACE("Frequency '%u' to be set for lcore %u\n",
 				  target_freq, pi->lcore_id);
 
@@ -311,5 +311,5 @@ set_freq_internal(struct pstate_power_info *pi, uint32_t idx)
 		}
 
-		POWER_DEBUG_TRACE("Freqency '%u' to be set for lcore %u\n",
+		POWER_DEBUG_TRACE("Frequency '%u' to be set for lcore %u\n",
 				  target_freq, pi->lcore_id);
 
lib/librte_vhost/socket.c +1 -1
index a34bc7f9a..ebb2ff6c2 100644
@@ -133,5 +133,5 @@ read_fd_message(int sockfd, char *buf, int buflen, int *fds, int max_fds,
 
 	if (msgh.msg_flags & (MSG_TRUNC | MSG_CTRUNC)) {
-		RTE_LOG(ERR, VHOST_CONFIG, "truncted msg\n");
+		RTE_LOG(ERR, VHOST_CONFIG, "truncated msg\n");
 		return -1;
 	}
Signature · 1 line
2.21.0
#1 lore raw

PATCH v2 1/2 lib: fix log typos

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

Fixes bacaa2754017 ("eal: add channel for multi-process communication")
Fixes f05e26051c15 ("eal: add IPC asynchronous request")
Fixes 0cbce3a167f1 ("vfio: skip DMA map failure if already mapped")
Fixes 445c6528b55f ("power: common interface for guest and host")
Fixes e6c6dc0f96c8 ("power: add p-state driver compatibility")
Fixes 8f972312b8f4 ("vhost: support vhost-user")

---
v2: fix checkpatch fail

---
 lib/librte_eal/common/eal_common_proc.c | 4 ++--
 lib/librte_eal/linux/eal/eal_vfio.c     | 4 ++--
 lib/librte_power/power_acpi_cpufreq.c   | 4 ++--
 lib/librte_power/power_pstate_cpufreq.c | 6 +++---
 lib/librte_vhost/socket.c               | 2 +-
 5 files changed, 10 insertions(+), 10 deletions(-)
lib/librte_eal/common/eal_common_proc.c +2 -2
index cbe8d10fc..935e8fefe 100644
@@ -284,5 +284,5 @@ read_msg(struct mp_msg_internal *m, struct sockaddr_un *s)
 
 	if (msglen != buflen || (msgh.msg_flags & (MSG_TRUNC | MSG_CTRUNC))) {
-		RTE_LOG(ERR, EAL, "truncted msg\n");
+		RTE_LOG(ERR, EAL, "truncated msg\n");
 		return -1;
 	}
@@ -1072,5 +1072,5 @@ rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
 
 	if (gettimeofday(&now, NULL) < 0) {
-		RTE_LOG(ERR, EAL, "Faile to get current time\n");
+		RTE_LOG(ERR, EAL, "Failed to get current time\n");
 		rte_errno = errno;
 		return -1;
lib/librte_eal/linux/eal/eal_vfio.c +2 -2
index 28e10cdc4..95f615c2e 100644
@@ -1295,5 +1295,5 @@ vfio_type1_dma_mem_map(int vfio_container_fd, uint64_t vaddr, uint64_t iova,
 			if (errno == EEXIST) {
 				RTE_LOG(DEBUG, EAL,
-					" Memory segment is allready mapped,"
+					" Memory segment is already mapped,"
 					" skipping");
 			} else {
@@ -1380,5 +1380,5 @@ vfio_spapr_dma_do_map(int vfio_container_fd, uint64_t vaddr, uint64_t iova,
 			if (errno == EBUSY) {
 				RTE_LOG(DEBUG, EAL,
-					" Memory segment is allready mapped,"
+					" Memory segment is already mapped,"
 					" skipping");
 			} else {
lib/librte_power/power_acpi_cpufreq.c +2 -2
index 7c386f891..22989244a 100644
@@ -31,5 +31,5 @@
 #define FOPEN_OR_ERR_RET(f, retval) do { \
 		if ((f) == NULL) { \
-			RTE_LOG(ERR, POWER, "File not openned\n"); \
+			RTE_LOG(ERR, POWER, "File not opened\n"); \
 			return retval; \
 		} \
@@ -110,5 +110,5 @@ set_freq_internal(struct rte_power_info *pi, uint32_t idx)
 		return 0;
 
-	POWER_DEBUG_TRACE("Freqency[%u] %u to be set for lcore %u\n",
+	POWER_DEBUG_TRACE("Frequency[%u] %u to be set for lcore %u\n",
 			idx, pi->freqs[idx], pi->lcore_id);
 	if (fseek(pi->f, 0, SEEK_SET) < 0) {
lib/librte_power/power_pstate_cpufreq.c +3 -3
index ecbcb3ac9..8f095e0ab 100644
@@ -34,5 +34,5 @@
 #define FOPEN_OR_ERR_RET(f, retval) do { \
 		if ((f) == NULL) { \
-			RTE_LOG(ERR, POWER, "File not openned\n"); \
+			RTE_LOG(ERR, POWER, "File not opened\n"); \
 			return retval; \
 		} \
@@ -288,5 +288,5 @@ set_freq_internal(struct pstate_power_info *pi, uint32_t idx)
 		}
 
-		POWER_DEBUG_TRACE("Freqency '%u' to be set for lcore %u\n",
+		POWER_DEBUG_TRACE("Frequency '%u' to be set for lcore %u\n",
 				  target_freq, pi->lcore_id);
 
@@ -311,5 +311,5 @@ set_freq_internal(struct pstate_power_info *pi, uint32_t idx)
 		}
 
-		POWER_DEBUG_TRACE("Freqency '%u' to be set for lcore %u\n",
+		POWER_DEBUG_TRACE("Frequency '%u' to be set for lcore %u\n",
 				  target_freq, pi->lcore_id);
 
lib/librte_vhost/socket.c +1 -1
index a34bc7f9a..ebb2ff6c2 100644
@@ -133,5 +133,5 @@ read_fd_message(int sockfd, char *buf, int buflen, int *fds, int max_fds,
 
 	if (msgh.msg_flags & (MSG_TRUNC | MSG_CTRUNC)) {
-		RTE_LOG(ERR, VHOST_CONFIG, "truncted msg\n");
+		RTE_LOG(ERR, VHOST_CONFIG, "truncated msg\n");
 		return -1;
 	}
Signature · 1 line
2.21.0
#2 lore raw

PATCH v2 2/2 lib: fix Doxygen typos

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")

---
v2: fix checkpatch fail

---
 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(-)
lib/librte_eal/common/eal_common_log.c +1 -1
index e0a7bef03..c0efd5214 100644
@@ -46,5 +46,5 @@ 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
  */
lib/librte_eal/common/eal_hugepages.h +1 -1
index 4582f19cf..1b560d337 100644
@@ -13,5 +13,5 @@
 
 /**
- * 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.
  */
lib/librte_eal/common/include/rte_bus.h +1 -1
index d6a2494f6..d3034d0ed 100644
@@ -365,5 +365,5 @@ 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
lib/librte_eal/common/include/rte_dev.h +1 -1
index c25e09e3d..a5c35f00c 100644
@@ -231,5 +231,5 @@ __attribute__((used)) = str
  *                           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 (|).
  *
lib/librte_efd/rte_efd.c +1 -1
index d3d019578..4deeb1792 100644
@@ -182,5 +182,5 @@ struct efd_offline_group_rules {
 
 	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
 	 */
lib/librte_power/rte_power.h +1 -1
index 01f88588b..427058b81 100644
@@ -27,5 +27,5 @@ 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).
  *
Signature · 1 line
2.21.0
Reviewed-by on v2 1/2 Applied
#3 lore raw
In reply to Kevin Traynor
Quoted 11 lines · Kevin Traynor

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

Fixes bacaa2754017 ("eal: add channel for multi-process communication")
Fixes f05e26051c15 ("eal: add IPC asynchronous request")
Fixes 0cbce3a167f1 ("vfio: skip DMA map failure if already mapped")
Fixes 445c6528b55f ("power: common interface for guest and host")
Fixes e6c6dc0f96c8 ("power: add p-state driver compatibility")
Fixes 8f972312b8f4 ("vhost: support vhost-user")
Quoted 1 line

For the series,

It would be nice to have codespell in devtools/checkpatches.sh.

Applied, thanks.

--
David Marchand

#4 lore raw
Quoted 12 lines · David Marchand
Quoted 11 lines · Kevin Traynor

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

Fixes bacaa2754017 ("eal: add channel for multi-process communication")
Fixes f05e26051c15 ("eal: add IPC asynchronous request")
Fixes 0cbce3a167f1 ("vfio: skip DMA map failure if already mapped")
Fixes 445c6528b55f ("power: common interface for guest and host")
Fixes e6c6dc0f96c8 ("power: add p-state driver compatibility")
Fixes 8f972312b8f4 ("vhost: support vhost-user")
Quoted 7 lines
Quoted 1 line

For the series,

It would be nice to have codespell in devtools/checkpatches.sh.

Voila!
https://git.dpdk.org/dpdk/commit/devtools/checkpatches.sh?id=abdd314151b304eeab08528555e884544151a2e4

Maybe we should add some doc to the contributors guide for it. It seems to be run by one of the robots anyway.

Quoted 6 lines

Applied, thanks.

--
David Marchand

#5 lore raw
Quoted 16 lines · Kevin Traynor
Quoted 14 lines · David Marchand
Quoted 12 lines · Kevin Traynor

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

Fixes bacaa2754017 ("eal: add channel for multi-process communication")
Fixes f05e26051c15 ("eal: add IPC asynchronous request")
Fixes 0cbce3a167f1 ("vfio: skip DMA map failure if already mapped")
Fixes 445c6528b55f ("power: common interface for guest and host")
Fixes e6c6dc0f96c8 ("power: add p-state driver compatibility")
Fixes 8f972312b8f4 ("vhost: support vhost-user")
Quoted 7 lines
Quoted 5 lines

For the series,

It would be nice to have codespell in devtools/checkpatches.sh.

Voila!

"Voilà !" :-)

Quoted 1 line

https://git.dpdk.org/dpdk/commit/devtools/checkpatches.sh?id=abdd314151b304eeab08528555e884544151a2e4

Arf, right.

Quoted 2 lines

Maybe we should add some doc to the contributors guide for it. It seems to be run by one of the robots anyway.

It is enabled by default.

It does catch "informations".

But it does not pick, for example, my typo on "preferrence" (no excuse, in French, it takes only one r too).

Did you use https://github.com/codespell-project/codespell/blob/master/codespell_lib/data/dictionary.txt
?
Not sure the robots are using the latest version.

--
David Marchand

#6 lore raw
Quoted 29 lines · David Marchand
Quoted 16 lines · Kevin Traynor
Quoted 14 lines · David Marchand
Quoted 12 lines · Kevin Traynor

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

Fixes bacaa2754017 ("eal: add channel for multi-process communication")
Fixes f05e26051c15 ("eal: add IPC asynchronous request")
Fixes 0cbce3a167f1 ("vfio: skip DMA map failure if already mapped")
Fixes 445c6528b55f ("power: common interface for guest and host")
Fixes e6c6dc0f96c8 ("power: add p-state driver compatibility")
Fixes 8f972312b8f4 ("vhost: support vhost-user")
Quoted 7 lines
Quoted 5 lines

For the series,

It would be nice to have codespell in devtools/checkpatches.sh.

Voila!

"Voilà !" :-)

Quoted 1 line

https://git.dpdk.org/dpdk/commit/devtools/checkpatches.sh?id=abdd314151b304eeab08528555e884544151a2e4

Quoted 8 lines

Arf, right.

Quoted 2 lines

Maybe we should add some doc to the contributors guide for it. It seems to be run by one of the robots anyway.

It is enabled by default.

Well, enabled by default if someone has the dictionary and set the variable, so not really /that/ default.
Sent doc patch https://patchwork.dpdk.org/patch/63162/

Quoted 7 lines

It does catch "informations".

But it does not pick, for example, my typo on "preferrence" (no excuse, in French, it takes only one r too).

Did you use https://github.com/codespell-project/codespell/blob/master/codespell_lib/data/dictionary.txt
?

Yes, I used the latest upstream dictionary at the time.

Quoted 6 lines

Not sure the robots are using the latest version.

--
David Marchand

#7 lore raw

PATCH 2/2 lib: fix Doxygen typos

In reply to Kevin Traynor

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: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]

---
 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(-)
lib/librte_eal/common/eal_common_log.c +1 -1
index e0a7bef03..c0efd5214 100644
@@ -46,5 +46,5 @@ 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
  */
lib/librte_eal/common/eal_hugepages.h +1 -1
index 4582f19cf..1b560d337 100644
@@ -13,5 +13,5 @@
 
 /**
- * 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.
  */
lib/librte_eal/common/include/rte_bus.h +1 -1
index d6a2494f6..d3034d0ed 100644
@@ -365,5 +365,5 @@ 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
lib/librte_eal/common/include/rte_dev.h +1 -1
index c25e09e3d..a5c35f00c 100644
@@ -231,5 +231,5 @@ __attribute__((used)) = str
  *                           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 (|).
  *
lib/librte_efd/rte_efd.c +1 -1
index d3d019578..4deeb1792 100644
@@ -182,5 +182,5 @@ struct efd_offline_group_rules {
 
 	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
 	 */
lib/librte_power/rte_power.h +1 -1
index 01f88588b..a403a58fc 100644
@@ -27,5 +27,5 @@ 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 unintialized state
  * (thus rte_power_unset_env must be called if different env was already set).
  *
Signature · 1 line
2.21.0