From: Xu Yilun <yilun.xu@intel.com>
To: Marco Pagani <marpagan@redhat.com>
Cc: Randy Dunlap <rdunlap@infradead.org>,
Moritz Fischer <mdf@kernel.org>, Wu Hao <hao.wu@intel.com>,
Tom Rix <trix@redhat.com>,
linux-kernel@vger.kernel.org, linux-fpga@vger.kernel.org
Subject: Re: [RFC PATCH 2/2] fpga: bridge: fix kernel-doc
Date: Mon, 10 Jul 2023 16:06:30 +0800 [thread overview]
Message-ID: <ZKu8BkQZAvAfZbSE@yilunxu-OptiPlex-7050> (raw)
In-Reply-To: <b3ef657d-22a9-a52f-821e-55fc5faf1ca5@redhat.com>
On 2023-07-07 at 10:50:16 +0200, Marco Pagani wrote:
>
>
> On 2023-07-06 23:35, Randy Dunlap wrote:
> > HI--
> >
> > On 7/6/23 07:27, Marco Pagani wrote:
> >> Fix the following warnings issued by the kernel-doc script:
> >>
> >> drivers/fpga/fpga-bridge.c:99: warning: No description found for return value of 'of_fpga_bridge_get'
> >> drivers/fpga/fpga-bridge.c:163: warning: No description found for return value of 'fpga_bridges_enable'
> >> drivers/fpga/fpga-bridge.c:187: warning: No description found for return value of 'fpga_bridges_disable'
> >> drivers/fpga/fpga-bridge.c:238: warning: No description found for return value of 'of_fpga_bridge_get_to_list'
> >> drivers/fpga/fpga-bridge.c:268: warning: No description found for return value of 'fpga_bridge_get_to_list'
> >>
> >> - Extend the return description of of_fpga_bridge_get() to include the
> >> case when try_module_get() fails.
> >>
> >> Signed-off-by: Marco Pagani <marpagan@redhat.com>
> >> ---
> >> drivers/fpga/fpga-bridge.c | 23 ++++++++++++-----------
> >> 1 file changed, 12 insertions(+), 11 deletions(-)
> >>
> >> diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
> >> index a6c25dee9cc1..0b76c67c50e5 100644
> >> --- a/drivers/fpga/fpga-bridge.c
> >> +++ b/drivers/fpga/fpga-bridge.c
> >> @@ -87,12 +87,13 @@ static struct fpga_bridge *__fpga_bridge_get(struct device *dev,
> >> /**
> >> * of_fpga_bridge_get - get an exclusive reference to an fpga bridge
> >> *
> >> - * @np: node pointer of an FPGA bridge
> >> - * @info: fpga image specific information
> >> + * @np: node pointer of an FPGA bridge.
> >> + * @info: fpga image specific information.
> >
> > Those are not sentences. There is no reason that a period ('.') is needed
> > to end those lines. OTOH, the maintainers can do as they like with it.
> >
> > The rest looks good. Thanks.
> >
> > Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
>
> I added a period at the end of each argument description to follow
> the style recommended in the "Function documentation" section of the
> kernel-doc documentation.
I'm OK with them.
Acked-by: Xu Yilun <yilun.xu@intel.com>
Applied.
>
> Thanks,
> Marco
>
> [...]
>
prev parent reply other threads:[~2023-07-10 8:09 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-06 14:27 [RFC PATCH 0/2] fpga: fix kernel-doc warnings and align descriptions for the core components Marco Pagani
2023-07-06 14:27 ` [RFC PATCH 1/2] fpga: region: fix kernel-doc Marco Pagani
2023-07-06 21:30 ` Randy Dunlap
2023-07-10 8:05 ` Xu Yilun
2023-07-06 14:27 ` [RFC PATCH 2/2] fpga: bridge: " Marco Pagani
2023-07-06 21:35 ` Randy Dunlap
2023-07-06 21:37 ` Randy Dunlap
2023-07-07 8:50 ` Marco Pagani
2023-07-10 8:06 ` Xu Yilun [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=ZKu8BkQZAvAfZbSE@yilunxu-OptiPlex-7050 \
--to=yilun.xu@intel.com \
--cc=hao.wu@intel.com \
--cc=linux-fpga@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=marpagan@redhat.com \
--cc=mdf@kernel.org \
--cc=rdunlap@infradead.org \
--cc=trix@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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).