public inbox for dev@dpdk.org
 help / color / mirror / Atom feed
* [PATCH] lib: remove extra characters ending comment blocks
@ 2026-01-29 14:47 Thomas Monjalon
  2026-01-29 14:52 ` Morten Brørup
                   ` (2 more replies)
  0 siblings, 3 replies; 5+ messages in thread
From: Thomas Monjalon @ 2026-01-29 14:47 UTC (permalink / raw)
  To: dev
  Cc: Chengwen Feng, Nicolas Chautru, Mattias Rönnblom, Ori Kam,
	Andrew Rybchenko, Jerin Jacob, Amit Prakash Shukla,
	Vladimir Medvedkin, Kiran Kumar K, Nithin Dabilpuram, Zhirun Yan,
	Yipeng Wang, Sameh Gobriel, Bruce Richardson, Morten Brørup,
	Pavan Nikhilesh, Paul Szczepanek

At the end of a comment, no need for an extra line.

This pattern was fixed with the following command:
git ls lib | xargs sed -i '/^ *\* *$/{N;/ *\*\/ *$/D;}'

A comment should always be terminated with */

Extra asterisks were found with this command:
git grep '\* *\*/' lib

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 lib/argparse/rte_argparse.h              |  1 -
 lib/bbdev/rte_bbdev.h                    |  3 ---
 lib/eal/include/rte_bitset.h             |  1 -
 lib/ethdev/rte_flow.h                    |  1 -
 lib/eventdev/eventdev_pmd.h              |  4 ----
 lib/eventdev/rte_event_dma_adapter.h     |  1 -
 lib/eventdev/rte_eventdev.h              |  3 ---
 lib/fib/rte_fib.h                        |  2 +-
 lib/graph/rte_graph_feature_arc_worker.h |  1 -
 lib/hash/rte_hash_crc.c                  |  1 -
 lib/mempool/rte_mempool.h                |  5 ++---
 lib/node/rte_node_udp4_input_api.h       |  1 -
 lib/ptr_compress/rte_ptr_compress.h      | 16 ++++++++--------
 13 files changed, 11 insertions(+), 29 deletions(-)

diff --git a/lib/argparse/rte_argparse.h b/lib/argparse/rte_argparse.h
index 06df5b2b87..f184c9c37d 100644
--- a/lib/argparse/rte_argparse.h
+++ b/lib/argparse/rte_argparse.h
@@ -24,7 +24,6 @@
  * There are two ways to parse arguments:
  * 1) AutoSave: for which known value types, the way can be used.
  * 2) Callback: will invoke user callback to parse.
- *
  */
 
 #include <stdbool.h>
diff --git a/lib/bbdev/rte_bbdev.h b/lib/bbdev/rte_bbdev.h
index 4912bc7b6f..36dabf8fa6 100644
--- a/lib/bbdev/rte_bbdev.h
+++ b/lib/bbdev/rte_bbdev.h
@@ -1117,7 +1117,6 @@ rte_bbdev_enqueue_status_str(enum rte_bbdev_enqueue_status status);
  *   - 0 on success
  *   - ENOTSUP if interrupts are not supported by the identified device
  *   - negative value on failure - as returned from PMD
- *
  */
 __rte_experimental
 int
@@ -1141,7 +1140,6 @@ rte_bbdev_queue_ops_dump(uint16_t dev_id, uint16_t queue_index, FILE *file);
  *
  * @returns
  *   String describing the provided operation.
- *
  */
 __rte_experimental
 char *
