Messages in this thread | | | From | "Othman, Ossama" <> | Date | Fri, 19 Mar 2010 15:53:07 -0700 | Subject | RE: [PATCH] Intel Restricted Access Region Handler |
| |
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?
Thanks, -Ossama
| |