eal: remove plural syntax for single resource

Message ID 20210915143232.2994872-1-thomas@monjalon.net (mailing list archive)
State Superseded, archived
Headers
Series eal: remove plural syntax for single resource |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot: build success github build: passed
ci/iol-x86_64-unit-testing fail Testing issues
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing fail Testing issues

Commit Message

Thomas Monjalon Sept. 15, 2021, 2:32 p.m. UTC
  Some comments and logs about cores, nodes and pages
were using plural or hypotetic plural (s) form
even if preceded by "0" or "no".

It is replaced with singular form where appropriate.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 lib/eal/common/eal_common_lcore.c | 13 +++++++++----
 lib/eal/common/rte_malloc.c       |  4 ++--
 lib/eal/linux/eal_hugepage_info.c |  4 ++--
 lib/eal/linux/eal_memory.c        |  4 ++--
 4 files changed, 15 insertions(+), 10 deletions(-)
  

Comments

Bruce Richardson Sept. 15, 2021, 2:52 p.m. UTC | #1
On Wed, Sep 15, 2021 at 04:32:32PM +0200, Thomas Monjalon wrote:
> Some comments and logs about cores, nodes and pages
> were using plural or hypotetic plural (s) form
> even if preceded by "0" or "no".
> 
> It is replaced with singular form where appropriate.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  lib/eal/common/eal_common_lcore.c | 13 +++++++++----
>  lib/eal/common/rte_malloc.c       |  4 ++--
>  lib/eal/linux/eal_hugepage_info.c |  4 ++--
>  lib/eal/linux/eal_memory.c        |  4 ++--
>  4 files changed, 15 insertions(+), 10 deletions(-)
> 
> diff --git a/lib/eal/common/eal_common_lcore.c b/lib/eal/common/eal_common_lcore.c
> index 66d6bad1a7..6778ecc98f 100644
> --- a/lib/eal/common/eal_common_lcore.c
> +++ b/lib/eal/common/eal_common_lcore.c
> @@ -191,9 +191,12 @@ rte_eal_cpu_init(void)
>  	/* Set the count of enabled logical cores of the EAL configuration */
>  	config->lcore_count = count;
>  	RTE_LOG(DEBUG, EAL,
> -		"Support maximum %u logical core(s) by configuration.\n",
> -		RTE_MAX_LCORE);
> -	RTE_LOG(INFO, EAL, "Detected %u lcore(s)\n", config->lcore_count);
> +			"Support maximum %u logical core%s by configuration.\n",
> +			RTE_MAX_LCORE,
> +			RTE_MAX_LCORE > 1 ? "s" : "");
> +	RTE_LOG(INFO, EAL, "Detected %u lcore%s\n",
> +			config->lcore_count,
> +			config->lcore_count > 1 ? "s" : "");
>  

Personally, I'd take the view that these values are so unlikely to be ever
1, that I'd leave them always pluralized rather than add the complexity.

>  	/* sort all socket id's in ascending order */
>  	qsort(lcore_to_socket_id, RTE_DIM(lcore_to_socket_id),
> @@ -208,7 +211,9 @@ rte_eal_cpu_init(void)
>  					socket_id;
>  		prev_socket_id = socket_id;
>  	}
> -	RTE_LOG(INFO, EAL, "Detected %u NUMA nodes\n", config->numa_node_count);
> +	RTE_LOG(INFO, EAL, "Detected %u NUMA node%s\n",
> +			config->numa_node_count,
> +			config->numa_node_count > 1 ? "s" : "");
>  

Ok.
However, as a general suggestion, is it easier to sidestep all this
singular/plural decisions just by using "label: <value>" type syntax, e.g.
for here:
	"Detected NUMA nodes: 1"
When printed in such a form there is no expectation of singular ever being
used.

