DPDK patches and discussions
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>,
	Anatoly Burakov <anatoly.burakov@intel.com>
Subject: [PATCH v11 2/7] eal: replace use of sanity check in comments and messages
Date: Thu,  1 Aug 2024 08:46:35 -0700	[thread overview]
Message-ID: <20240801154821.150443-3-stephen@networkplumber.org> (raw)
In-Reply-To: <20240801154821.150443-1-stephen@networkplumber.org>

Sanity check is on the Tier 2 non-inclusive list.
Replace or remove it.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
 lib/eal/common/eal_common_memory.c | 2 +-
 lib/eal/common/eal_common_proc.c   | 3 ++-
 lib/eal/common/eal_common_trace.c  | 2 +-
 lib/eal/common/eal_memcfg.h        | 2 +-
 lib/eal/common/rte_malloc.c        | 2 +-
 lib/eal/freebsd/eal.c              | 2 +-
 lib/eal/linux/eal.c                | 2 +-
 lib/eal/windows/eal.c              | 2 +-
 8 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/lib/eal/common/eal_common_memory.c b/lib/eal/common/eal_common_memory.c
index 60ddc30580..9f4a8676f1 100644
--- a/lib/eal/common/eal_common_memory.c
+++ b/lib/eal/common/eal_common_memory.c
@@ -562,7 +562,7 @@ check_dma_mask(uint8_t maskbits, bool thread_unsafe)
 	uint64_t mask;
 	int ret;
 
-	/* Sanity check. We only check width can be managed with 64 bits
+	/* We only check width can be managed with 64 bits
 	 * variables. Indeed any higher value is likely wrong. */
 	if (maskbits > MAX_DMA_MASK_BITS) {
 		EAL_LOG(ERR, "wrong dma mask size %u (Max: %u)",
diff --git a/lib/eal/common/eal_common_proc.c b/lib/eal/common/eal_common_proc.c
index d24093937c..838602edef 100644
--- a/lib/eal/common/eal_common_proc.c
+++ b/lib/eal/common/eal_common_proc.c
@@ -309,7 +309,8 @@ read_msg(int fd, struct mp_msg_internal *m, struct sockaddr_un *s)
 			break;
 		}
 	}
