diff options
Diffstat (limited to 'doc/guides/linux_gsg')
| -rw-r--r-- | doc/guides/linux_gsg/build_dpdk.rst | 14 | ||||
| -rw-r--r-- | doc/guides/linux_gsg/nic_perf_intel_platform.rst | 6 | ||||
| -rw-r--r-- | doc/guides/linux_gsg/quick_start.rst | 12 |
3 files changed, 16 insertions, 16 deletions
diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst index fb2c481d..f8007b31 100644 --- a/doc/guides/linux_gsg/build_dpdk.rst +++ b/doc/guides/linux_gsg/build_dpdk.rst @@ -198,7 +198,7 @@ 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). 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 setup.sh and located in the tools directory). +This can be done by using the DPDK setup script (called dpdk-setup.sh and located in the tools directory). .. _linux_gsg_binding_kernel: @@ -224,7 +224,7 @@ and to bind and unbind those ports from the different kernel modules, including The following are some examples of how the script can be used. A full description of the script and its parameters can be obtained by calling the script with the ``--help`` or ``--usage`` options. Note that the uio or vfio kernel modules to be used, should be loaded into the kernel before -running the ``dpdk_nic_bind.py`` script. +running the ``dpdk-devbind.py`` script. .. warning:: @@ -238,14 +238,14 @@ running the ``dpdk_nic_bind.py`` script. .. warning:: - While any user can run the dpdk_nic_bind.py script to view the status of the network ports, + 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 see the status of all network ports on the system: .. code-block:: console - ./tools/dpdk_nic_bind.py --status + ./tools/dpdk-devbind.py --status Network devices using DPDK-compatible driver ============================================ @@ -267,16 +267,16 @@ To bind device ``eth1``,``04:00.1``, to the ``uio_pci_generic`` driver: .. code-block:: console - ./tools/dpdk_nic_bind.py --bind=uio_pci_generic 04:00.1 + ./tools/dpdk-devbind.py --bind=uio_pci_generic 04:00.1 or, alternatively, .. code-block:: console - ./tools/dpdk_nic_bind.py --bind=uio_pci_generic eth1 + ./tools/dpdk-devbind.py --bind=uio_pci_generic eth1 To restore device ``82:00.0`` to its original kernel binding: .. code-block:: console - ./tools/dpdk_nic_bind.py --bind=ixgbe 82:00.0 + ./tools/dpdk-devbind.py --bind=ixgbe 82:00.0 diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst b/doc/guides/linux_gsg/nic_perf_intel_platform.rst index b4337324..d4a83624 100644 --- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst +++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst @@ -192,12 +192,12 @@ Configurations before running DPDK # Bind ports 82:00.0 and 85:00.0 to dpdk driver - ./dpdk_folder/tools/dpdk_nic_bind.py -b igb_uio 82:00.0 85:00.0 + ./dpdk_folder/tools/dpdk-devbind.py -b igb_uio 82:00.0 85:00.0 # Check the port driver status - ./dpdk_folder/tools/dpdk_nic_bind.py --status + ./dpdk_folder/tools/dpdk-devbind.py --status - See ``dpdk_nic_bind.py --help`` for more details. + See ``dpdk-devbind.py --help`` for more details. More details about DPDK setup and Linux kernel requirements see :ref:`linux_gsg_compiling_dpdk`. diff --git a/doc/guides/linux_gsg/quick_start.rst b/doc/guides/linux_gsg/quick_start.rst index 1e0f8ff3..8789b588 100644 --- a/doc/guides/linux_gsg/quick_start.rst +++ b/doc/guides/linux_gsg/quick_start.rst @@ -33,7 +33,7 @@ Quick Start Setup Script ======================== -The setup.sh script, found in the tools subdirectory, allows the user to perform the following tasks: +The dpdk-setup.sh script, found in the tools subdirectory, allows the user to perform the following tasks: * Build the DPDK libraries @@ -63,7 +63,7 @@ the user may compile their own application that links in the EAL libraries to cr Script Organization ------------------- -The setup.sh script is logically organized into a series of steps that a user performs in sequence. +The dpdk-setup.sh script is logically organized into a series of steps that a user performs in sequence. Each step provides a number of options that guide the user to completing the desired task. The following is a brief synopsis of each step. @@ -98,17 +98,17 @@ The final step has options for restoring the system to its original state. Use Cases --------- -The following are some example of how to use the setup.sh script. +The following are some example of how to use the dpdk-setup.sh script. The script should be run using the source command. Some options in the script prompt the user for further data before proceeding. .. warning:: - The setup.sh script should be run with root privileges. + The dpdk-setup.sh script should be run with root privileges. .. code-block:: console - source tools/setup.sh + source tools/dpdk-setup.sh ------------------------------------------------------------------------ @@ -269,7 +269,7 @@ The following selection demonstrates the launch of the test application to run o Applications ------------ -Once the user has run the setup.sh script, built one of the EAL targets and set up hugepages (if using one of the Linux EAL targets), +Once the user has run the dpdk-setup.sh script, built one of the EAL targets and set up hugepages (if using one of the Linux EAL targets), the user can then move on to building and running their application or one of the examples provided. The examples in the /examples directory provide a good starting point to gain an understanding of the operation of the DPDK. |