Messages in this thread | ![/](/images/icornerl.gif) | | Date | Tue, 16 May 2023 13:16:03 +0200 | From | Simon Horman <> | Subject | Re: [PATCH] e1000e: Add desc after trailing whitespace |
| |
On Tue, May 16, 2023 at 03:15:09PM +0800, Baozhu Ni wrote: > ./scripts/checkpatch.pl check error, so add description. > > Signed-off-by: Baozhu Ni <nibaozhu@yeah.net>
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. Link: https://kernel.org/doc/html/latest/process/maintainer-netdev.html
> --- > drivers/net/ethernet/intel/e1000e/netdev.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/drivers/net/ethernet/intel/e1000e/netdev.c b/drivers/net/ethernet/intel/e1000e/netdev.c > index 6f5c16aebcbf..cadeb5bc5e16 100644 > --- a/drivers/net/ethernet/intel/e1000e/netdev.c > +++ b/drivers/net/ethernet/intel/e1000e/netdev.c > @@ -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
| ![\](/images/icornerr.gif) |