Re: [PATCH] Intel Restricted Access Region Handler

[Greg KH]

On Fri, Mar 19, 2010 at 03:53:07PM -0700, Othman, Ossama wrote:
> Andrew, Greg,
> 
> > Regarding the code itself: it appears to implement a userspace
> > interface via some /dev node.  But there is no description of this
> > interface at all in the changelog and there is no documentation
> > provided.  But the userspace-facing interface is the most important
> > part of the entire feature, because it is something we cannot ever
> > change.  It should be exhaustively described right up-front in the
> > changelog so that reviewers can easily and fully understand the
> > proposed API.
> 
> Would a README file of some sort be suitable to describe the driver
> interface or should I just embed additional documentation in the
> driver's interface header?

You are going to have to create a Documentation/ABI/ style file
eventually, so you might as well do it now and add it to the driver
directory.

thanks,

greg k-h
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/