From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <stephen@networkplumber.org>
Received: from mail-pg1-f195.google.com (mail-pg1-f195.google.com
 [209.85.215.195]) by dpdk.org (Postfix) with ESMTP id F41E55F54
 for <dev@dpdk.org>; Mon,  6 Aug 2018 18:31:15 +0200 (CEST)
Received: by mail-pg1-f195.google.com with SMTP id r1-v6so6452174pgp.11
 for <dev@dpdk.org>; Mon, 06 Aug 2018 09:31:15 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=networkplumber-org.20150623.gappssmtp.com; s=20150623;
 h=from:to:cc:subject:date:message-id;
 bh=5TvHOxxhs149ljNp3fvbxoi0l5CUFN2HidiiQ/XtO0Y=;
 b=cJzSOM6BStxs1ITvgQj5594meXyUb8VFDjjuXyFnAwIDlmtBjQanN7asYe64kkGjwe
 YP3IJNOsASGsWUJ3FIpH8bKVmnlAZYVDK4REAhF1zkWa35FB/qpuw9P07JSIIhWYVbaC
 CI/CE/K6JGoBu/7W18LJOVgs8Ly/YeUpTzop0j9PF8907rlZ1TaqqsSBxhYhsCCW+BKu
 chQpfIgo2+GO4cCbCqtJvDUSovP8FxJjU3Z+fD9XXp8T566YffpFRt3KhGSm4G8DEMLu
 Rzeh1uhtmXYvUbcrDPq6h4wHReIJO1JNbZuMd/tb6EfudsUzYWe2UrwnhvQYOPL5vFLV
 4pHw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:from:to:cc:subject:date:message-id;
 bh=5TvHOxxhs149ljNp3fvbxoi0l5CUFN2HidiiQ/XtO0Y=;
 b=mqqg89Ccus0KFzLJBOiB7rZ3ydH+jA3tOlQ8OXVqH6A55RN59pTxyFQSEQxQSGRsxm
 iLZmENY3xnVGrGLbMNwD7ZKegbZl3HN5Ay3buVYsbXadZowKCnfDwdtPR2J2dndlGyoR
 KHaNQ49bDqyPOJvlV8vl9JiLLXl9drx5+2i4x+oFxz0S+d18lTqchSTwf3JIVGKGTylK
 N1W4nD90qA12JlvCFATP/Xz5q7xHgQiybDZzR1dvvofzQweWq74eBEG+CgVqv7Tsjb82
 ioejqMdhCOQIitvbschQYHHTBYPXX9R/0t///A7/ZjsnpKkdXhn60y1qjbx591oFXfsn
 fLzg==
X-Gm-Message-State: AOUpUlFa6iRt3CuT3pn2yUTFa/ubDsJiLP41qLzPLP6644AdXrkoxsye
 QvS14cUmcGuh+ZtYE4pfWCzH64+yfbY=
X-Google-Smtp-Source: AAOMgpcniFyEAJ7oQ+7OTswlGu4ug2XupBQEWYXyaLx9hbdiX20eWh0mmzLRGbCAo6AZcxeKbE90VQ==
X-Received: by 2002:a63:6345:: with SMTP id
 x66-v6mr15324229pgb.43.1533573074754; 
 Mon, 06 Aug 2018 09:31:14 -0700 (PDT)
Received: from xeon-e3.lan (204-195-22-127.wavecable.com. [204.195.22.127])
 by smtp.gmail.com with ESMTPSA id l27-v6sm24578820pfi.180.2018.08.06.09.31.13
 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);
 Mon, 06 Aug 2018 09:31:13 -0700 (PDT)
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>,
 Stephen Hemminger <sthemmin@microsoft.com>
Date: Mon,  6 Aug 2018 09:31:07 -0700
Message-Id: <20180806163107.23595-1-stephen@networkplumber.org>
X-Mailer: git-send-email 2.18.0
Subject: [dpdk-dev] [PATCH] doc: clarify usage of netvsc PMD
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Mon, 06 Aug 2018 16:31:16 -0000

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