On 10/22/2025 8:10 PM, Simon Horman wrote:
On Tue, Oct 21, 2025 at 11:40:55AM -0700, Alok Tiwari wrote:
...
diff --git a/drivers/net/ethernet/intel/idpf/idpf_singleq_txrx.c
b/drivers/net/ethernet/intel/idpf/idpf_singleq_txrx.c
index 61e613066140..ffc24a825129 100644
--- a/drivers/net/ethernet/intel/idpf/idpf_singleq_txrx.c
+++ b/drivers/net/ethernet/intel/idpf/idpf_singleq_txrx.c
@@ -1029,7 +1029,7 @@ static void idpf_xdp_run_pass(struct libeth_xdp_buff *xdp,
* @rx_q: rx queue to clean
* @budget: Total limit on number of packets to process
*
- * Returns true if there's any budget left (e.g. the clean is finished)
+ * Returns number of packets cleaned from this queue
Hi Alok,
Perhaps while this line is being updated it could
also be changed to use "Return:" or "Returns:".
Flagged by ./scripts/kernel-doc -none -Wall
*/
static int idpf_rx_singleq_clean(struct idpf_rx_queue *rx_q, int budget)
{
--
2.50.1
Thanks Simon,
It seems that this file, and almost the entire driver uses "Returns"
rather than "Returns:". In this case, it might be better to keep it
consistent with the existing style. or
Should we just update this file to use “Returns:” for consistency, or
would it be better to update the entire driver for consistency instead?
Thanks,
Alok
