From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas.monjalon@6wind.com>
Subject: Re: [PATCH v4 5/7] hv: poll mode driver
Date: Thu, 09 Jul 2015 02:01:54 +0200
Message-ID: <3272965.aEWAsPVoiT@xps13>
References: <1429637564-5656-1-git-send-email-stephen@networkplumber.org>
 <0C5AFCA4B3408848ADF2A3073F7D8CC86D5A6905@IRSMSX109.ger.corp.intel.com>
 <20150421143518.796adb14@urahara>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org, Stas Egorov <segorov@mirantis.com>,
 "alexmay@microsoft.com" <alexmay@microsoft.com>,
 Stephen Hemminger <shemming@brocade.com>
To: Stephen Hemminger <stephen@networkplumber.org>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wi0-f172.google.com (mail-wi0-f172.google.com
 [209.85.212.172]) by dpdk.org (Postfix) with ESMTP id E8C0C5A44
 for <dev@dpdk.org>; Thu,  9 Jul 2015 02:02:59 +0200 (CEST)
Received: by wiclp1 with SMTP id lp1so94742988wic.0
 for <dev@dpdk.org>; Wed, 08 Jul 2015 17:02:59 -0700 (PDT)
In-Reply-To: <20150421143518.796adb14@urahara>
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

2015-04-21 14:35, Stephen Hemminger:
> On Tue, 21 Apr 2015 19:34:39 +0000
> "Butler, Siobhan A" <siobhan.a.butler@intel.com> wrote:
> 
> > Hi Stephen 
> > Will you have documentation to go along with these changes?
> > Thanks
> > Siobhan
> 
> Unlikely. Microsoft or other contributors might add something
> in a later version.
> 
> The documentation that exists in DPDK related drivers just
> won't scale as more drivers are added. It needs to be massively
> simplified and generalized.

I'm afraid you'll need to put a rst file in doc/guides/nics/.
At least, you need to describe how to use the specific bus and explains that
it is supported only on Linux with recent kernels.