From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ferruh Yigit Subject: Re: [PATCH v3 3/4] net/netvsc: add documentation Date: Wed, 18 Apr 2018 17:16:14 +0100 Message-ID: <5afa5b27-a343-840a-4190-378527ec6cfb@intel.com> References: <20180417215324.8576-1-sthemmin@microsoft.com> <20180417215324.8576-4-sthemmin@microsoft.com> <20180418090302.7ad48010@xeon-e3> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit Cc: dev@dpdk.org, Stephen Hemminger , Hemant Agrawal , John McNamara To: Stephen Hemminger Return-path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 483487CAF for ; Wed, 18 Apr 2018 18:16:20 +0200 (CEST) In-Reply-To: <20180418090302.7ad48010@xeon-e3> Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On 4/18/2018 5:03 PM, Stephen Hemminger wrote: > On Wed, 18 Apr 2018 14:25:22 +0100 > Ferruh Yigit wrote: > >> On 4/17/2018 10:53 PM, Stephen Hemminger wrote: >>> Matching documentation for new netvsc device. >>> >>> Signed-off-by: Stephen Hemminger >>> --- >>> doc/guides/nics/index.rst | 1 + >>> doc/guides/nics/netvsc.rst | 97 ++++++++++++++++++++++++++ >>> doc/guides/rel_notes/release_18_05.rst | 6 ++ >>> 3 files changed, 104 insertions(+) >>> create mode 100644 doc/guides/nics/netvsc.rst >> >> Documentation added for network driver but not for bus driver, does it make >> sense to add vmbus doc too? > > Not really, vmbus is only useful for one network device. > What did Dpaa2 do? It seems they also only documented the drivers (net, crypto, event). There is no bus level documentation for any bus, if I am not missing them, not sure if this is a gap? > >>> diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst >>> index bc9cdda6af7a..0a7b65d49293 100644 >>> --- a/doc/guides/rel_notes/release_18_05.rst >>> +++ b/doc/guides/rel_notes/release_18_05.rst >>> @@ -115,6 +115,12 @@ New Features >>> >>> Linux uevent is supported as backend of this device event notification framework. >>> >>> +* **Added experimental support for Hyper-V netvsc PMD.** >>> + >>> + The new experimntal ``netvsc`` poll mode driver provides native support for >>> + networking on Hyper-V. See the :doc:`../nics/netvsc` nic driver guide >>> + for more details on this new driver. >>> + >> >> Also there is a "Shared Library Versions" section of the release notes, the >> libraries with public API should be listed here with version information. I can >> see some bus libraries are there. >> >> If any of the libraries added has public API, should be added into that list. > > The vmbus is internal. >