[20/20] Remove use of term sanity check

Message ID 20230517161603.117728-21-stephen@networkplumber.org (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series Replace use of term sanity-check |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/github-robot: build fail github build: failed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-abi-testing warning Testing issues
ci/iol-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing fail Testing issues
ci/intel-Functional success Functional PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Stephen Hemminger May 17, 2023, 4:16 p.m. UTC
  Replace non-inclusive language with better comments.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 drivers/bus/fslmc/qbman/qbman_sys_decl.h  | 2 +-
 drivers/common/dpaax/caamflib/desc.h      | 2 +-
 drivers/dma/idxd/idxd_pci.c               | 2 +-
 drivers/net/bonding/rte_eth_bond_8023ad.c | 2 +-
 drivers/net/mvpp2/mrvl_qos.c              | 2 +-
 drivers/net/qede/qede_rxtx.c              | 6 +++---
 6 files changed, 8 insertions(+), 8 deletions(-)
  

Comments

Devendra Singh Rawat May 18, 2023, 9:21 a.m. UTC | #1
>-----Original Message-----
>From: Stephen Hemminger <stephen@networkplumber.org>
>Sent: Wednesday, May 17, 2023 9:46 PM
>To: dev@dpdk.org
>Cc: Stephen Hemminger <stephen@networkplumber.org>; Hemant Agrawal
><hemant.agrawal@nxp.com>; Sachin Saxena <sachin.saxena@nxp.com>; Bruce
>Richardson <bruce.richardson@intel.com>; Kevin Laatz
><kevin.laatz@intel.com>; Chas Williams <chas3@att.com>; Min Hu (Connor)
><humin29@huawei.com>; Liron Himi <lironh@marvell.com>; Devendra Singh
>Rawat <dsinghrawat@marvell.com>; Alok Prasad <palok@marvell.com>
>Subject: [EXT] [PATCH 20/20] Remove use of term sanity check
>
>External Email
>
>----------------------------------------------------------------------
>Replace non-inclusive language with better comments.
>
>Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
>---
> drivers/bus/fslmc/qbman/qbman_sys_decl.h  | 2 +-
> drivers/common/dpaax/caamflib/desc.h      | 2 +-
> drivers/dma/idxd/idxd_pci.c               | 2 +-
> drivers/net/bonding/rte_eth_bond_8023ad.c | 2 +-
> drivers/net/mvpp2/mrvl_qos.c              | 2 +-
> drivers/net/qede/qede_rxtx.c              | 6 +++---
> 6 files changed, 8 insertions(+), 8 deletions(-)
>
>diff --git a/drivers/bus/fslmc/qbman/qbman_sys_decl.h
>b/drivers/bus/fslmc/qbman/qbman_sys_decl.h
>index caaae417773c..2b6162d0ceaf 100644
>--- a/drivers/bus/fslmc/qbman/qbman_sys_decl.h
>+++ b/drivers/bus/fslmc/qbman/qbman_sys_decl.h
>@@ -9,7 +9,7 @@
> #include <compat.h>
> #include <fsl_qbman_base.h>
>
>-/* Sanity check */
>+/* Byte order check */
> #if (__BYTE_ORDER__ != __ORDER_BIG_ENDIAN__) && \
> 	(__BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__)  #error "Unknown
>endianness!"
>diff --git a/drivers/common/dpaax/caamflib/desc.h
>b/drivers/common/dpaax/caamflib/desc.h
>index 635d6bad071f..feb6a5d7bb2d 100644
>--- a/drivers/common/dpaax/caamflib/desc.h
>+++ b/drivers/common/dpaax/caamflib/desc.h
>@@ -107,7 +107,7 @@ extern enum rta_sec_era rta_sec_era;
>
> /*
>  * ONE - should always be set. Combination of ONE (always
>- * set) and ZRO (always clear) forms an endianness sanity check
>+ * set) and ZRO (always clear) forms an endianness check
>  */
> #define HDR_ONE			BIT(23)
> #define HDR_ZRO			BIT(15)
>diff --git a/drivers/dma/idxd/idxd_pci.c b/drivers/dma/idxd/idxd_pci.c index
>781fa02db3ca..a1e9b08940d9 100644
>--- a/drivers/dma/idxd/idxd_pci.c
>+++ b/drivers/dma/idxd/idxd_pci.c
>@@ -196,7 +196,7 @@ init_pci_device(struct rte_pci_device *dev, struct
>idxd_dmadev *idxd,
> 	pci->portals = dev->mem_resource[2].addr;
> 	pci->wq_cfg_sz = (pci->regs->wqcap >> 24) & 0x0F;
>
>-	/* sanity check device status */
>+	/* check device status */
> 	if (pci->regs->gensts & GENSTS_DEV_STATE_MASK) {
> 		/* need function-level-reset (FLR) or is enabled */
> 		IDXD_PMD_ERR("Device status is not disabled, cannot init"); diff
>--git a/drivers/net/bonding/rte_eth_bond_8023ad.c
>b/drivers/net/bonding/rte_eth_bond_8023ad.c
>index 4a266bb2caf1..56972f06c045 100644
>--- a/drivers/net/bonding/rte_eth_bond_8023ad.c
>+++ b/drivers/net/bonding/rte_eth_bond_8023ad.c
>@@ -1477,7 +1477,7 @@ bond_8023ad_setup_validate(uint16_t port_id,
> 		return -EINVAL;
>
> 	if (conf != NULL) {
>-		/* Basic sanity check */
>+		/* Basic input check */
> 		if (conf->slow_periodic_ms == 0 ||
> 				conf->fast_periodic_ms >= conf-
>>slow_periodic_ms ||
> 				conf->long_timeout_ms == 0 ||
>diff --git a/drivers/net/mvpp2/mrvl_qos.c b/drivers/net/mvpp2/mrvl_qos.c
>index f43217bc589c..db5052a9ab6f 100644
>--- a/drivers/net/mvpp2/mrvl_qos.c
>+++ b/drivers/net/mvpp2/mrvl_qos.c
>@@ -260,7 +260,7 @@ get_entry_values(const char *entry, uint8_t *tab,
> 			if (nb_rng_tokens != 2)
> 				return -3;
>
>-			/* Range and sanity checks. */
>+			/* Range and input checks. */
> 			if (get_val_securely(rng_tokens[0], &token_val) < 0)
> 				return -4;
> 			beg = (char)token_val;
>diff --git a/drivers/net/qede/qede_rxtx.c b/drivers/net/qede/qede_rxtx.c index
>c35585f5fdd6..a6da04cf361f 100644
>--- a/drivers/net/qede/qede_rxtx.c
>+++ b/drivers/net/qede/qede_rxtx.c
>@@ -1383,7 +1383,7 @@ qede_rx_process_tpa_end_cqe(struct qede_dev
>*qdev,
> 					     cqe->len_list[0]);
> 	/* Update total length and frags based on end TPA */
> 	rx_mb = rxq->tpa_info[cqe->tpa_agg_index].tpa_head;
>-	/* TODO:  Add Sanity Checks */
>+	/* TODO:  Add more checks */
> 	rx_mb->nb_segs = cqe->num_of_bds;
> 	rx_mb->pkt_len = cqe->total_packet_len;
>
>@@ -2211,7 +2211,7 @@ qede_xmit_prep_pkts(__rte_unused void *p_txq,
>struct rte_mbuf **tx_pkts,
>
> #ifdef RTE_LIBRTE_QEDE_DEBUG_TX
> static inline void
>-qede_mpls_tunn_tx_sanity_check(struct rte_mbuf *mbuf,
>+qede_mpls_tunn_tx_check(struct rte_mbuf *mbuf,
> 			       struct qede_tx_queue *txq)
> {
> 	if (((mbuf->outer_l2_len + mbuf->outer_l3_len) / 2) > 0xff) @@ -2473,7
>+2473,7 @@ qede_xmit_pkts(void *p_txq, struct rte_mbuf **tx_pkts, uint16_t
>nb_pkts)
>
>	RTE_MBUF_F_TX_TUNNEL_MPLSINUDP) {
> 				mplsoudp_flg = true;
> #ifdef RTE_LIBRTE_QEDE_DEBUG_TX
>-				qede_mpls_tunn_tx_sanity_check(mbuf, txq);
>+				qede_mpls_tunn_tx_check(mbuf, txq);
> #endif
> 				/* Outer L4 offset in two byte words */
> 				tunn_l4_hdr_start_offset =
>--
>2.39.2

For qede, replace 'sanity' with 'basic'.
  
Hemant Agrawal May 18, 2023, 10:24 a.m. UTC | #2
> -----Original Message-----
> From: Stephen Hemminger <stephen@networkplumber.org>
> Replace non-inclusive language with better comments.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
>  drivers/bus/fslmc/qbman/qbman_sys_decl.h  | 2 +-
>  drivers/common/dpaax/caamflib/desc.h      | 2 +-
>  drivers/dma/idxd/idxd_pci.c               | 2 +-
>  drivers/net/bonding/rte_eth_bond_8023ad.c | 2 +-
>  drivers/net/mvpp2/mrvl_qos.c              | 2 +-
>  drivers/net/qede/qede_rxtx.c              | 6 +++---
>  6 files changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/bus/fslmc/qbman/qbman_sys_decl.h
> b/drivers/bus/fslmc/qbman/qbman_sys_decl.h
> index caaae417773c..2b6162d0ceaf 100644
> --- a/drivers/bus/fslmc/qbman/qbman_sys_decl.h
> +++ b/drivers/bus/fslmc/qbman/qbman_sys_decl.h
> @@ -9,7 +9,7 @@
>  #include <compat.h>
>  #include <fsl_qbman_base.h>
> 
> -/* Sanity check */
> +/* Byte order check */
>  #if (__BYTE_ORDER__ != __ORDER_BIG_ENDIAN__) && \
>  	(__BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__)  #error "Unknown
> endianness!"
> diff --git a/drivers/common/dpaax/caamflib/desc.h
> b/drivers/common/dpaax/caamflib/desc.h
> index 635d6bad071f..feb6a5d7bb2d 100644
> --- a/drivers/common/dpaax/caamflib/desc.h
> +++ b/drivers/common/dpaax/caamflib/desc.h
> @@ -107,7 +107,7 @@ extern enum rta_sec_era rta_sec_era;
> 
>  /*
>   * ONE - should always be set. Combination of ONE (always
> - * set) and ZRO (always clear) forms an endianness sanity check
> + * set) and ZRO (always clear) forms an endianness check
>   */
>  #define HDR_ONE			BIT(23)
>  #define HDR_ZRO			BIT(15)

Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
  

Patch

diff --git a/drivers/bus/fslmc/qbman/qbman_sys_decl.h b/drivers/bus/fslmc/qbman/qbman_sys_decl.h
index caaae417773c..2b6162d0ceaf 100644
--- a/drivers/bus/fslmc/qbman/qbman_sys_decl.h
+++ b/drivers/bus/fslmc/qbman/qbman_sys_decl.h
@@ -9,7 +9,7 @@ 
 #include <compat.h>
 #include <fsl_qbman_base.h>
 
-/* Sanity check */
+/* Byte order check */
 #if (__BYTE_ORDER__ != __ORDER_BIG_ENDIAN__) && \
 	(__BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__)
 #error "Unknown endianness!"
diff --git a/drivers/common/dpaax/caamflib/desc.h b/drivers/common/dpaax/caamflib/desc.h
index 635d6bad071f..feb6a5d7bb2d 100644
--- a/drivers/common/dpaax/caamflib/desc.h
+++ b/drivers/common/dpaax/caamflib/desc.h
@@ -107,7 +107,7 @@  extern enum rta_sec_era rta_sec_era;
 
 /*
  * ONE - should always be set. Combination of ONE (always
- * set) and ZRO (always clear) forms an endianness sanity check
+ * set) and ZRO (always clear) forms an endianness check
  */
 #define HDR_ONE			BIT(23)
 #define HDR_ZRO			BIT(15)
diff --git a/drivers/dma/idxd/idxd_pci.c b/drivers/dma/idxd/idxd_pci.c
index 781fa02db3ca..a1e9b08940d9 100644
--- a/drivers/dma/idxd/idxd_pci.c
+++ b/drivers/dma/idxd/idxd_pci.c
@@ -196,7 +196,7 @@  init_pci_device(struct rte_pci_device *dev, struct idxd_dmadev *idxd,
 	pci->portals = dev->mem_resource[2].addr;
 	pci->wq_cfg_sz = (pci->regs->wqcap >> 24) & 0x0F;
 
-	/* sanity check device status */
+	/* check device status */
 	if (pci->regs->gensts & GENSTS_DEV_STATE_MASK) {
 		/* need function-level-reset (FLR) or is enabled */
 		IDXD_PMD_ERR("Device status is not disabled, cannot init");
diff --git a/drivers/net/bonding/rte_eth_bond_8023ad.c b/drivers/net/bonding/rte_eth_bond_8023ad.c
index 4a266bb2caf1..56972f06c045 100644
--- a/drivers/net/bonding/rte_eth_bond_8023ad.c
+++ b/drivers/net/bonding/rte_eth_bond_8023ad.c
@@ -1477,7 +1477,7 @@  bond_8023ad_setup_validate(uint16_t port_id,
 		return -EINVAL;
 
 	if (conf != NULL) {
-		/* Basic sanity check */
+		/* Basic input check */
 		if (conf->slow_periodic_ms == 0 ||
 				conf->fast_periodic_ms >= conf->slow_periodic_ms ||
 				conf->long_timeout_ms == 0 ||
diff --git a/drivers/net/mvpp2/mrvl_qos.c b/drivers/net/mvpp2/mrvl_qos.c
index f43217bc589c..db5052a9ab6f 100644
--- a/drivers/net/mvpp2/mrvl_qos.c
+++ b/drivers/net/mvpp2/mrvl_qos.c
@@ -260,7 +260,7 @@  get_entry_values(const char *entry, uint8_t *tab,
 			if (nb_rng_tokens != 2)
 				return -3;
 
-			/* Range and sanity checks. */
+			/* Range and input checks. */
 			if (get_val_securely(rng_tokens[0], &token_val) < 0)
 				return -4;
 			beg = (char)token_val;
diff --git a/drivers/net/qede/qede_rxtx.c b/drivers/net/qede/qede_rxtx.c
index c35585f5fdd6..a6da04cf361f 100644
--- a/drivers/net/qede/qede_rxtx.c
+++ b/drivers/net/qede/qede_rxtx.c
@@ -1383,7 +1383,7 @@  qede_rx_process_tpa_end_cqe(struct qede_dev *qdev,
 					     cqe->len_list[0]);
 	/* Update total length and frags based on end TPA */
 	rx_mb = rxq->tpa_info[cqe->tpa_agg_index].tpa_head;
-	/* TODO:  Add Sanity Checks */
+	/* TODO:  Add more checks */
 	rx_mb->nb_segs = cqe->num_of_bds;
 	rx_mb->pkt_len = cqe->total_packet_len;
 
@@ -2211,7 +2211,7 @@  qede_xmit_prep_pkts(__rte_unused void *p_txq, struct rte_mbuf **tx_pkts,
 
 #ifdef RTE_LIBRTE_QEDE_DEBUG_TX
 static inline void
-qede_mpls_tunn_tx_sanity_check(struct rte_mbuf *mbuf,
+qede_mpls_tunn_tx_check(struct rte_mbuf *mbuf,
 			       struct qede_tx_queue *txq)
 {
 	if (((mbuf->outer_l2_len + mbuf->outer_l3_len) / 2) > 0xff)
@@ -2473,7 +2473,7 @@  qede_xmit_pkts(void *p_txq, struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
 						RTE_MBUF_F_TX_TUNNEL_MPLSINUDP) {
 				mplsoudp_flg = true;
 #ifdef RTE_LIBRTE_QEDE_DEBUG_TX
-				qede_mpls_tunn_tx_sanity_check(mbuf, txq);
+				qede_mpls_tunn_tx_check(mbuf, txq);
 #endif
 				/* Outer L4 offset in two byte words */
 				tunn_l4_hdr_start_offset =