-	/* sanity-check the response */
+
+	/* Check that the response is valid */
 	if (m->msg.num_fds < 0 || m->msg.num_fds > RTE_MP_MAX_FD_NUM) {
 		EAL_LOG(ERR, "invalid number of fd's received");
 		return -1;
diff --git a/lib/eal/common/eal_common_trace.c b/lib/eal/common/eal_common_trace.c
index 918f49bf4f..9349f5780d 100644
--- a/lib/eal/common/eal_common_trace.c
+++ b/lib/eal/common/eal_common_trace.c
@@ -468,7 +468,7 @@ __rte_trace_point_register(rte_trace_point_t *handle, const char *name,
 	struct trace_point *tp;
 	uint16_t sz;
 
-	/* Sanity checks of arguments */
+	/* Check arguments */
 	if (name == NULL || register_fn == NULL || handle == NULL) {
 		trace_err("invalid arguments");
 		rte_errno = EINVAL;
diff --git a/lib/eal/common/eal_memcfg.h b/lib/eal/common/eal_memcfg.h
index 60e2089797..e8a85df355 100644
--- a/lib/eal/common/eal_memcfg.h
+++ b/lib/eal/common/eal_memcfg.h
@@ -18,7 +18,7 @@
  * Memory configuration shared across multiple processes.
  */
 struct rte_mem_config {
-	volatile uint32_t magic;   /**< Magic number - sanity check. */
+	volatile uint32_t magic;   /**< Magic number check. */
 	uint32_t version;
 	/**< Prevent secondary processes using different DPDK versions. */
 
diff --git a/lib/eal/common/rte_malloc.c b/lib/eal/common/rte_malloc.c
index 3eed4d4be6..c3a2069010 100644
--- a/lib/eal/common/rte_malloc.c
+++ b/lib/eal/common/rte_malloc.c
@@ -654,7 +654,7 @@ rte_malloc_heap_destroy(const char *heap_name)
 		ret = -1;
 		goto unlock;
 	}
-	/* sanity checks done, now we can destroy the heap */
+	/* checks done, now we can destroy the heap */
 	rte_spinlock_lock(&heap->lock);
 	ret = malloc_heap_destroy(heap);
 	rte_spinlock_unlock(&heap->lock);
diff --git a/lib/eal/freebsd/eal.c b/lib/eal/freebsd/eal.c
index 1229230063..c7cc6fa28b 100644
--- a/lib/eal/freebsd/eal.c
+++ b/lib/eal/freebsd/eal.c
@@ -501,7 +501,7 @@ eal_parse_args(int argc, char **argv)
 		goto out;
 	}
 
-	/* sanity checks */
+	/* options checks */
 	if (eal_check_common_options(internal_conf) != 0) {
 		eal_usage(prgname);
 		ret = -1;
diff --git a/lib/eal/linux/eal.c b/lib/eal/linux/eal.c
index d742cc98e2..254d071d12 100644
--- a/lib/eal/linux/eal.c
+++ b/lib/eal/linux/eal.c
@@ -803,7 +803,7 @@ eal_parse_args(int argc, char **argv)
 		goto out;
 	}
 
-	/* sanity checks */
+	/* options checks */
 	if (eal_check_common_options(internal_conf) != 0) {
 		eal_usage(prgname);
 		ret = -1;
diff --git a/lib/eal/windows/eal.c b/lib/eal/windows/eal.c
index 28b78a95a6..f6ef5b1470 100644
--- a/lib/eal/windows/eal.c
+++ b/lib/eal/windows/eal.c
@@ -194,7 +194,7 @@ eal_parse_args(int argc, char **argv)
 	if (eal_adjust_config(internal_conf) != 0)
 		return -1;
 
-	/* sanity checks */
+	/* options checks */
 	if (eal_check_common_options(internal_conf) != 0) {
 		eal_usage(prgname);
 		return -1;
-- 
2.43.0


  parent reply	other threads:[~2024-08-01 15:48 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-29 23:33 [PATCH v10 00/20] Remove use of noninclusive term sanity Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 01/20] mbuf: replace term sanity check Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 02/20] eal: replace use of sanity check in comments and messages Stephen Hemminger
2024-06-06  5:38   ` Morten Brørup
2024-05-29 23:33 ` [PATCH v10 03/20] test: replace use word sanity Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 04/20] examples: remove term sanity Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 05/20] lib: replace use of sanity check in comments and messages Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 06/20] doc/eventdev_pipeline: remove sanity Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 07/20] net/ring: replace use of sanity Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 08/20] net/fm10k, net/ixgbe: remove word sanity Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 09/20] net/mlx[45]: " Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 10/20] net/sfc: remove term "sanity check" Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 11/20] net/ark: replace use of term sanity Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 12/20] net/bnxt: " Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 13/20] net/bnx2x: remove reference to sanity Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 14/20] net/nfp: replace use of term sanity Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 15/20] net/txgbe: replace " Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 16/20] net/cxgbe: remove use of " Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 17/20] cnxk: replace " Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 18/20] event/opdl: remove " Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 19/20] crypto/bcmfs: replace term sanity check Stephen Hemminger
2024-05-29 23:33 ` [PATCH v10 20/20] drivers: remove use of " Stephen Hemminger
2024-08-01 15:46 ` [PATCH v11 0/7] Remove usage of wording " Stephen Hemminger
2024-08-01 15:46   ` [PATCH v11 1/7] mbuf: replace term " Stephen Hemminger
2024-08-01 15:46   ` Stephen Hemminger [this message]
2024-08-01 15:46   ` [PATCH v11 3/7] test: replace use word sanity Stephen Hemminger
2024-08-01 15:46   ` [PATCH v11 4/7] examples: remove term sanity Stephen Hemminger
2024-08-01 15:46   ` [PATCH v11 5/7] lib: replace use of sanity check in comments and messages Stephen Hemminger
2024-08-01 15:46   ` [PATCH v11 6/7] doc: remove sanity Stephen Hemminger
2024-08-01 15:46   ` [PATCH v11 7/7] drivers: remove use of term sanity check Stephen Hemminger

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240801154821.150443-3-stephen@networkplumber.org \
    --to=stephen@networkplumber.org \
    --cc=anatoly.burakov@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).