From: Greg KH <gregkh@suse.de>
To: "Othman, Ossama" <ossama.othman@intel.com>
Cc: Andrew Morton <akpm@linux-foundation.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
Randy Dunlap <randy.dunlap@oracle.com>
Subject: Re: [PATCH] Intel Restricted Access Region Handler
Date: Fri, 19 Mar 2010 15:56:08 -0700 [thread overview]
Message-ID: <20100319225608.GA13174@suse.de> (raw)
In-Reply-To: <A5FE05C4C76E4C4CAB15D9962B96FC950C9A7A6431@orsmsx510.amr.corp.intel.com>
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
next prev parent reply other threads:[~2010-03-19 22:56 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-03-14 9:14 [PATCH] Intel Restricted Access Region Handler Ossama Othman
2010-03-14 9:08 ` Othman, Ossama
2010-03-14 18:10 ` Greg KH
2010-03-15 23:16 ` Othman, Ossama
2010-03-15 23:45 ` Greg KH
2010-03-19 21:32 ` Andrew Morton
2010-03-19 21:40 ` Greg KH
2010-03-19 22:53 ` Othman, Ossama
2010-03-19 22:56 ` Greg KH [this message]
2010-03-26 22:11 ` [PATCH] staging: Initial memrar ABI document Ossama Othman
2010-03-15 23:23 ` [PATCH] staging: Intel Restricted Access Region Handler Ossama Othman
2010-03-15 17:22 ` [PATCH] " Randy Dunlap
2010-03-15 17:26 ` Othman, Ossama
2010-03-15 17:47 ` Alan Cox
2010-03-15 18:29 ` Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20100319225608.GA13174@suse.de \
--to=gregkh@suse.de \
--cc=akpm@linux-foundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=ossama.othman@intel.com \
--cc=randy.dunlap@oracle.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.