Skip to contentSkip to conversation

e1000e: Add desc after trailing whitespace

PATCH In review Baozhu Ni 2 participants 2 messages May 16, 2023

Subsystems (3)
lore
Share & tools
lore

Baozhu Ni

author
#0 lore raw

PATCH 1/1 e1000e: Add desc after trailing whitespace

./scripts/checkpatch.pl check error, so add description.

---
 drivers/net/ethernet/intel/e1000e/netdev.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/ethernet/intel/e1000e/netdev.c +1 -1
index 6f5c16aebcbf..cadeb5bc5e16 100644
@@ -4198,7 +4198,7 @@ void e1000e_reset(struct e1000_adapter *adapter)
 
 /**
  * e1000e_trigger_lsc - trigger an LSC interrupt
- * @adapter: 
+ * @adapter: board private structure
  *
  * Fire a link status change interrupt to start the watchdog.
  **/
Signature · 1 line
2.25.1
#1 lore raw
Quoted 3 lines · Baozhu Ni

./scripts/checkpatch.pl check error, so add description.

Hi,

this patch looks good.
But I think the subject and description could be a little clearer.

In my view the key is that, the adapter parameter is being documented in the kernel doc for the function.

Also, the target-tree, 'net-next' should be noted.

So perhaps:

Subject: [PATCH v2 net-next] e1000e: Add @adapter description to kdoc

Provide a description for the kernel doc of the @adapter parameter of e1000e_trigger_lsc().

Flagged by checkpatch.pl

Signed-off-by ...

When posting a v2, please wait 24h, as per the guidance here.

Quoted 9 lines
---
 drivers/net/ethernet/intel/e1000e/netdev.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/ethernet/intel/e1000e/netdev.c +0 -0
index 6f5c16aebcbf..cadeb5bc5e16 100644

drivers/net/ethernet/intel/e1000e/netdev.c void e1000e_reset(struct e1000_adapter *adapter) · line 4204

Quoted 8 lines
drivers/net/ethernet/intel/e1000e/netdev.c +1 -1
@@ -4198,7 +4198,7 @@ void e1000e_reset(struct e1000_adapter *adapter)
 
 /**
  * e1000e_trigger_lsc - trigger an LSC interrupt
- * @adapter: 
+ * @adapter: board private structure
  *
  * Fire a link status change interrupt to start the watchdog.
  **/

--
pw-bot: cr