RE: [PATCH] Intel Restricted Access Region Handler

[Othman, Ossama]

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
--
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/