doc/devbind: remove references to igb_uio
diff mbox series

Message ID 20200906033846.24686-1-stephen@networkplumber.org
State Superseded
Delegated to: Thomas Monjalon
Headers show
Series
  • doc/devbind: remove references to igb_uio
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK

Commit Message

Stephen Hemminger Sept. 6, 2020, 3:38 a.m. UTC
We should be encouraging the use of vfio_pci for developers, not telling
them to use igb_uio.

Also fix typo where .py suffix is visible in document.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/tools/devbind.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

Comments

Bruce Richardson Sept. 7, 2020, 9:08 a.m. UTC | #1
On Sat, Sep 05, 2020 at 08:38:46PM -0700, Stephen Hemminger wrote:
> We should be encouraging the use of vfio_pci for developers, not telling
> them to use igb_uio.
> 
> Also fix typo where .py suffix is visible in document.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
>  doc/guides/tools/devbind.rst | 20 ++++++++++----------
>  1 file changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/doc/guides/tools/devbind.rst b/doc/guides/tools/devbind.rst
> index a2910e103aab..52690f018648 100644
> --- a/doc/guides/tools/devbind.rst
> +++ b/doc/guides/tools/devbind.rst
> @@ -30,11 +30,11 @@ OPTIONS
>          Print the current status of all known network interfaces.
>          For each device, it displays the PCI domain, bus, slot and function,
>          along with a text description of the device. Depending upon whether the
> -        device is being used by a kernel driver, the ``igb_uio`` driver, or no
> +        device is being used by a kernel driver, the ``vfio_pci`` driver, or no
>          driver, other relevant information will be displayed:
>          - the Linux interface name e.g. ``if=eth0``
> -        - the driver being used e.g. ``drv=igb_uio``
> -        - any suitable drivers not currently using that device e.g. ``unused=igb_uio``
> +        - the driver being used e.g. ``drv=vfio_pci``
> +        - any suitable drivers not currently using that device e.g. ``unused=vfio_pci``
>          NOTE: if this flag is passed along with a bind/unbind option, the
>          status display will always occur after the other operations have taken
>          place.
> @@ -69,7 +69,7 @@ OPTIONS
>  
>  .. warning::
>  
> -    While any user can run the ``dpdk-devbind.py`` script to view the status of the network ports,
> +    While any user can run the ``dpdk-devbind`` script to view the status of the network ports,
>      binding or unbinding network ports requires root privileges.

Agree with all the replacements of igb_uio with vfio, but why remove the
.py suffix here? The script won't run without giving its full name, so this
removal seems unhelpful to the user.
Stephen Hemminger Sept. 7, 2020, 5:22 p.m. UTC | #2
On Mon, 7 Sep 2020 10:08:16 +0100
Bruce Richardson <bruce.richardson@intel.com> wrote:

> Agree with all the replacements of igb_uio with vfio, but why remove the
> .py suffix here? The script won't run without giving its full name, so this
> removal seems unhelpful to the user.

My misunderstanding, thought the install process was stripping the .py suffix

Patch
diff mbox series

diff --git a/doc/guides/tools/devbind.rst b/doc/guides/tools/devbind.rst
index a2910e103aab..52690f018648 100644
--- a/doc/guides/tools/devbind.rst
+++ b/doc/guides/tools/devbind.rst
@@ -30,11 +30,11 @@  OPTIONS
         Print the current status of all known network interfaces.
         For each device, it displays the PCI domain, bus, slot and function,
         along with a text description of the device. Depending upon whether the
-        device is being used by a kernel driver, the ``igb_uio`` driver, or no
+        device is being used by a kernel driver, the ``vfio_pci`` driver, or no
         driver, other relevant information will be displayed:
         - the Linux interface name e.g. ``if=eth0``
-        - the driver being used e.g. ``drv=igb_uio``
-        - any suitable drivers not currently using that device e.g. ``unused=igb_uio``
+        - the driver being used e.g. ``drv=vfio_pci``
+        - any suitable drivers not currently using that device e.g. ``unused=vfio_pci``
         NOTE: if this flag is passed along with a bind/unbind option, the
         status display will always occur after the other operations have taken
         place.
@@ -69,7 +69,7 @@  OPTIONS
 
 .. warning::
 
-    While any user can run the ``dpdk-devbind.py`` script to view the status of the network ports,
+    While any user can run the ``dpdk-devbind`` script to view the status of the network ports,
     binding or unbinding network ports requires root privileges.
 
 
@@ -80,9 +80,9 @@  To display current device status::
 
    dpdk-devbind --status
 
-To bind eth1 from the current driver and move to use igb_uio::
+To bind eth1 from the current driver and move to use vfio_pci::
 
-   dpdk-devbind --bind=igb_uio eth1
+   dpdk-devbind --bind=vfio_pci eth1
 
 To unbind 0000:01:00.0 from using any driver::
 
@@ -92,7 +92,7 @@  To bind 0000:02:00.0 and 0000:02:00.1 to the ixgbe kernel driver::
 
    dpdk-devbind -b ixgbe 02:00.0 02:00.1
 
-To check status of all network ports, assign one to the igb_uio driver and check status again::
+To check status of all network ports, assign one to the vfio_pci driver and check status again::
 
    # Check the status of the available devices.
    dpdk-devbind --status
@@ -105,12 +105,12 @@  To check status of all network ports, assign one to the igb_uio driver and check
    0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
 
 
-   # Bind the device to igb_uio.
-   sudo dpdk-devbind -b igb_uio 0000:0a:00.0
+   # Bind the device to vfio_pci.
+   sudo dpdk-devbind -b vfio_pci 0000:0a:00.0
 
 
    # Recheck the status of the devices.
    dpdk-devbind --status
    Network devices using DPDK-compatible driver
    ============================================
-   0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
+   0000:0a:00.0 '82599ES 10-Gigabit' drv=vfio_pci unused=