From: Simon Horman <simon.horman@corigine.com>
To: Baozhu Ni <nibaozhu@yeah.net>
Cc: Outreachy <outreachy@lists.linux.dev>,
"moderated list:INTEL ETHERNET DRIVERS"
<intel-wired-lan@lists.osuosl.org>,
Jesse Brandeburg <jesse.brandeburg@intel.com>,
open list <linux-kernel@vger.kernel.org>,
Eric Dumazet <edumazet@google.com>,
Tony Nguyen <anthony.l.nguyen@intel.com>,
"open list:NETWORKING DRIVERS" <netdev@vger.kernel.org>,
Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
"David S. Miller" <davem@davemloft.net>
Subject: Re: [Intel-wired-lan] [PATCH] e1000e: Add desc after trailing whitespace
Date: Tue, 16 May 2023 13:16:03 +0200 [thread overview]
Message-ID: <ZGNl8yHEko7LpCBr@corigine.com> (raw)
In-Reply-To: <20230516071509.GA3550@john-VirtualBox>
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
_______________________________________________
Intel-wired-lan mailing list
Intel-wired-lan@osuosl.org
https://lists.osuosl.org/mailman/listinfo/intel-wired-lan
prev parent reply other threads:[~2023-05-16 11:16 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-16 7:15 [Intel-wired-lan] [PATCH] e1000e: Add desc after trailing whitespace Baozhu Ni
2023-05-16 11:16 ` Simon Horman [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ZGNl8yHEko7LpCBr@corigine.com \
--to=simon.horman@corigine.com \
--cc=anthony.l.nguyen@intel.com \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=intel-wired-lan@lists.osuosl.org \
--cc=jesse.brandeburg@intel.com \
--cc=kuba@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=nibaozhu@yeah.net \
--cc=outreachy@lists.linux.dev \
--cc=pabeni@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox