On Fri, Oct 02, 2020 at 05:47:53PM +0200, Robin Jarry wrote:
> Python 2 support has now been dropped. Remove references to it in the
> documentation.
>
> Since all python scripts now have a proper shebang that calls python3,
> execute the scripts directly without specifying the interpreter.
>
> Sphinx version from most Linux distros is OK in 2020, do not encourage
> people to break their system by installing with pip. Use the distros
> official packages.
>
> Signed-off-by: Robin Jarry <robin.ja...@6wind.com>
> ---
> doc/guides/conf.py | 2 +-
> doc/guides/contributing/documentation.rst | 8 ++------
> doc/guides/howto/telemetry.rst | 2 +-
> doc/guides/nics/virtio.rst | 4 ++--
> doc/guides/rel_notes/deprecation.rst | 4 ++--
> doc/guides/tools/testbbdev.rst | 2 +-
> 6 files changed, 9 insertions(+), 13 deletions(-)
>
> diff --git a/doc/guides/conf.py b/doc/guides/conf.py
> index ef550f68c056..270754b90131 100644
> --- a/doc/guides/conf.py
> +++ b/doc/guides/conf.py
> @@ -22,7 +22,7 @@
> 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'
> diff --git a/doc/guides/contributing/documentation.rst
> b/doc/guides/contributing/documentation.rst
> index 375ea64ba8ee..be985e6cf87a 100644
> --- a/doc/guides/contributing/documentation.rst
> +++ b/doc/guides/contributing/documentation.rst
> @@ -164,14 +164,10 @@ For full support with figure and table captioning the
> latest version of Sphinx c
> .. 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
Minor nit, I see no reason to preserve the big whitespace gap here.
>
> For further information on getting started with Sphinx see the
> `Sphinx Getting Started
> <http://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
> diff --git a/doc/guides/howto/telemetry.rst b/doc/guides/howto/telemetry.rst
> index e7b5434152de..cf73dc41ce6b 100644
> --- a/doc/guides/howto/telemetry.rst
> +++ b/doc/guides/howto/telemetry.rst
> @@ -50,7 +50,7 @@ and query information using the telemetry client python
> script.
>
> #. 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::
>
> diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
> index 33ce0c247e5f..4477c1c16088 100644
> --- a/doc/guides/nics/virtio.rst
> +++ b/doc/guides/nics/virtio.rst
> @@ -154,7 +154,7 @@ Host2VM communication example
> 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.
>
> @@ -329,7 +329,7 @@ To support Rx interrupts,
>
> .. 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
> ~~~~~~~
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 0be208edcad8..8080a28896ad 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -14,8 +14,8 @@ Deprecation Notices
> * 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.
> diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst
> index 393c3e9d0d24..99692314513f 100644
> --- a/doc/guides/tools/testbbdev.rst
> +++ b/doc/guides/tools/testbbdev.rst
> @@ -43,7 +43,7 @@ The tool application has a number of command line options:
>
> .. 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]
> --
> 2.28.0
>
Acked-by: Bruce Richardson <bruce.richard...@intel.com>