@@ -1155,7 +1153,6 @@ rte_bbdev_ops_param_string(void *op, enum rte_bbdev_op_type op_type, char *str,
  *
  *  @param op_type
  *    Operation type enum.
- *
  */
 __rte_experimental
 void
diff --git a/lib/eal/include/rte_bitset.h b/lib/eal/include/rte_bitset.h
index 116121eec4..4e6d44874a 100644
--- a/lib/eal/include/rte_bitset.h
+++ b/lib/eal/include/rte_bitset.h
@@ -27,7 +27,6 @@
  * All functions modifying a bitset may overwrite any unused bits of
  * the last word. Such unused bits are ignored by all functions reading
  * bits.
- *
  */
 
 #include <limits.h>
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index 3d2ccdeb92..ba3bcc89a3 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -4274,7 +4274,6 @@ rte_flow_dynf_metadata_set(struct rte_mbuf *m, uint32_t v)
  * RTE_FLOW_ACTION_TYPE_JUMP_TO_TABLE_INDEX
  *
  * Redirects packets to a particular index in a flow table.
- *
  */
 struct rte_flow_action_jump_to_table_index {
 	struct rte_flow_template_table *table;
diff --git a/lib/eventdev/eventdev_pmd.h b/lib/eventdev/eventdev_pmd.h
index dda8ad82c9..d13cc433a7 100644
--- a/lib/eventdev/eventdev_pmd.h
+++ b/lib/eventdev/eventdev_pmd.h
@@ -1427,7 +1427,6 @@ typedef int (*eventdev_eth_tx_adapter_queue_stop)
  *   - 0: Success, driver provides event adapter capabilities for the
  *	dmadev.
  *   - <0: Error code returned by the driver function.
- *
  */
 typedef int (*eventdev_dma_adapter_caps_get_t)(const struct rte_eventdev *dev,
 					       const int16_t dma_dev_id, uint32_t *caps);
@@ -1454,7 +1453,6 @@ typedef int (*eventdev_dma_adapter_caps_get_t)(const struct rte_eventdev *dev,
  * @return
  *   - 0: Success, dmadev vchan added successfully.
  *   - <0: Error code returned by the driver function.
- *
  */
 typedef int (*eventdev_dma_adapter_vchan_add_t)(const struct rte_eventdev *dev,
 						const int16_t dma_dev_id,
@@ -1478,7 +1476,6 @@ typedef int (*eventdev_dma_adapter_vchan_add_t)(const struct rte_eventdev *dev,
  * @return
  *   - 0: Success, dmadev vchan deleted successfully.
  *   - <0: Error code returned by the driver function.
- *
  */
 typedef int (*eventdev_dma_adapter_vchan_del_t)(const struct rte_eventdev *dev,
 						const int16_t dma_dev_id,
@@ -1570,7 +1567,6 @@ typedef int (*eventdev_dma_adapter_stats_reset)(const struct rte_eventdev *dev,
  *
  * @return
  *   Return 0 on success.
- *
  */
 typedef int (*eventdev_vector_adapter_caps_get_t)(const struct rte_eventdev *dev, uint32_t *caps,
 						  const struct event_vector_adapter_ops **ops);
diff --git a/lib/eventdev/rte_event_dma_adapter.h b/lib/eventdev/rte_event_dma_adapter.h
index b442de0034..9e1d0bf40c 100644
--- a/lib/eventdev/rte_event_dma_adapter.h
+++ b/lib/eventdev/rte_event_dma_adapter.h
@@ -138,7 +138,6 @@
  * rte_event_dma_adapter_vchan_del() APIs. If HW supports the capability
  * RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_VCHAN_EV_BIND, event information must be passed to the
  * add API.
- *
  */
 
 #include <stdint.h>
diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
index 88c52a5520..4e13a38d89 100644
--- a/lib/eventdev/rte_eventdev.h
+++ b/lib/eventdev/rte_eventdev.h
@@ -1951,7 +1951,6 @@ rte_event_crypto_adapter_caps_get(uint8_t dev_id, uint8_t cdev_id,
  *   - 0: Success, driver provides event adapter capabilities for the
  *     dmadev device.
  *   - <0: Error code returned by the driver function.
- *
  */
 __rte_experimental
 int
@@ -2209,7 +2208,6 @@ rte_event_port_unlink(uint8_t dev_id, uint8_t port_id,
  * (EDQUOT) Quota exceeded(Application tried to link the queue configured with
  *  RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports)
  * (EINVAL) Invalid parameter
- *
  */
 __rte_experimental
 int
@@ -2262,7 +2260,6 @@ rte_event_port_profile_links_set(uint8_t dev_id, uint8_t port_id, const uint8_t
  * If return value is less than *nb_unlinks* then implementation shall update
  * the rte_errno accordingly, Possible rte_errno values are
  * (EINVAL) Invalid parameter
- *
  */
 __rte_experimental
 int
diff --git a/lib/fib/rte_fib.h b/lib/fib/rte_fib.h
index 874bf1688b..b16a653535 100644
--- a/lib/fib/rte_fib.h
+++ b/lib/fib/rte_fib.h
@@ -109,7 +109,7 @@ struct rte_fib_conf {
 			uint32_t	num_tbl8;
 		} dir24_8;
 	};
-	unsigned int flags; /**< Optional feature flags from RTE_FIB_F_* **/
+	unsigned int flags; /**< Optional feature flags from RTE_FIB_F_* */
 };
 
 /** FIB RCU QSBR configuration structure. */
diff --git a/lib/graph/rte_graph_feature_arc_worker.h b/lib/graph/rte_graph_feature_arc_worker.h
index 680b2ae8b8..93b87a1371 100644
--- a/lib/graph/rte_graph_feature_arc_worker.h
+++ b/lib/graph/rte_graph_feature_arc_worker.h
@@ -573,7 +573,6 @@ rte_graph_feature_data_first_feature_get(struct rte_graph_feature_arc *arc,
  * @return
  *  0: If no feature enabled
  *  Non-Zero: Bitmask of features enabled.
- *
  */
 __rte_experimental
 static __rte_always_inline uint64_t
diff --git a/lib/hash/rte_hash_crc.c b/lib/hash/rte_hash_crc.c
index 9fe90d6425..523be0bf92 100644
--- a/lib/hash/rte_hash_crc.c
+++ b/lib/hash/rte_hash_crc.c
@@ -26,7 +26,6 @@ uint8_t rte_hash_crc32_alg = CRC32_SW;
  *   - (CRC32_SSE42) Use SSE4.2 intrinsics if available
  *   - (CRC32_SSE42_x64) Use 64-bit SSE4.2 intrinsic if available (default x86)
  *   - (CRC32_ARM64) Use ARMv8 CRC intrinsic if available (default ARMv8)
- *
  */
 RTE_EXPORT_SYMBOL(rte_hash_crc_set_alg)
 void
diff --git a/lib/mempool/rte_mempool.h b/lib/mempool/rte_mempool.h
index aedc100964..1144dca58a 100644
--- a/lib/mempool/rte_mempool.h
+++ b/lib/mempool/rte_mempool.h
@@ -1955,7 +1955,7 @@ struct rte_mempool_mem_range_info {
  *   and whether these addresses are contiguous.
  * @return
  *   0 on success, -EINVAL if mempool is not valid or mem_range is NULL.
- **/
+ */
 __rte_experimental
 int
 rte_mempool_get_mem_range(const struct rte_mempool *mp,
@@ -1971,8 +1971,7 @@ rte_mempool_get_mem_range(const struct rte_mempool *mp,
  *   Pointer to a mempool.
  * @return
  *   Object alignment if mp is valid. 0 if mp is NULL.
- *
- **/
+ */
 __rte_experimental
 size_t
 rte_mempool_get_obj_alignment(const struct rte_mempool *mp);
diff --git a/lib/node/rte_node_udp4_input_api.h b/lib/node/rte_node_udp4_input_api.h
index 694660bd6a..c52dded337 100644
--- a/lib/node/rte_node_udp4_input_api.h
+++ b/lib/node/rte_node_udp4_input_api.h
@@ -14,7 +14,6 @@
  *
  * This API allows to control path functions of udp4_* nodes
  * like udp4_input.
- *
  */
 #include <rte_common.h>
 #include <rte_compat.h>
diff --git a/lib/ptr_compress/rte_ptr_compress.h b/lib/ptr_compress/rte_ptr_compress.h
index 231d96c518..908aefce14 100644
--- a/lib/ptr_compress/rte_ptr_compress.h
+++ b/lib/ptr_compress/rte_ptr_compress.h
@@ -52,7 +52,7 @@ extern "C" {
  *   Length of the memory region the pointers are constrained to.
  * @return
  *   Number of bits required to store a value.
- **/
+ */
 #define RTE_PTR_COMPRESS_BITS_NEEDED_FOR_POINTER_WITHIN_RANGE(mem_length) \
 	(((uint64_t)mem_length) < 2 ? 1 : \
 		(sizeof(uint64_t) * CHAR_BIT - \
@@ -66,7 +66,7 @@ extern "C" {
  *   Memory alignment.
  * @return
  *   Size of shift allowed without dropping any information from the pointer.
- **/
+ */
 #define RTE_PTR_COMPRESS_BIT_SHIFT_FROM_ALIGNMENT(alignment) \
 	((alignment) == 0 ? 0 : rte_ctz64((uint64_t)alignment))
 
@@ -81,7 +81,7 @@ extern "C" {
  *   The alignment of objects pointed to.
  * @return
  *   1 if function can be used, 0 otherwise.
- **/
+ */
 #define RTE_PTR_COMPRESS_CAN_COMPRESS_16_SHIFT(mem_length, obj_alignment) \
 	((RTE_PTR_COMPRESS_BITS_NEEDED_FOR_POINTER_WITHIN_RANGE(mem_length) - \
 	RTE_PTR_COMPRESS_BIT_SHIFT_FROM_ALIGNMENT(obj_alignment)) <= 16 ? 1 : 0)
@@ -97,7 +97,7 @@ extern "C" {
  *   The alignment of objects pointed to.
  * @return
  *   1 if function can be used, 0 otherwise.
- **/
+ */
 #define RTE_PTR_COMPRESS_CAN_COMPRESS_32_SHIFT(mem_length, obj_alignment) \
 	((RTE_PTR_COMPRESS_BITS_NEEDED_FOR_POINTER_WITHIN_RANGE(mem_length) - \
 	RTE_PTR_COMPRESS_BIT_SHIFT_FROM_ALIGNMENT(obj_alignment)) <= 32 ? 1 : 0)
@@ -124,7 +124,7 @@ extern "C" {
  *   Byte alignment of memory pointed to by the pointers allows for
  *   bits to be dropped from the offset and hence widen the memory region that
  *   can be covered. This controls how many bits are right shifted.
- **/
+ */
 static __rte_always_inline void
 rte_ptr_compress_32_shift(void *ptr_base, void * const *src_table,
 		uint32_t *dest_table, size_t n, uint8_t bit_shift)
@@ -185,7 +185,7 @@ rte_ptr_compress_32_shift(void *ptr_base, void * const *src_table,
  *   bits to be dropped from the offset and hence widen the memory region that
  *   can be covered. This controls how many bits are left shifted when pointers
  *   are recovered from the offsets.
- **/
+ */
 static __rte_always_inline void
 rte_ptr_decompress_32_shift(void *ptr_base, uint32_t const *src_table,
 		void **dest_table, size_t n, uint8_t bit_shift)
@@ -249,7 +249,7 @@ rte_ptr_decompress_32_shift(void *ptr_base, uint32_t const *src_table,
  *   Byte alignment of memory pointed to by the pointers allows for
  *   bits to be dropped from the offset and hence widen the memory region that
  *   can be covered. This controls how many bits are right shifted.
- **/
+ */
 static __rte_always_inline void
 rte_ptr_compress_16_shift(void *ptr_base, void * const *src_table,
 		uint16_t *dest_table, size_t n, uint8_t bit_shift)
@@ -293,7 +293,7 @@ rte_ptr_compress_16_shift(void *ptr_base, void * const *src_table,
  *   bits to be dropped from the offset and hence widen the memory region that
  *   can be covered. This controls how many bits are left shifted when pointers
  *   are recovered from the offsets.
- **/
+ */
 static __rte_always_inline void
 rte_ptr_decompress_16_shift(void *ptr_base, uint16_t const *src_table,
 		void **dest_table, size_t n, uint8_t bit_shift)
-- 
2.52.0


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* RE: [PATCH] lib: remove extra characters ending comment blocks
  2026-01-29 14:47 [PATCH] lib: remove extra characters ending comment blocks Thomas Monjalon
@ 2026-01-29 14:52 ` Morten Brørup
  2026-01-29 20:14 ` Stephen Hemminger
  2026-01-30  1:22 ` fengchengwen
  2 siblings, 0 replies; 5+ messages in thread
From: Morten Brørup @ 2026-01-29 14:52 UTC (permalink / raw)
  To: Thomas Monjalon, dev

Thank you for cleaning this up.

Reviewed-by: Morten Brørup <mb@smartsharesystems.com>

(I haven't looked for more; only reviewed the changes in this patch).


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] lib: remove extra characters ending comment blocks
  2026-01-29 14:47 [PATCH] lib: remove extra characters ending comment blocks Thomas Monjalon
  2026-01-29 14:52 ` Morten Brørup
@ 2026-01-29 20:14 ` Stephen Hemminger
  2026-02-04 20:34   ` Thomas Monjalon
  2026-01-30  1:22 ` fengchengwen
  2 siblings, 1 reply; 5+ messages in thread
From: Stephen Hemminger @ 2026-01-29 20:14 UTC (permalink / raw)
  To: Thomas Monjalon
  Cc: dev, Chengwen Feng, Nicolas Chautru, Mattias Rönnblom,
	Ori Kam, Andrew Rybchenko, Jerin Jacob, Amit Prakash Shukla,
	Vladimir Medvedkin, Kiran Kumar K, Nithin Dabilpuram, Zhirun Yan,
	Yipeng Wang, Sameh Gobriel, Bruce Richardson, Morten Brørup,
	Pavan Nikhilesh, Paul Szczepanek

On Thu, 29 Jan 2026 15:47:48 +0100
Thomas Monjalon <thomas@monjalon.net> wrote:

> At the end of a comment, no need for an extra line.
> 
> This pattern was fixed with the following command:
> git ls lib | xargs sed -i '/^ *\* *$/{N;/ *\*\/ *$/D;}'
> 
> A comment should always be terminated with */
> 
> Extra asterisks were found with this command:
> git grep '\* *\*/' lib
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: Stephen Hemminger <stephen@networkplumber.org>

Should look at examples and drivers as well.
Maybe add this to the AGENTS auto review script.

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] lib: remove extra characters ending comment blocks
  2026-01-29 14:47 [PATCH] lib: remove extra characters ending comment blocks Thomas Monjalon
  2026-01-29 14:52 ` Morten Brørup
  2026-01-29 20:14 ` Stephen Hemminger
@ 2026-01-30  1:22 ` fengchengwen
  2 siblings, 0 replies; 5+ messages in thread
From: fengchengwen @ 2026-01-30  1:22 UTC (permalink / raw)
  To: Thomas Monjalon, dev
  Cc: Nicolas Chautru, Mattias Rönnblom, Ori Kam, Andrew Rybchenko,
	Jerin Jacob, Amit Prakash Shukla, Vladimir Medvedkin,
	Kiran Kumar K, Nithin Dabilpuram, Zhirun Yan, Yipeng Wang,
	Sameh Gobriel, Bruce Richardson, Morten Brørup,
	Pavan Nikhilesh, Paul Szczepanek

Acked-by: Chengwen Feng <fengchengwen@huawei.com>

On 1/29/2026 10:47 PM, Thomas Monjalon wrote:
> At the end of a comment, no need for an extra line.
> 
> This pattern was fixed with the following command:
> git ls lib | xargs sed -i '/^ *\* *$/{N;/ *\*\/ *$/D;}'
> 
> A comment should always be terminated with */
> 
> Extra asterisks were found with this command:
> git grep '\* *\*/' lib
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] lib: remove extra characters ending comment blocks
  2026-01-29 20:14 ` Stephen Hemminger
@ 2026-02-04 20:34   ` Thomas Monjalon
  0 siblings, 0 replies; 5+ messages in thread
From: Thomas Monjalon @ 2026-02-04 20:34 UTC (permalink / raw)
  To: dev
  Cc: Chengwen Feng, Nicolas Chautru, Mattias Rönnblom, Ori Kam,
	Andrew Rybchenko, Jerin Jacob, Amit Prakash Shukla,
	Vladimir Medvedkin, Kiran Kumar K, Nithin Dabilpuram, Zhirun Yan,
	Yipeng Wang, Sameh Gobriel, Bruce Richardson, Morten Brørup,
	Pavan Nikhilesh, Paul Szczepanek, Stephen Hemminger

29/01/2026 21:14, Stephen Hemminger:
> On Thu, 29 Jan 2026 15:47:48 +0100
> Thomas Monjalon <thomas@monjalon.net> wrote:
> 
> > At the end of a comment, no need for an extra line.
> > 
> > This pattern was fixed with the following command:
> > git ls lib | xargs sed -i '/^ *\* *$/{N;/ *\*\/ *$/D;}'
> > 
> > A comment should always be terminated with */
> > 
> > Extra asterisks were found with this command:
> > git grep '\* *\*/' lib
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Acked-by: Stephen Hemminger <stephen@networkplumber.org>

Applied.



^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2026-02-04 20:34 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-01-29 14:47 [PATCH] lib: remove extra characters ending comment blocks Thomas Monjalon
2026-01-29 14:52 ` Morten Brørup
2026-01-29 20:14 ` Stephen Hemminger
2026-02-04 20:34   ` Thomas Monjalon
2026-01-30  1:22 ` fengchengwen

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox