html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
except:
print('Install the sphinx ReadTheDocs theme for improved html documentation '
- 'layout: pip install sphinx_rtd_theme')
+ 'layout: https://sphinx-rtd-theme.readthedocs.io/')
pass
project = 'Data Plane Development Kit'
.. code-block:: console
# Ubuntu/Debian.
- sudo apt-get -y install python-pip
- sudo pip install --upgrade sphinx
- sudo pip install --upgrade sphinx_rtd_theme
+ sudo apt-get -y install python3-sphinx python3-sphinx-rtd-theme
# Red Hat/Fedora.
- sudo dnf -y install python-pip
- sudo pip install --upgrade sphinx
- sudo pip install --upgrade sphinx_rtd_theme
+ sudo dnf -y install python3-sphinx python3-sphinx_rtd_theme
For further information on getting started with Sphinx see the
`Sphinx Getting Started <http://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
#. Launch the telemetry client script::
- python usertools/dpdk-telemetry.py
+ ./usertools/dpdk-telemetry.py
#. When connected, the script displays the following, waiting for user input::
modprobe uio
echo 512 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
modprobe uio_pci_generic
- python usertools/dpdk-devbind.py -b uio_pci_generic 00:03.0
+ ./usertools/dpdk-devbind.py -b uio_pci_generic 00:03.0
We use testpmd as the forwarding application in this example.
.. code-block:: console
- python usertools/dpdk-devbind.py -b vfio-pci 00:03.0
+ ./usertools/dpdk-devbind.py -b vfio-pci 00:03.0
Example
~~~~~~~
* meson: The minimum supported version of meson for configuring and building
DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
those users with a version earlier than 0.47.1, an updated copy of meson
- can be got using the ``pip``, or ``pip3``, tool for downloading python
- packages.
+ can be got using the ``pip3`` tool (or ``python3 -m pip``) for downloading
+ python packages.
* kvargs: The function ``rte_kvargs_process`` will get a new parameter
for returning key match count. It will ease handling of no-match case.
.. code-block:: console
- python test-bbdev.py [-h] [-p TESTAPP_PATH] [-e EAL_PARAMS] [-t TIMEOUT]
+ test-bbdev.py [-h] [-p TESTAPP_PATH] [-e EAL_PARAMS] [-t TIMEOUT]
[-c TEST_CASE [TEST_CASE ...]]
[-v TEST_VECTOR [TEST_VECTOR...]] [-n NUM_OPS]
[-b BURST_SIZE [BURST_SIZE ...]] [-l NUM_LCORES]