On Wed, Jan 23, 2019 at 01:40:04PM +0100, Greg KH wrote: > 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 /*
Maybe it'd make sense to use /* for most of the comments in this driver as there are kernel-doc formatting issues in non-static functions as well, I was just too lazy to go over all of them. > thanks, > > greg k-h > -- Sincerely yours, Mike.
