From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id AFBA142FBA;
Thu, 3 Aug 2023 01:26:38 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 7B7844325F;
Thu, 3 Aug 2023 01:26:10 +0200 (CEST)
Received: from mail-pl1-f174.google.com (mail-pl1-f174.google.com
[209.85.214.174])
by mails.dpdk.org (Postfix) with ESMTP id E8DCC4325A
for <dev@dpdk.org>; Thu, 3 Aug 2023 01:26:06 +0200 (CEST)
Received: by mail-pl1-f174.google.com with SMTP id
d9443c01a7336-1bbf8cb694aso3742545ad.3
for <dev@dpdk.org>; Wed, 02 Aug 2023 16:26:06 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=networkplumber-org.20221208.gappssmtp.com; s=20221208; t=1691018766;
x=1691623566;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=GMLSKXVHoMEdQGRFjapYtPaYQrJhjwhWu2CxlPGiTRU=;
b=ftUQEOimjDnCsWkW5vDQh26yGmeQz3fvQu7QO817el1VgECSbeFzAfvEj4935a4wtq
RpLcchPcRPhma1n1nwCbb+rNYJ8sFAGamxPZAUpVrxTDgmWrCIduLGr5GbnMXkuMKnQv
p/cPpwf59XabKR5zJtGEVSF99BA6WqaYuBqp8XDLdSSOOn+pYEoeZci46Vi4kVsNLLy5
BwDtNW7UbG9jMTB34P3FjfDCi2TLbz7vjtxyKegoIDwfC3EvJccmaA+rsvZeOu7EbD1Y
CNAHqp+40/V2HyMaAidFrHj5/i+GSVMsHV6crBTDn+NspIRHV5qpytr1exflM+25NxVw
2Org==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20221208; t=1691018766; x=1691623566;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=GMLSKXVHoMEdQGRFjapYtPaYQrJhjwhWu2CxlPGiTRU=;
b=AE5kArVwntfGElb3+kxW5sGRAsOXPdCAk2nngjCPYAwFvEz4DAmTsH93ckYJqHbyDL
xfPAX7jJEuY7dXJosSQuLydUPkG0IpHkdXM1hq+8dUzS8/Dx9GQtkbBqrC8i1Fgn+xff
uYaxKFksqCjDKw+Zjzqc6vj70miH2EIqS36Bf6SHdOGUxF9wIQzjV/Umlaj0bZNsFJYh
uJ25100kWcu2rveVFYFs+sTOyyFVczXcc4+jbEe1DGXKbotRmhLwtkywPjptgulniLpB
ehSVgEJ28qEKWc0mnWf8bocMqnBhjC3lTGrh73zVyDLf7aAOLYayD+xA/s1ieljLYsyK
ZCNQ==
X-Gm-Message-State: ABy/qLYMp0+uLQuOINoQXzqmH9h2gFxvhilbfLZV+jUHJgfvJs9YauJJ
ZR5WKIWr50GvCvtGvEcWxQXKJhsRF9xz9bTuwmASug==
X-Google-Smtp-Source: APBJJlGgLyzxlR+Nbx+zNAQpIMYaXZd+MpHMsmDWgnulN6hVxqglM1GHNwdiEn/s59YDS1lGekFPyw==
X-Received: by 2002:a17:902:e542:b0:1b8:4f93:b210 with SMTP id
n2-20020a170902e54200b001b84f93b210mr21222301plf.45.1691018765950;
Wed, 02 Aug 2023 16:26:05 -0700 (PDT)
Received: from hermes.local (204-195-127-207.wavecable.com. [204.195.127.207])
by smtp.gmail.com with ESMTPSA id
jd20-20020a170903261400b001b8b0ac2258sm12960870plb.174.2023.08.02.16.26.05
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Wed, 02 Aug 2023 16:26:05 -0700 (PDT)
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>,
Zhirun Yan <zhirun.yan@intel.com>, Reshma Pattan <reshma.pattan@intel.com>
Subject: [PATCH v4 05/19] lib: replace use of sanity check in comments and
messages
Date: Wed, 2 Aug 2023 16:25:36 -0700
Message-Id: <20230802232550.125487-6-stephen@networkplumber.org>
X-Mailer: git-send-email 2.39.2
In-Reply-To: <20230802232550.125487-1-stephen@networkplumber.org>
References: <20230517161603.117728-1-stephen@networkplumber.org>
<20230802232550.125487-1-stephen@networkplumber.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.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 26f0968a978d..e51dcc30568e 100644
--- a/lib/graph/graph.c
+++ b/lib/graph/graph.c
@@ -344,7 +344,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 cc32245c0593..cfb30ae07497 100644
--- a/lib/graph/graph_stats.c
+++ b/lib/graph/graph_stats.c
@@ -317,7 +317,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 99a962277964..c238d140ed31 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