[v4,1/3] doc: make the Linux drivers doc more generic

Message ID 20221128231940.15961-2-nicolas.chautru@intel.com (mailing list archive)
State Superseded
Delegated to: Thomas Monjalon
Headers
Series doc: simplify bbdev PMD steps |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Chautru, Nicolas Nov. 28, 2022, 11:19 p.m. UTC
  Minor change so that for the documentation to be less NIC centric,
as these steps can apply more generally to PCIe devices.

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
 doc/guides/linux_gsg/linux_drivers.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
  

Comments

Stephen Hemminger July 16, 2023, 6:22 p.m. UTC | #1
On Mon, 28 Nov 2022 15:19:38 -0800
Nicolas Chautru <nicolas.chautru@intel.com> wrote:

> Minor change so that for the documentation to be less NIC centric,
> as these steps can apply more generally to PCIe devices.
> 
> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>

Acked-by: Stephen Hemminger <stephen@networkplumber.org>
  

Patch

diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index 2f3f079aab..7d73893e5a 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -12,12 +12,12 @@  Linux Drivers
 
 Different PMDs may require different kernel drivers in order to work properly.
 Depending on the PMD being used, a corresponding kernel driver should be loaded,
-and network ports should be bound to that driver.
+and network ports or other hardware devices should be bound to that driver.
 
 .. _linux_gsg_binding_kernel:
 
-Binding and Unbinding Network Ports to/from the Kernel Modules
---------------------------------------------------------------
+Binding and Unbinding to/from the Kernel Modules
+------------------------------------------------
 
 .. note::
 
@@ -39,7 +39,7 @@  For such PMDs, any network ports or other hardware under Linux* control will be
 To bind ports to the ``vfio-pci`` module
 for DPDK use, or to return ports to Linux control,
 a utility script called ``dpdk-devbind.py`` is provided in the ``usertools`` subdirectory.
-This utility can be used to provide a view of the current state of the network ports on the system,
+This utility can be used to provide a view of the current state of the devices on the system,
 and to bind and unbind those ports from the different kernel modules,
 including the VFIO and UIO modules.
 The following are some examples of how the script can be used.
@@ -65,10 +65,10 @@  should be loaded into the kernel before running the ``dpdk-devbind.py`` script.
 .. note::
 
    While any user can run the ``dpdk-devbind.py`` script
-   to view the status of the network ports,
-   binding or unbinding network ports requires root privileges.
+   to view the status of the devices,
+   binding or unbinding devices requires root privileges.
 
-To see the status of all network ports on the system:
+To see the status of all devices on the system:
 
 .. code-block:: console