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>,
	Jerin Jacob <jerinj@marvell.com>,
	Kiran Kumar K <kirankumark@marvell.com>,
	Nithin Dabilpuram <ndabilpuram@marvell.com>,
	Reshma Pattan <reshma.pattan@intel.com>
Subject: [PATCH v3 05/19] lib: replace use of sanity check in comments and messages
Date: Fri, 19 May 2023 10:45:57 -0700	[thread overview]
Message-ID: <20230519174611.11232-6-stephen@networkplumber.org> (raw)
In-Reply-To: <20230519174611.11232-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>
---
 lib/graph/graph.c           | 2 +-
 lib/graph/graph_stats.c     | 2 +-
 lib/graph/node.c            | 2 +-
 lib/jobstats/rte_jobstats.c | 6 +++---
 lib/metrics/rte_metrics.c   | 2 +-
 lib/pcapng/rte_pcapng.c     | 2 +-
 6 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/lib/graph/graph.c b/lib/graph/graph.c
index 5582631b5301..597e9e7aa28e 100644
--- a/lib/graph/graph.c
+++ b/lib/graph/graph.c
@@ -283,7 +283,7 @@ rte_graph_create(const char *name, struct rte_graph_param *prm)
 
 	graph_spinlock_lock();
 
-	/* Check arguments sanity */
+	/* Check argument validity */
 	if (prm == NULL)
 		SET_ERR_JMP(EINVAL, fail, "Param should not be NULL");
 
diff --git a/lib/graph/graph_stats.c b/lib/graph/graph_stats.c
index c0140ba92212..28d5728e5e61 100644
--- a/lib/graph/graph_stats.c
+++ b/lib/graph/graph_stats.c
@@ -271,7 +271,7 @@ rte_graph_cluster_stats_create(const struct rte_graph_cluster_stats_param *prm)
 	const char *pattern;
 	rte_graph_t i;
 
-	/* Sanity checks */
+	/* Validate arguments */
 	if (!rte_graph_has_stats_feature())
 		SET_ERR_JMP(EINVAL, fail, "Stats feature is not enabled");
 
diff --git a/lib/graph/node.c b/lib/graph/node.c
index 149414dcd94c..3f0ae0c395db 100644
--- a/lib/graph/node.c
+++ b/lib/graph/node.c
@@ -68,7 +68,7 @@ __rte_node_register(const struct rte_node_register *reg)
 
 	graph_spinlock_lock();
 
