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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Sat, 16 Apr 2022 13:18:58 +0000
From:   Nava kishore Manne <navam@...inx.com>
To:     Xu Yilun <yilun.xu@...el.com>
CC:     "mdf@...nel.org" <mdf@...nel.org>,
        "hao.wu@...el.com" <hao.wu@...el.com>,
        "trix@...hat.com" <trix@...hat.com>,
        Michal Simek <michals@...inx.com>,
        "linux-fpga@...r.kernel.org" <linux-fpga@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        "linux-arm-kernel@...ts.infradead.org" 
        <linux-arm-kernel@...ts.infradead.org>, git <git@...inx.com>
Subject: RE: [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc
  description

Hi Yilun,

> -----Original Message-----
> From: Xu Yilun <yilun.xu@...el.com>
> Sent: Thursday, April 7, 2022 12:18 PM
> To: Nava kishore Manne <navam@...inx.com>
> Cc: mdf@...nel.org; hao.wu@...el.com; trix@...hat.com; Michal Simek
> <michals@...inx.com>; linux-fpga@...r.kernel.org; linux-
> kernel@...r.kernel.org; linux-arm-kernel@...ts.infradead.org; git
> <git@...inx.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@...el.com>
> > > Sent: Tuesday, April 5, 2022 11:06 AM
> > > To: Nava kishore Manne <navam@...inx.com>
> > > Cc: mdf@...nel.org; hao.wu@...el.com; trix@...hat.com; Michal Simek
> > > <michals@...inx.com>; linux-fpga@...r.kernel.org; linux-
> > > kernel@...r.kernel.org; linux-arm-kernel@...ts.infradead.org; git
> > > <git@...inx.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.