[PATCH] doc: add VF support statement

[PATCH] doc: add VF support statement

[Qiming Yang]

This patch adds two note in doc build_dpdk, suggests DPDK user
don't use ``vfio-pci`` and ``uio_pci_generic`` module to create
virtual functions(VFs).

Signed-off-by: Qiming Yang <qiming.yang@intel.com>
---
 doc/guides/linux_gsg/build_dpdk.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst
index 9d24573..b79ca48 100644
--- a/doc/guides/linux_gsg/build_dpdk.rst
+++ b/doc/guides/linux_gsg/build_dpdk.rst
@@ -155,6 +155,10 @@ can provide the uio capability. This module can be loaded using the command
 
     sudo modprobe uio_pci_generic
 
+.. note::
+
+    ``uio_pci_generic`` module doesn't support to create virtual functions.
+
 As an alternative to the ``uio_pci_generic``, the DPDK also includes the igb_uio
 module which can be found in the kmod subdirectory referred to above. It can
 be loaded as shown below:
@@ -187,6 +191,10 @@ however please consult your distributions documentation to make sure that is the
 
 Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d).
 
+.. note::
+
+    ``vfio-pci`` module doesn't support to create virtual functions.
+
 For proper operation of VFIO when running DPDK applications as a non-privileged user, correct permissions should also be set up.
 This can be done by using the DPDK setup script (called dpdk-setup.sh and located in the usertools directory).
 
-- 
2.7.4

Re: [PATCH] doc: add VF support statement

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Qiming Yang
> Sent: Tuesday, April 18, 2017 6:36 AM
> To: dev@dpdk.org
> Cc: Richardson, Bruce <bruce.richardson@intel.com>; Wu, Jingjing
> <jingjing.wu@intel.com>; Yang, Qiming <qiming.yang@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: add VF support statement
> 
> This patch adds two note in doc build_dpdk, suggests DPDK user don't use
> ``vfio-pci`` and ``uio_pci_generic`` module to create virtual
> functions(VFs).
> 
> Signed-off-by: Qiming Yang <qiming.yang@intel.com>
> ---
>  doc/guides/linux_gsg/build_dpdk.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/doc/guides/linux_gsg/build_dpdk.rst
> b/doc/guides/linux_gsg/build_dpdk.rst
> index 9d24573..b79ca48 100644
> --- a/doc/guides/linux_gsg/build_dpdk.rst
> +++ b/doc/guides/linux_gsg/build_dpdk.rst
> @@ -155,6 +155,10 @@ can provide the uio capability. This module can be
> loaded using the command
> 
>      sudo modprobe uio_pci_generic
> 
> +.. note::
> +
> +    ``uio_pci_generic`` module doesn't support to create virtual
> functions.


Would be better as:

The ``uio_pci_generic`` module doesn't support the creation of virtual functions.


> +
> +.. note::
> +
> +    ``vfio-pci`` module doesn't support to create virtual functions.
> +


Would be better as:

The `` vfio-pci `` module doesn't support the creation of virtual functions.

[PATCH v2] doc: add VF support statement

[Qiming Yang]

This patch adds two note in doc build_dpdk, suggests DPDK user
don't use ``vfio-pci`` and ``uio_pci_generic`` module to create
virtual functions(VFs).

Signed-off-by: Qiming Yang <qiming.yang@intel.com>
---
v2 changes:
* use better expression.
---
---
 doc/guides/linux_gsg/build_dpdk.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst
index 9d24573..cf6c06d 100644
--- a/doc/guides/linux_gsg/build_dpdk.rst
+++ b/doc/guides/linux_gsg/build_dpdk.rst
@@ -155,6 +155,10 @@ can provide the uio capability. This module can be loaded using the command
 
     sudo modprobe uio_pci_generic
 
+.. note::
+
+    ``uio_pci_generic`` module doesn't support the creation of virtual functions.
+
 As an alternative to the ``uio_pci_generic``, the DPDK also includes the igb_uio
 module which can be found in the kmod subdirectory referred to above. It can
 be loaded as shown below:
@@ -187,6 +191,10 @@ however please consult your distributions documentation to make sure that is the
 
 Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d).
 
+.. note::
+
+    ``vfio-pci`` module doesn't support the creation of virtual functions.
+
 For proper operation of VFIO when running DPDK applications as a non-privileged user, correct permissions should also be set up.
 This can be done by using the DPDK setup script (called dpdk-setup.sh and located in the usertools directory).
 
-- 
2.7.4

Re: [PATCH v2] doc: add VF support statement

[Thomas Monjalon]

03/05/2017 08:21, Qiming Yang:
> This patch adds two note in doc build_dpdk, suggests DPDK user
> don't use ``vfio-pci`` and ``uio_pci_generic`` module to create
> virtual functions(VFs).
> 
> Signed-off-by: Qiming Yang <qiming.yang@intel.com>

Applied, thanks