>  	return 0;
>  }
> diff --git a/lib/eal/common/rte_malloc.c b/lib/eal/common/rte_malloc.c
> index 9d39e58c08..04cbb0078b 100644
> --- a/lib/eal/common/rte_malloc.c
> +++ b/lib/eal/common/rte_malloc.c
> @@ -65,10 +65,10 @@ malloc_socket(const char *type, size_t size, unsigned int align,
>  	if (size == 0 || (align && !rte_is_power_of_2(align)))
>  		return NULL;
>  
> -	/* if there are no hugepages and if we are not allocating from an
> +	/* if there are no hugepage and if we are not allocating from an

This needs to be kept in the plural. Also applies to the instances below...

>  	 * external heap, use memory from any socket available. checking for
>  	 * socket being external may return -1 in case of invalid socket, but
> -	 * that's OK - if there are no hugepages, it doesn't matter.
> +	 * that's OK - if there are no hugepage, it doesn't matter.
>  	 */

<snip for brevity>
  

Patch

diff --git a/lib/eal/common/eal_common_lcore.c b/lib/eal/common/eal_common_lcore.c
index 66d6bad1a7..6778ecc98f 100644
--- a/lib/eal/common/eal_common_lcore.c
+++ b/lib/eal/common/eal_common_lcore.c
@@ -191,9 +191,12 @@  rte_eal_cpu_init(void)
 	/* Set the count of enabled logical cores of the EAL configuration */
 	config->lcore_count = count;
 	RTE_LOG(DEBUG, EAL,
-		"Support maximum %u logical core(s) by configuration.\n",
-		RTE_MAX_LCORE);
-	RTE_LOG(INFO, EAL, "Detected %u lcore(s)\n", config->lcore_count);
+			"Support maximum %u logical core%s by configuration.\n",
+			RTE_MAX_LCORE,
+			RTE_MAX_LCORE > 1 ? "s" : "");
+	RTE_LOG(INFO, EAL, "Detected %u lcore%s\n",
+			config->lcore_count,
+			config->lcore_count > 1 ? "s" : "");
 
 	/* sort all socket id's in ascending order */
 	qsort(lcore_to_socket_id, RTE_DIM(lcore_to_socket_id),
@@ -208,7 +211,9 @@  rte_eal_cpu_init(void)
 					socket_id;
 		prev_socket_id = socket_id;
 	}
-	RTE_LOG(INFO, EAL, "Detected %u NUMA nodes\n", config->numa_node_count);
+	RTE_LOG(INFO, EAL, "Detected %u NUMA node%s\n",
+			config->numa_node_count,
+			config->numa_node_count > 1 ? "s" : "");
 
 	return 0;
 }
diff --git a/lib/eal/common/rte_malloc.c b/lib/eal/common/rte_malloc.c
index 9d39e58c08..04cbb0078b 100644
--- a/lib/eal/common/rte_malloc.c
+++ b/lib/eal/common/rte_malloc.c
@@ -65,10 +65,10 @@  malloc_socket(const char *type, size_t size, unsigned int align,
 	if (size == 0 || (align && !rte_is_power_of_2(align)))
 		return NULL;
 
-	/* if there are no hugepages and if we are not allocating from an
+	/* if there are no hugepage and if we are not allocating from an
 	 * external heap, use memory from any socket available. checking for
 	 * socket being external may return -1 in case of invalid socket, but
-	 * that's OK - if there are no hugepages, it doesn't matter.
+	 * that's OK - if there are no hugepage, it doesn't matter.
 	 */
 	if (rte_malloc_heap_socket_is_external(socket_arg) != 1 &&
 				!rte_eal_has_hugepages())
diff --git a/lib/eal/linux/eal_hugepage_info.c b/lib/eal/linux/eal_hugepage_info.c
index d97792cade..5673784186 100644
--- a/lib/eal/linux/eal_hugepage_info.c
+++ b/lib/eal/linux/eal_hugepage_info.c
@@ -117,7 +117,7 @@  get_num_hugepages(const char *subdir, size_t sz)
 		over_pages = 0;
 
 	if (num_pages == 0 && over_pages == 0)
-		RTE_LOG(WARNING, EAL, "No available %zu kB hugepages reported\n",
+		RTE_LOG(WARNING, EAL, "No available %zu kB hugepage reported\n",
 				sz >> 10);
 
 	num_pages += over_pages;
@@ -158,7 +158,7 @@  get_num_hugepages_on_node(const char *subdir, unsigned int socket, size_t sz)
 		return 0;
 
 	if (num_pages == 0)
-		RTE_LOG(WARNING, EAL, "No free %zu kB hugepages reported on node %u\n",
+		RTE_LOG(WARNING, EAL, "No free %zu kB hugepage reported on node %u\n",
 				sz >> 10, socket);
 
 	/*
diff --git a/lib/eal/linux/eal_memory.c b/lib/eal/linux/eal_memory.c
index 03a4f2dd2d..d73d233a7d 100644
--- a/lib/eal/linux/eal_memory.c
+++ b/lib/eal/linux/eal_memory.c
@@ -1002,7 +1002,7 @@  remap_needed_hugepages(struct hugepage_file *hugepages, int n_pages)
 		cur = &hugepages[cur_page];
 		prev = cur_page == 0 ? NULL : &hugepages[cur_page - 1];
 
-		/* if size is zero, no more pages left */
+		/* if size is zero, no more page left */
 		if (cur->size == 0)
 			break;
 
@@ -1550,7 +1550,7 @@  eal_legacy_hugepage_attach(void)
 		struct rte_memseg_list *msl;
 		struct rte_memseg *ms;
 
-		/* if size is zero, no more pages left */
+		/* if size is zero, no more page left */
 		if (map_sz == 0)
 			break;