From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752200Ab0CSW4m (ORCPT ); Fri, 19 Mar 2010 18:56:42 -0400 Received: from cantor2.suse.de ([195.135.220.15]:57900 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751422Ab0CSW4g (ORCPT ); Fri, 19 Mar 2010 18:56:36 -0400 Date: Fri, 19 Mar 2010 15:56:08 -0700 From: Greg KH To: "Othman, Ossama" Cc: Andrew Morton , "linux-kernel@vger.kernel.org" , Randy Dunlap Subject: Re: [PATCH] Intel Restricted Access Region Handler Message-ID: <20100319225608.GA13174@suse.de> References: <1268558064-7973-1-git-send-email-ossama.othman@intel.com> <20100314181040.GB28359@suse.de> <20100315234508.GB4008@suse.de> <20100319143222.72aee474.akpm@linux-foundation.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.5.20 (2009-06-14) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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