[dpdk-dev] [PATCH v6 3/4] net/netvsc: add documentation

[Kovacevic, Marko]

> From: Stephen Hemminger <sthemmin at microsoft.com>
> 
> Matching documentation for new netvsc device.
> 
> Signed-off-by: Stephen Hemminger <sthemmin at microsoft.com>
> ---
>  doc/guides/nics/features/netvsc.ini    | 23 ++++++
>  doc/guides/nics/index.rst              |  1 +
>  doc/guides/nics/netvsc.rst             | 98 ++++++++++++++++++++++++++
>  doc/guides/rel_notes/release_18_05.rst |  5 ++
>  4 files changed, 127 insertions(+)
>  create mode 100644 doc/guides/nics/features/netvsc.ini
>  create mode 100644 doc/guides/nics/netvsc.rst
> 
> diff --git a/doc/guides/nics/features/netvsc.ini
> b/doc/guides/nics/features/netvsc.ini
> new file mode 100644
> index 000000000000..2ff6042bf47b
> --- /dev/null
> +++ b/doc/guides/nics/features/netvsc.ini

<...>

> +++ b/doc/guides/nics/netvsc.rst
> @@ -0,0 +1,98 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) Microsoft Corporation.
> +
> +Netvsc (Hyper-V) poll mode driver
> +=================================
> +
> +Hyper-V is a hypervisor integrated into Window Server 2008, Windows 10
> +and later versions.  It supports a para-virtualized network interface
> +called netvsc that is visible on the virtual machine bus (VMBUS).  In
> +the Data Plane Development Kit (DPDK), we provide a Network Virtual
> +Service Client (NetVSC) Poll Mode Driver (PMD). The NetVSC PMD supports
> +Windows Server 2016 and Microsoft Azure cloud.
> +
> +NetVSC Implementation in DPDK
> +-----------------------------
> +
> +The Netvsc PMD is a standalone driver. VMBus network devices that are
> +being used by DPDK must be unbound from the Linux kernel driver
> +(hv_netvsc) and bound to the Userspace IO driver for Hyper-V
> +(uio_hv_generic).
> +
> +This is most conveniently done with the .. _`driverctl`:
> +https://gitlab.com/driverctl/driverctl
> +script.

The way you set up the link here is wrong 

.. _`driverctl`: https://gitlab.com/driverctl/driverctl  ---> `driverctl <https://gitlab.com/driverctl/driverctl>`_


<...>

> +++ b/doc/guides/rel_notes/release_18_05.rst
> @@ -183,6 +183,11 @@ New Features
>    stats/xstats on shared memory from secondary process, and also pdump
> packets on
>    those virtual devices.
> 
> +* **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

Spelling above 
experimntal / experimental

> +  for more details on this   new driver.
> 
>  API Changes
>  -----------