From: Yang Yingliang <yangyingliang@huawei.com>
To: Bjorn Helgaas <helgaas@kernel.org>
Cc: <linux-pci@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<ntb@lists.linux.dev>, <jdmason@kudzu.us>, <dave.jiang@intel.com>,
<allenbh@gmail.com>, <lpieralisi@kernel.org>, <kw@linux.com>,
<mani@kernel.org>, <kishon@kernel.org>, <bhelgaas@google.com>
Subject: Re: [PATCH v2] PCI: endpoint: pci-epf-vntb: fix doc warning in pci-epf-vntb.c
Date: Tue, 3 Jan 2023 09:53:52 +0800 [thread overview]
Message-ID: <04d1b6b2-3fc4-f9c2-44cc-c54007963b36@huawei.com> (raw)
In-Reply-To: <20221230193807.GA698469@bhelgaas>
Hi,
On 2022/12/31 3:38, Bjorn Helgaas wrote:
> Hi Yang,
>
> On Thu, Dec 22, 2022 at 11:43:24AM +0800, Yang Yingliang wrote:
>> Fix the following make W=1 warning:
>>
>> drivers/pci/endpoint/functions/pci-epf-vntb.c:645: warning: Function parameter or member 'num_mws' not described in 'epf_ntb_mw_bar_clear'
> No big deal here, but I try to make subject lines and commit logs a
> little more specific. "Fix doc warning" doesn't give any real
> information, but something like "Add num_mws kernel-doc" would.
>
> No need to repeat "pci-epf-vntb" in the subject; one mention is
> enough.
OK.
>
>> Fixes: 8e4bfbe644a6 ("PCI: endpoint: pci-epf-vntb: fix error handle in epf_ntb_mw_bar_init()")
>> Signed-off-by: Yang Yingliang <yangyingliang@huawei.com>
>> ---
>> v1 -> v2:
>> Based on latest commit.
> What is "latest commit"? A SHA1 would make this unambiguous.
It's 1b929c02afd3 Linux 6.2-rc1.
When I make v1, it also has warning in comment of
epf_ntb_config_sspad_bar_clear(),
so I fix it in v1, but it was fixed later, so remove the fix code in v2.
>
>> ---
>> drivers/pci/endpoint/functions/pci-epf-vntb.c | 1 +
>> 1 file changed, 1 insertion(+)
>>
>> diff --git a/drivers/pci/endpoint/functions/pci-epf-vntb.c b/drivers/pci/endpoint/functions/pci-epf-vntb.c
>> index 04698e7995a5..37134aead77c 100644
>> --- a/drivers/pci/endpoint/functions/pci-epf-vntb.c
>> +++ b/drivers/pci/endpoint/functions/pci-epf-vntb.c
>> @@ -594,6 +594,7 @@ static void epf_ntb_db_bar_clear(struct epf_ntb *ntb)
>> /**
>> * epf_ntb_mw_bar_init() - Configure Memory window BARs
>> * @ntb: NTB device that facilitates communication between HOST and VHOST
>> + * @num_mws: the number of Memory window BARs that to be cleared
> This patch happens to apply cleanly on 1b929c02afd3 ("Linux 6.2-rc1"),
> but I think the hunk gets applied in the wrong place.
>
> 8e4bfbe644a6 ("PCI: endpoint: pci-epf-vntb: fix error handle in
> epf_ntb_mw_bar_init()") added a "num_mws" parameter to
> epf_ntb_mw_bar_clear() but failed to add kernel-doc for num_mws.
>
> This patch adds kernel-doc for num_mws on *epf_ntb_mw_bar_init()*,
> which doesn't have a num_mws parameter, so after applying it, I see
> *two* kernel-doc warnings:
>
> $ make W=1 drivers/pci/endpoint/functions/pci-epf-vntb.o
> drivers/pci/endpoint/functions/pci-epf-vntb.c:602: warning: Excess function parameter 'num_mws' description in 'epf_ntb_mw_bar_init'
> drivers/pci/endpoint/functions/pci-epf-vntb.c:658: warning: Function parameter or member 'num_mws' not described in 'epf_ntb_mw_bar_clear'
Sorry, I sent a wrong patch, the comment should be added to
epf_ntb_mw_bar_clear().
I will send a new version later.
Thanks,
Yang
>
>> * Returns: Zero for success, or an error code in case of failure
>> */
>> --
>> 2.25.1
>>
> .
prev parent reply other threads:[~2023-01-03 1:54 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-22 3:43 [PATCH v2] PCI: endpoint: pci-epf-vntb: fix doc warning in pci-epf-vntb.c Yang Yingliang
2022-12-30 19:38 ` Bjorn Helgaas
2023-01-03 1:53 ` Yang Yingliang [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=04d1b6b2-3fc4-f9c2-44cc-c54007963b36@huawei.com \
--to=yangyingliang@huawei.com \
--cc=allenbh@gmail.com \
--cc=bhelgaas@google.com \
--cc=dave.jiang@intel.com \
--cc=helgaas@kernel.org \
--cc=jdmason@kudzu.us \
--cc=kishon@kernel.org \
--cc=kw@linux.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=lpieralisi@kernel.org \
--cc=mani@kernel.org \
--cc=ntb@lists.linux.dev \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).