diff mbox series

e1000e: Add desc after trailing whitespace

Message ID 20230516071509.GA3550@john-VirtualBox (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series e1000e: Add desc after trailing whitespace | expand

Checks

Context Check Description
netdev/series_format warning Single patches do not need cover letters; Target tree name not specified in the subject
netdev/tree_selection success Guessed tree name to be net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 8 this patch: 8
netdev/cc_maintainers success CCed 8 of 8 maintainers
netdev/build_clang success Errors and warnings before: 8 this patch: 8
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 8 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Baozhu Ni May 16, 2023, 7:15 a.m. UTC 
./scripts/checkpatch.pl check error, so add description.

Signed-off-by: Baozhu Ni <nibaozhu@yeah.net>
---
 drivers/net/ethernet/intel/e1000e/netdev.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Simon Horman May 16, 2023, 11:16 a.m. UTC | #1 
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
diff mbox series

Patch

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.
  **/