linux-kernel - Re: [PATCH 01/15] habanalabs: add skeleton driver

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] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 23 Jan 2019 13:40:04 +0100
From:   Greg KH <gregkh@...uxfoundation.org>
To:     Mike Rapoport <rppt@...ux.ibm.com>
Cc:     Oded Gabbay <oded.gabbay@...il.com>, linux-kernel@...r.kernel.org,
        ogabbay@...ana.ai
Subject: Re: [PATCH 01/15] habanalabs: add skeleton driver

On Wed, Jan 23, 2019 at 02:28:05PM +0200, Mike Rapoport wrote:
> On Wed, Jan 23, 2019 at 02:00:43AM +0200, Oded Gabbay wrote:
> > +/**
> > + * hl_device_release - release function for habanalabs device
> > + *
> > + * @inode: pointer to inode structure
> > + * @filp: pointer to file structure
> > + *
> > + * Called when process closes an habanalabs device
> > + */
> 
> It's nice to see docs coming along with the codei
> I have some comments for the formatting.
> 
> kernel-doc won't be happy about missing return value descriptions, and
> although they are sometimes redundant or too obvious their absence makes
> 'make V=1 htmldocs' really noisy.
> 
> In general, it would be nice if you could link hanabnalabs driver
> kernel-doc somewhere in Documentation/ run 'make V=1 htmldocs'.
> 
> > +static int hl_device_release(struct inode *inode, struct file *filp)

There's no need for kerneldoc comments for static functions, as no one
can call them and they are not part of any api.

So what would be better here is to just drop the /** line and use /*

thanks,

greg k-h