From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id B1F3BA04BA; Fri, 2 Oct 2020 17:52:50 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 30F911D957; Fri, 2 Oct 2020 17:52:49 +0200 (CEST) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 5C3D21D950 for ; Fri, 2 Oct 2020 17:52:46 +0200 (CEST) IronPort-SDR: ZVGf2TpWa6LROGyI9Ka4RK4ESofrWocsX+X6tdxBAiRrETdHdX+D/CzguCMI+9YNfXUgCZB1rk Qij25FElXbPg== X-IronPort-AV: E=McAfee;i="6000,8403,9762"; a="247757068" X-IronPort-AV: E=Sophos;i="5.77,328,1596524400"; d="scan'208";a="247757068" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Oct 2020 08:52:44 -0700 IronPort-SDR: Fg7up6tHsOs9BiS7rdL+MI95KYQc1ogtkPjNhzmoPGnjydDcVafOMZzGGXh9ekMDWBE7mPcx1V 5S5c1Sm+v+Rg== X-IronPort-AV: E=Sophos;i="5.77,328,1596524400"; d="scan'208";a="313545411" Received: from bricha3-mobl.ger.corp.intel.com ([10.213.30.87]) by orsmga006-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-SHA; 02 Oct 2020 08:52:40 -0700 Date: Fri, 2 Oct 2020 16:52:37 +0100 From: Bruce Richardson To: Robin Jarry Cc: Kevin Laatz , Maxime Coquelin , Chenbo Xia , Zhihong Wang , Ray Kinsella , Neil Horman , Nicolas Chautru , dev@dpdk.org, David Marchand Message-ID: <20201002155237.GC1325@bricha3-MOBL.ger.corp.intel.com> References: <20201002154753.1015-1-robin.jarry@6wind.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20201002154753.1015-1-robin.jarry@6wind.com> Subject: Re: [dpdk-dev] [PATCH] doc: remove references to python 2 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 > --- > 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 `_. > 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