-	/* Check sanity */
+	/* Check argument validity */
 	if (reg == NULL || reg->process == NULL) {
 		rte_errno = EINVAL;
 		goto fail;
diff --git a/lib/jobstats/rte_jobstats.c b/lib/jobstats/rte_jobstats.c
index af565a14eaf3..1c4b280c952a 100644
--- a/lib/jobstats/rte_jobstats.c
+++ b/lib/jobstats/rte_jobstats.c
@@ -124,7 +124,7 @@ rte_jobstats_start(struct rte_jobstats_context *ctx, struct rte_jobstats *job)
 {
 	uint64_t now;
 
-	/* Some sanity check. */
+	/* Check validity of arguments. */
 	if (unlikely(ctx == NULL || job == NULL || job->context != NULL))
 		return -EINVAL;
 
@@ -144,7 +144,7 @@ rte_jobstats_abort(struct rte_jobstats *job)
 	struct rte_jobstats_context *ctx;
 	uint64_t now, exec_time;
 
-	/* Some sanity check. */
+	/* Check that arguments are valid */
 	if (unlikely(job == NULL || job->context == NULL))
 		return -EINVAL;
 
@@ -165,7 +165,7 @@ rte_jobstats_finish(struct rte_jobstats *job, int64_t job_value)
 	uint64_t now, exec_time;
 	int need_update;
 
-	/* Some sanity check. */
+	/* Check arguments */
 	if (unlikely(job == NULL || job->context == NULL))
 		return -EINVAL;
 
diff --git a/lib/metrics/rte_metrics.c b/lib/metrics/rte_metrics.c
index 0ccdbabc04eb..f60d4f3f6e25 100644
--- a/lib/metrics/rte_metrics.c
+++ b/lib/metrics/rte_metrics.c
@@ -120,7 +120,7 @@ rte_metrics_reg_names(const char * const *names, uint16_t cnt_names)
 	uint16_t idx_name;
 	uint16_t idx_base;
 
-	/* Some sanity checks */
+	/* Some consistency checks */
 	if (cnt_names < 1 || names == NULL)
 		return -EINVAL;
 	for (idx_name = 0; idx_name < cnt_names; idx_name++)
diff --git a/lib/pcapng/rte_pcapng.c b/lib/pcapng/rte_pcapng.c
index 3c91fc77644a..fedf4b5b7f11 100644
--- a/lib/pcapng/rte_pcapng.c
+++ b/lib/pcapng/rte_pcapng.c
@@ -669,7 +669,7 @@ rte_pcapng_write_packets(rte_pcapng_t *self,
 		struct rte_mbuf *m = pkts[i];
 		struct pcapng_enhance_packet_block *epb;
 
-		/* sanity check that is really a pcapng mbuf */
+		/* Check that is really a pcapng mbuf */
 		epb = rte_pktmbuf_mtod(m, struct pcapng_enhance_packet_block *);
 		if (unlikely(epb->block_type != PCAPNG_ENHANCED_PACKET_BLOCK ||
 			     epb->block_length != rte_pktmbuf_data_len(m))) {
-- 
2.39.2


  parent reply	other threads:[~2023-05-19 17:46 UTC|newest]

Thread overview: 122+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-17 16:15 [PATCH 00/20] Replace use of term sanity-check Stephen Hemminger
2023-05-17 16:15 ` [PATCH 01/20] mbuf: replace term sanity check Stephen Hemminger
2023-05-17 22:58   ` Morten Brørup
2023-05-22  6:52   ` Andrew Rybchenko
2023-05-17 16:15 ` [PATCH 02/20] eal: replace use of sanity check in comments and messages Stephen Hemminger
2023-05-18 11:39   ` Burakov, Anatoly
2023-05-17 16:15 ` [PATCH 03/20] net/ring: replace use of sanity Stephen Hemminger
2023-05-17 16:15 ` [PATCH 04/20] test: replace use word sanity Stephen Hemminger
2023-05-17 16:15 ` [PATCH 05/20] examples: remove term sanity Stephen Hemminger
2023-05-17 16:15 ` [PATCH 06/20] lib: replace use of sanity check in comments and messages Stephen Hemminger
2023-05-17 16:15 ` [PATCH 07/20] net/nfp: remove word sanity Stephen Hemminger
2023-05-18  1:37   ` Chaoyong He
2023-05-17 16:15 ` [PATCH 08/20] doc/eventdev_pipeline: remove sanity Stephen Hemminger
2023-05-17 16:15 ` [PATCH 09/20] net/fm10k, net/ixgbe: remove word sanity Stephen Hemminger
2023-05-17 16:15 ` [PATCH 10/20] net/mlx[45]: " Stephen Hemminger
2023-05-17 16:15 ` [PATCH 11/20] net/sfc: remove term "sanity check" Stephen Hemminger
2023-05-22  6:53   ` Andrew Rybchenko
2023-05-17 16:15 ` [PATCH 12/20] net/ark: replace use of term sanity Stephen Hemminger
2023-05-17 16:15 ` [PATCH 13/20] net/bnxt: " Stephen Hemminger
2023-05-17 16:15 ` [PATCH 14/20] net/bnx2x: remove reference to sanity Stephen Hemminger
2023-05-17 16:15 ` [PATCH 15/20] cnxk: replace term sanity Stephen Hemminger
2023-05-17 16:15 ` [PATCH 16/20] event/opdl: remove " Stephen Hemminger
2023-05-17 16:16 ` [PATCH 17/20] net/txgbe: replace " Stephen Hemminger
2023-05-17 16:16 ` [PATCH 18/20] net/cxgbe: remove use of " Stephen Hemminger
2023-05-17 16:16 ` [PATCH 19/20] crypto/bcmfs: replace term sanity check Stephen Hemminger
2023-05-17 16:16 ` [PATCH 20/20] Remove use of " Stephen Hemminger
2023-05-18  9:21   ` [EXT] " Devendra Singh Rawat
2023-05-18 10:24   ` Hemant Agrawal
2023-05-17 22:05 ` [PATCH 00/20] Replace use of term sanity-check Tyler Retzlaff
2023-05-18 16:45 ` [PATCH v2 00/19] Replace use of the " Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 01/19] mbuf: replace term sanity check Stephen Hemminger
2023-05-18 16:52     ` Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 02/19] eal: replace use of sanity check in comments and messages Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 03/19] test: replace use word sanity Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 04/19] examples: remove term sanity Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 05/19] lib: replace use of sanity check in comments and messages Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 06/19] doc/eventdev_pipeline: remove sanity Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 07/19] net/ring: replace use of sanity Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 08/19] net/fm10k, net/ixgbe: remove word sanity Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 09/19] net/mlx[45]: " Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 10/19] net/sfc: remove term "sanity check" Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 11/19] net/ark: replace use of term sanity Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 12/19] net/bnxt: " Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 13/19] net/bnx2x: remove reference to sanity Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 14/19] cnxk: replace term sanity Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 15/19] event/opdl: remove " Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 16/19] net/txgbe: replace " Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 17/19] net/cxgbe: remove use of " Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 18/19] crypto/bcmfs: replace term sanity check Stephen Hemminger
2023-05-18 16:45   ` [PATCH v2 19/19] Remove use of " Stephen Hemminger
2023-05-19 17:45 ` [PATCH v3 00/19] Replace use "sanity check" Stephen Hemminger
2023-05-19 17:45   ` [PATCH v3 01/19] mbuf: replace term sanity check Stephen Hemminger
2023-05-20  7:08     ` Morten Brørup
2023-05-22  6:54     ` Andrew Rybchenko
2023-05-19 17:45   ` [PATCH v3 02/19] eal: replace use of sanity check in comments and messages Stephen Hemminger
2023-05-19 17:45   ` [PATCH v3 03/19] test: replace use word sanity Stephen Hemminger
2023-05-19 17:45   ` [PATCH v3 04/19] examples: remove term sanity Stephen Hemminger
2023-05-19 17:45   ` Stephen Hemminger [this message]
2023-05-19 17:45   ` [PATCH v3 06/19] doc/eventdev_pipeline: remove sanity Stephen Hemminger
2023-05-19 17:45   ` [PATCH v3 07/19] net/ring: replace use of sanity Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 08/19] net/fm10k, net/ixgbe: remove word sanity Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 09/19] net/mlx[45]: " Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 10/19] net/sfc: remove term "sanity check" Stephen Hemminger
2023-05-22  6:54     ` Andrew Rybchenko
2023-05-19 17:46   ` [PATCH v3 11/19] net/ark: replace use of term sanity Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 12/19] net/bnxt: " Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 13/19] net/bnx2x: remove reference to sanity Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 14/19] cnxk: replace term sanity Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 15/19] event/opdl: remove " Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 16/19] net/txgbe: replace " Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 17/19] net/cxgbe: remove use of " Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 18/19] crypto/bcmfs: replace term sanity check Stephen Hemminger
2023-05-19 17:46   ` [PATCH v3 19/19] Remove use of " Stephen Hemminger
2023-05-19 20:12   ` [PATCH v3 00/19] Replace use "sanity check" Ajit Khaparde
2023-08-02 23:25 ` [PATCH v4 00/19] replace use of term " Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 01/19] mbuf: replace term sanity check Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 02/19] eal: replace use of sanity check in comments and messages Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 03/19] test: replace use word sanity Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 04/19] examples: remove term sanity Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 05/19] lib: replace use of sanity check in comments and messages Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 06/19] doc/eventdev_pipeline: remove sanity Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 07/19] net/ring: replace use of sanity Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 08/19] net/fm10k, net/ixgbe: remove word sanity Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 09/19] net/mlx[45]: " Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 10/19] net/sfc: remove term "sanity check" Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 11/19] net/ark: replace use of term sanity Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 12/19] net/bnxt: " Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 13/19] net/bnx2x: remove reference to sanity Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 14/19] cnxk: replace term sanity Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 15/19] event/opdl: remove " Stephen Hemminger
2023-08-21 15:52     ` Liang Ma
2023-08-02 23:25   ` [PATCH v4 16/19] net/txgbe: replace " Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 17/19] net/cxgbe: remove use of " Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 18/19] crypto/bcmfs: replace term sanity check Stephen Hemminger
2023-08-02 23:25   ` [PATCH v4 19/19] drivers: remove use of " Stephen Hemminger
2023-08-03  3:13     ` [EXT] " Devendra Singh Rawat
2023-11-29 17:25   ` [PATCH v5 00/19] remove use of the term "sanity check" Stephen Hemminger
2023-11-29 17:25     ` [PATCH v5 01/19] mbuf: replace term sanity check Stephen Hemminger
2023-11-29 17:25     ` [PATCH v5 02/19] eal: replace use of sanity check in comments and messages Stephen Hemminger
2023-11-29 17:25     ` [PATCH v5 03/19] test: replace use word sanity Stephen Hemminger
2023-11-30  5:48       ` Hemant Agrawal
2023-11-29 17:25     ` [PATCH v5 04/19] examples: remove term sanity Stephen Hemminger
2023-11-29 17:25     ` [PATCH v5 05/19] lib: replace use of sanity check in comments and messages Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 06/19] doc/eventdev_pipeline: remove sanity Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 07/19] net/ring: replace use of sanity Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 08/19] net/fm10k, net/ixgbe: remove word sanity Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 09/19] net/mlx[45]: " Stephen Hemminger
2023-12-07  8:50       ` Dariusz Sosnowski
2023-11-29 17:26     ` [PATCH v5 10/19] net/sfc: remove term "sanity check" Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 11/19] net/ark: replace use of term sanity Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 12/19] net/bnxt: " Stephen Hemminger
2023-11-30  3:31       ` Somnath Kotur
2023-11-29 17:26     ` [PATCH v5 13/19] net/bnx2x: remove reference to sanity Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 14/19] cnxk: replace term sanity Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 15/19] event/opdl: remove " Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 16/19] net/txgbe: replace " Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 17/19] net/cxgbe: remove use of " Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 18/19] crypto/bcmfs: replace term sanity check Stephen Hemminger
2023-11-29 17:26     ` [PATCH v5 19/19] drivers: remove use of " Stephen Hemminger
2023-11-30  1:21       ` Chaoyong He
2023-11-30  2:14       ` [EXT] " Devendra Singh Rawat
2023-11-30  5:37         ` Hemant Agrawal

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=20230519174611.11232-6-stephen@networkplumber.org \
    --to=stephen@networkplumber.org \
    --cc=dev@dpdk.org \
    --cc=jerinj@marvell.com \
    --cc=kirankumark@marvell.com \
    --cc=ndabilpuram@marvell.com \
    --cc=reshma.pattan@intel.com \
    /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).