Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Wed, 23 Jan 2019 14:55:03 +0200
From:   Mike Rapoport <rppt@linux.ibm.com>
To:     Greg KH <gregkh@linuxfoundation.org>
Cc:     Oded Gabbay <oded.gabbay@gmail.com>, linux-kernel@vger.kernel.org,
        ogabbay@habana.ai
Subject: Re: [PATCH 01/15] habanalabs: add skeleton driver
References: <20190123000057.31477-1-oded.gabbay@gmail.com>
 <20190123000057.31477-2-oded.gabbay@gmail.com>
 <20190123122804.GB2194@rapoport-lnx>
 <20190123124004.GA19703@kroah.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20190123124004.GA19703@kroah.com>
User-Agent: Mutt/1.5.24 (2015-08-30)
Message-Id: <20190123125502.GF4747@rapoport-lnx>
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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.