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 A92FAA04BA; Fri, 2 Oct 2020 17:48:04 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4626D1D946; Fri, 2 Oct 2020 17:48:03 +0200 (CEST) Received: from mail-wr1-f41.google.com (mail-wr1-f41.google.com [209.85.221.41]) by dpdk.org (Postfix) with ESMTP id 2325E1D6F8 for ; Fri, 2 Oct 2020 17:48:01 +0200 (CEST) Received: by mail-wr1-f41.google.com with SMTP id c18so2322834wrm.9 for ; Fri, 02 Oct 2020 08:48:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind.com; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=nepYgKZWyrMmO2ZfvpTx7T6Eo1cxXvF4vZHcltRnlGA=; b=jgVw4tZoqQ+eL1f5+RKZu8ale25uhB+7q71b/bIGmKF5s+9le5lXmkOPOmkdFV0ewv Fw9fuJpltgohnX+9EgtwEJbcx16CbFe4p19nKI88Uf0XlhRm3FEIniz3IzQMrBT6q/N3 sAimkmo1HWuMB51Im+rL7xZ8xJ1/dUJPInis10OeYubCt2uRWDORbalUOip3fHdirxEB d08TsvVr/6ob/Cyx9hYIfjyS7gWAa7+cBYSZ61azzdgJzVzptxFxCaL2A6hSon+ZEFRG HLQqjJz5wiO5HfsZDa859rbFu9UhSvjZ1I4aAOqg7OwQ3Rwn+pTOSkQOZxyOAEWBdnaK cnmQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=nepYgKZWyrMmO2ZfvpTx7T6Eo1cxXvF4vZHcltRnlGA=; b=SbeAJSt2BSRldQu+Ep27gW3kTRKKhRrj9/jsRXobH4hLG7YAhE/8qlgpNxvE2qW0EG I8EHyfw5Em/qh96Tnl+iP25FPPPcrP6DFTv2sDOtxgttSMKxBpFuLnUdgVVATbXsZYnc LhLXhrFi8wpm90u5TauamFFvDwlrOQ0EcLayjYD36O38NQugTlClrdZ6Roozc65mc9rb uLatRgCZISahoh/du9Zh0zH4w3jqfC5Qvko5/c10v4emlyqhcdKhn0VoLTWI+F+6FMJG kt4EZIrp+8pFUVaZrcUqC5zIG+zH455Li21z1GRSsFhsl0vbAusLuS4nDgn33FRIZA3U xKGg== X-Gm-Message-State: AOAM532DhxfsmJtRGkVeLexoO+/R392ulFZXP1//XpReTWjn8iFMsZ4w 7o8uUAnaWp2r+Pjfo2PL/SZIfA== X-Google-Smtp-Source: ABdhPJwEM70SSv31KIm8VlLKHFHh7ulDoRo0M1wkPJP2v16YSEdmlqTlGXZorzVTZxPX7prEeHe6pA== X-Received: by 2002:adf:e9c1:: with SMTP id l1mr3836604wrn.68.1601653679765; Fri, 02 Oct 2020 08:47:59 -0700 (PDT) Received: from tom.dev.6wind.com. (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id d23sm2088872wmb.6.2020.10.02.08.47.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 Oct 2020 08:47:59 -0700 (PDT) From: Robin Jarry To: Kevin Laatz , Maxime Coquelin , Chenbo Xia , Zhihong Wang , Ray Kinsella , Neil Horman , Nicolas Chautru Cc: dev@dpdk.org, David Marchand Date: Fri, 2 Oct 2020 17:47:53 +0200 Message-Id: <20201002154753.1015-1-robin.jarry@6wind.com> X-Mailer: git-send-email 2.28.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [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" 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 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