[dpdk-dev] [PATCH] doc: clarify usage of netvsc PMD

[dpdk-dev] [PATCH] doc: clarify usage of netvsc PMD

[Stephen Hemminger]

Since netvsc PMD does not support SR-IOV accelerated networking,
it is not recommended for use on Azure. Make this clear in the
guide.

Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
---
 doc/guides/nics/netvsc.rst | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/doc/guides/nics/netvsc.rst b/doc/guides/nics/netvsc.rst
index 0f033e3a3d63..93d6ec0146ad 100644
--- a/doc/guides/nics/netvsc.rst
+++ b/doc/guides/nics/netvsc.rst
@@ -6,7 +6,7 @@ Netvsc poll mode driver
 
 The Netvsc Poll Mode driver (PMD) provides support for the paravirtualized
 network device for Microsoft Hyper-V. It can be used with
-Window Server 2008/2012/2016, Windows 10 and Azure cloud.
+Window Server 2008/2012/2016, Windows 10.
 The device offers multi-queue support (if kernel and host support it),
 checksum and segmentation offloads.
 
@@ -21,7 +21,7 @@ In this release, the hyper PMD driver provides the basic functionality of packet
 
 *   The PMD supports multicast packets and promiscuous mode subject to restrictions on the host.
     In order to this to work, the guest network configuration on Hyper-V must be configured to allow MAC address
-    spoofing. This option is not available on Azure.
+    spoofing.
 
 *   The device has only a single MAC address.
     Hyper-V driver does not support MAC or VLAN filtering because the Hyper-V host does not support it.
@@ -33,9 +33,13 @@ In this release, the hyper PMD driver provides the basic functionality of packet
 *   The maximum number of queues is limited by the host (currently 64).
     When used with 4.16 kernel only a single queue is available.
 
-*   This driver is intended for use with synthetic path only.
-    Accelerated Networking (SR-IOV) acceleration is not supported yet.
-    Use the VDEV_NETVSC device for accelerated networking instead.
+.. note::
+   This driver is intended for use with **Hyper-V only** and is
+   not recommended for use on Azure because accelerated Networking
+   (SR-IOV) is not supported.
+
+   On Azure, use the :ref:`VDEV_NETVSC driver <./vdev_netvsc>` which
+   automatically configures the necessary TAP and failsave drivers.
 
 
 Installation
@@ -88,7 +92,7 @@ operations:
 
 .. Note::
 
-   The dpkd-devbind.py script should not be used. It only handles PCI devices.
+   The dpkd-devbind.py script can not be used since it only handles PCI devices.
 
 
 Prerequisites
-- 
2.18.0

Re: [dpdk-dev] [PATCH] doc: clarify usage of netvsc PMD

[Thomas Monjalon]

06/08/2018 18:31, Stephen Hemminger:
> Since netvsc PMD does not support SR-IOV accelerated networking,
> it is not recommended for use on Azure. Make this clear in the
> guide.
> 
> Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>

There is a warning:
WARNING: undefined label: ./vdev_netvsc (if the link has no caption the label must precede a section header)

Fixed with following diff:
-   On Azure, use the :ref:`VDEV_NETVSC driver <./vdev_netvsc>` which
+   On Azure, use the :doc:`vdev_netvsc` which


Applied, thanks

Re: [dpdk-dev] [PATCH] doc: clarify usage of netvsc PMD

[Stephen Hemminger]

On Tue, 07 Aug 2018 14:20:13 +0200
Thomas Monjalon <thomas@monjalon.net> wrote:

> 06/08/2018 18:31, Stephen Hemminger:
> > Since netvsc PMD does not support SR-IOV accelerated networking,
> > it is not recommended for use on Azure. Make this clear in the
> > guide.
> > 
> > Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>  
> 
> There is a warning:
> WARNING: undefined label: ./vdev_netvsc (if the link has no caption the label must precede a section header)
> 
> Fixed with following diff:
> -   On Azure, use the :ref:`VDEV_NETVSC driver <./vdev_netvsc>` which
> +   On Azure, use the :doc:`vdev_netvsc` which
> 
> 
> Applied, thanks
> 
> 
> 

I tried several ways to get link from one guide to another. Couldn't figure out the RST syntax.
Maybe someone else knows the answer.

Also, there are several broken links to linux_gsg that show up when doing make docs.

Re: [dpdk-dev] [PATCH] doc: clarify usage of netvsc PMD

[Thomas Monjalon]

07/08/2018 18:23, Stephen Hemminger:
> On Tue, 07 Aug 2018 14:20:13 +0200
> Thomas Monjalon <thomas@monjalon.net> wrote:
> 
> > There is a warning:
> > WARNING: undefined label: ./vdev_netvsc (if the link has no caption the label must precede a section header)
> > 
> > Fixed with following diff:
> > -   On Azure, use the :ref:`VDEV_NETVSC driver <./vdev_netvsc>` which
> > +   On Azure, use the :doc:`vdev_netvsc` which
[...]
> I tried several ways to get link from one guide to another. Couldn't figure out the RST syntax.
> Maybe someone else knows the answer.

It's fixed with :doc: so this is the answer :)
:doc: can be used to link a rst file.
:ref: is used to link a specific section of a rst file, thanks to anchors.

> Also, there are several broken links to linux_gsg that show up when doing make docs.

I think you refer to issues with link across PDF documents?