On Tue, Mar 22, 2016 at 05:18:50PM +0000, Kershner, David A wrote: > > -----Original Message----- > > From: Greg KH [mailto:gregkh@xxxxxxxxxxxxxxxxxxx] > > Sent: Tuesday, March 22, 2016 11:59 AM > > To: Kershner, David A <David.Kershner@xxxxxxxxxx> > > Cc: driverdev-devel@xxxxxxxxxxxxxxxxxxxxxx; *S-Par-Maintainer > > <SParMaintainer@xxxxxxxxxx> > > Subject: Re: When and how to commit kerneldoc comments to > > staging/unisys/* > > > > On Tue, Mar 22, 2016 at 03:51:59PM +0000, Kershner, David A wrote: > > > Greg, we are looking at adding kerneldoc style comments for the drivers in > > staging/unisys/*. > > > > First off, why? > > Cause the current state of the documentation in the tree has something to be > desired and is extremely lacking. I just picked kerneldoc style cause it is > definitely better than what we currently have, should we use some other style > guideline? No, that's a great style to use, but what exactly are you wanting to document? That format is to explain apis, not design decisions and overall architecture. > > > Should we be doing this in staging or outside of it? > > > > I don't understand what you mean by "outside of it"? > > Is the documentation we have in the code good enough for the drivers to move > beyond the staging directory or should they get updated? I don't know, haven't looked at it :) Again, it comes down to what you think needs to be documented. thanks, greg k-h _______________________________________________ devel mailing list devel@xxxxxxxxxxxxxxxxxxxxxx http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel
