lkml.org 
[lkml]   [2022]   [Apr]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRE: [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc description
Date
Hi Yilun,

> -----Original Message-----
> From: Xu Yilun <yilun.xu@intel.com>
> Sent: Thursday, April 7, 2022 12:18 PM
> To: Nava kishore Manne <navam@xilinx.com>
> Cc: mdf@kernel.org; hao.wu@intel.com; trix@redhat.com; Michal Simek
> <michals@xilinx.com>; linux-fpga@vger.kernel.org; linux-
> kernel@vger.kernel.org; linux-arm-kernel@lists.infradead.org; git
> <git@xilinx.com>
> Subject: Re: [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc
> description
>
> On Thu, Apr 07, 2022 at 05:31:39AM +0000, Nava kishore Manne wrote:
> > Hi Yilun,
> >
> > Thanks for providing the review comments.
> > Please find my response inline.
> >
> > > -----Original Message-----
> > > From: Xu Yilun <yilun.xu@intel.com>
> > > Sent: Tuesday, April 5, 2022 11:06 AM
> > > To: Nava kishore Manne <navam@xilinx.com>
> > > Cc: mdf@kernel.org; hao.wu@intel.com; trix@redhat.com; Michal Simek
> > > <michals@xilinx.com>; linux-fpga@vger.kernel.org; linux-
> > > kernel@vger.kernel.org; linux-arm-kernel@lists.infradead.org; git
> > > <git@xilinx.com>
> > > Subject: Re: [PATCH v3 5/5] fpga: fpga-region: Add missing
> > > kernel-doc description
> > >
> > > On Sun, Apr 03, 2022 at 10:46:41AM +0530, Nava kishore Manne wrote:
> > > > Fixed the warnings: No description found for return value of 'xxx'
> > >
> > > The commit message is not clear. There are descriptions for some
> > > functions, but not in right format.
> > >
> > I agree for some functions has description but not in the right format.
> > The "Description Not exits" and "Description not in the right format" in
> both cases the tool will report the same warning ie; " warnings: No
> description found for return value of 'xxx'"
>
> Thanks for the info. It would be better we describe the root cause in commit
> message along with the robot reports.
>
> And also change the subject please.
>
Will fix
> > This patch address the above warning. So to make it relevant I have added
> the same in the commit msg.
>
> Adding the same commit message may not be a good way, for this case you
> could just combine them into one commit.
>
Will fix.

Regards,
Navakishore.

\
 
 \ /
  Last update: 2022-04-16 15:19    [W:0.054 / U:0.476 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site