RE: [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc description

[Nava kishore Manne]

Hi Yilun,

> -----Original Message-----
> From: Xu Yilun <yilun.xu@xxxxxxxxx>
> Sent: Thursday, April 7, 2022 12:18 PM
> To: Nava kishore Manne <navam@xxxxxxxxxx>
> Cc: mdf@xxxxxxxxxx; hao.wu@xxxxxxxxx; trix@xxxxxxxxxx; Michal Simek
> <michals@xxxxxxxxxx>; linux-fpga@xxxxxxxxxxxxxxx; linux-
> kernel@xxxxxxxxxxxxxxx; linux-arm-kernel@xxxxxxxxxxxxxxxxxxx; git
> <git@xxxxxxxxxx>
> 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@xxxxxxxxx>
> > > Sent: Tuesday, April 5, 2022 11:06 AM
> > > To: Nava kishore Manne <navam@xxxxxxxxxx>
> > > Cc: mdf@xxxxxxxxxx; hao.wu@xxxxxxxxx; trix@xxxxxxxxxx; Michal Simek
> > > <michals@xxxxxxxxxx>; linux-fpga@xxxxxxxxxxxxxxx; linux-
> > > kernel@xxxxxxxxxxxxxxx; linux-arm-kernel@xxxxxxxxxxxxxxxxxxx; git
> > > <git@xxxxxxxxxx>
> > > 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.