e1000e: Add @adapter description to kdoc

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

Subsystems (3)

Networking Network drivers Intel Ethernet

lore

Share & tools

lore

Baozhu Ni

author

2023-05-17 01:27 UTC #0 lore raw

PATCH v2 1/1 e1000e: Add @adapter description to kdoc

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

Signed-off-by Baozhu Ni <[email protected]>

---
v2:
- let the subject and description clearer
v1: https://lore.kernel.org/lkml/[email protected]/

 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

Simon Horman

Reviewed-by on v2 1/1

2023-05-17 09:28 UTC #1 lore raw

Quoted 8 lines · Baozhu Ni

Provide a description for the kernel doc of the @adapter of e1000e_trigger_lsc()
Signed-off-by Baozhu Ni <[email protected]>
---
v2:
- let the subject and description clearer
v1: https://lore.kernel.org/lkml/[email protected]/

Thanks for the update.

Reviewed-by Simon Horman <[email protected]>