[ovs-dev,v2,python3,4/6] Recommend Sphinx from Python 3 in documentation and packaging.
diff mbox series

Message ID 20190918233322.24305-5-blp@ovn.org
State New
Headers show
Series
  • Remove Python 2 support
Related show

Commit Message

Ben Pfaff Sept. 18, 2019, 11:33 p.m. UTC
Signed-off-by: Ben Pfaff <blp@ovn.org>
---
 .travis.yml                                   | 2 +-
 Documentation/intro/install/documentation.rst | 6 +++---
 Documentation/intro/install/rhel.rst          | 2 +-
 rhel/openvswitch-fedora.spec.in               | 2 +-
 rhel/openvswitch.spec.in                      | 2 +-
 5 files changed, 7 insertions(+), 7 deletions(-)

Comments

Numan Siddique Sept. 20, 2019, 5:31 a.m. UTC | #1
On Thu, Sep 19, 2019 at 7:31 AM Ben Pfaff <blp@ovn.org> wrote:

> Signed-off-by: Ben Pfaff <blp@ovn.org>
> ---
>  .travis.yml                                   | 2 +-
>  Documentation/intro/install/documentation.rst | 6 +++---
>  Documentation/intro/install/rhel.rst          | 2 +-
>  rhel/openvswitch-fedora.spec.in               | 2 +-
>  rhel/openvswitch.spec.in                      | 2 +-
>  5 files changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/.travis.yml b/.travis.yml
> index 370b3d0a6c98..68026312ba84 100644
> --- a/.travis.yml
> +++ b/.travis.yml
> @@ -20,7 +20,7 @@ addons:
>        - libjemalloc1
>        - libjemalloc-dev
>        - libnuma-dev
> -      - python-sphinx
> +      - python3-sphinx
>        - libelf-dev
>        - selinux-policy-dev
>        - libunbound-dev
> diff --git a/Documentation/intro/install/documentation.rst
> b/Documentation/intro/install/documentation.rst
> index d7eb25d9ef06..acf5b3a3ff33 100644
> --- a/Documentation/intro/install/documentation.rst
> +++ b/Documentation/intro/install/documentation.rst
> @@ -45,11 +45,11 @@ Sphinx. A detailed guide on installing Sphinx in many
> environments is available
>  on the `Sphinx website`__ but, for most Linux distributions, you can
> install
>  with your package manager. For example, on Debian/Ubuntu run::
>
> -    $ sudo apt-get install python-sphinx
> +    $ sudo apt-get install python3-sphinx
>
>  Similarly, on RHEL/Fedora run::
>
> -    $ sudo dnf install python-sphinx
> +    $ sudo dnf install python3-sphinx
>
>  A ``requirements.txt`` is also provided in the ``/Documentation``, should
> you
>  wish to install using ``pip``::
> @@ -71,7 +71,7 @@ available on the `Sphinx website`__.
>  Building
>  --------
>
> -Once Sphinx installed, the documentation can be built using the provided
> +Once Sphinx is installed, the documentation can be built using the
> provided
>  Makefile targets::
>
>      $ make docs-check
> diff --git a/Documentation/intro/install/rhel.rst
> b/Documentation/intro/install/rhel.rst
> index 6f062e89446a..0e5ca2743ef5 100644
> --- a/Documentation/intro/install/rhel.rst
> +++ b/Documentation/intro/install/rhel.rst
> @@ -89,7 +89,7 @@ And to install specific dependencies, use yum-builddep
> tool::
>
>  Once that is completed, remove the file ``/tmp/ovs.spec``.
>
> -If python-sphinx package is not available in your version of RHEL, you can
> +If python3-sphinx package is not available in your version of RHEL, you
> can
>  install it via pip with 'pip install sphinx'.
>
>  Open vSwitch requires python 2.7 or newer which is not available in older
> diff --git a/rhel/openvswitch-fedora.spec.in b/rhel/
> openvswitch-fedora.spec.in
> index 9c752ff4ed4e..9c407123296a 100644
> --- a/rhel/openvswitch-fedora.spec.in
> +++ b/rhel/openvswitch-fedora.spec.in
> @@ -79,7 +79,7 @@ BuildRequires: python3-devel
>  BuildRequires: desktop-file-utils
>  BuildRequires: groff graphviz
>  BuildRequires: checkpolicy, selinux-policy-devel
> -BuildRequires: /usr/bin/sphinx-build
> +BuildRequires: /usr/bin/sphinx3-build
>

This needs to be changed to - /usr/bin/sphinx-build-3

make rpm-fedora is failing for me.

The python3-sphinx rpm package install /usr/bin/sphinx-build-3.


Thanks
Numan


>  # make check dependencies
>  BuildRequires: %{_py2}-twisted%{?rhel:-core} %{_py2}-zope-interface
> %{_py2}-six
>  BuildRequires: procps-ng
> diff --git a/rhel/openvswitch.spec.in b/rhel/openvswitch.spec.in
> index c8361f5f29ff..7f27fedd6886 100644
> --- a/rhel/openvswitch.spec.in
> +++ b/rhel/openvswitch.spec.in
> @@ -37,7 +37,7 @@ BuildRequires: python-six
>  BuildRequires: openssl-devel
>  BuildRequires: checkpolicy, selinux-policy-devel
>  BuildRequires: autoconf, automake, libtool
> -BuildRequires: python-sphinx
> +BuildRequires: python3-sphinx
>  BuildRequires: unbound-devel
>
>  %bcond_without check
> --
> 2.21.0
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>

Patch
diff mbox series

diff --git a/.travis.yml b/.travis.yml
index 370b3d0a6c98..68026312ba84 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -20,7 +20,7 @@  addons:
       - libjemalloc1
       - libjemalloc-dev
       - libnuma-dev
-      - python-sphinx
+      - python3-sphinx
       - libelf-dev
       - selinux-policy-dev
       - libunbound-dev
diff --git a/Documentation/intro/install/documentation.rst b/Documentation/intro/install/documentation.rst
index d7eb25d9ef06..acf5b3a3ff33 100644
--- a/Documentation/intro/install/documentation.rst
+++ b/Documentation/intro/install/documentation.rst
@@ -45,11 +45,11 @@  Sphinx. A detailed guide on installing Sphinx in many environments is available
 on the `Sphinx website`__ but, for most Linux distributions, you can install
 with your package manager. For example, on Debian/Ubuntu run::
 
-    $ sudo apt-get install python-sphinx
+    $ sudo apt-get install python3-sphinx
 
 Similarly, on RHEL/Fedora run::
 
-    $ sudo dnf install python-sphinx
+    $ sudo dnf install python3-sphinx
 
 A ``requirements.txt`` is also provided in the ``/Documentation``, should you
 wish to install using ``pip``::
@@ -71,7 +71,7 @@  available on the `Sphinx website`__.
 Building
 --------
 
-Once Sphinx installed, the documentation can be built using the provided
+Once Sphinx is installed, the documentation can be built using the provided
 Makefile targets::
 
     $ make docs-check
diff --git a/Documentation/intro/install/rhel.rst b/Documentation/intro/install/rhel.rst
index 6f062e89446a..0e5ca2743ef5 100644
--- a/Documentation/intro/install/rhel.rst
+++ b/Documentation/intro/install/rhel.rst
@@ -89,7 +89,7 @@  And to install specific dependencies, use yum-builddep tool::
 
 Once that is completed, remove the file ``/tmp/ovs.spec``.
 
-If python-sphinx package is not available in your version of RHEL, you can
+If python3-sphinx package is not available in your version of RHEL, you can
 install it via pip with 'pip install sphinx'.
 
 Open vSwitch requires python 2.7 or newer which is not available in older
diff --git a/rhel/openvswitch-fedora.spec.in b/rhel/openvswitch-fedora.spec.in
index 9c752ff4ed4e..9c407123296a 100644
--- a/rhel/openvswitch-fedora.spec.in
+++ b/rhel/openvswitch-fedora.spec.in
@@ -79,7 +79,7 @@  BuildRequires: python3-devel
 BuildRequires: desktop-file-utils
 BuildRequires: groff graphviz
 BuildRequires: checkpolicy, selinux-policy-devel
-BuildRequires: /usr/bin/sphinx-build
+BuildRequires: /usr/bin/sphinx3-build
 # make check dependencies
 BuildRequires: %{_py2}-twisted%{?rhel:-core} %{_py2}-zope-interface %{_py2}-six
 BuildRequires: procps-ng
diff --git a/rhel/openvswitch.spec.in b/rhel/openvswitch.spec.in
index c8361f5f29ff..7f27fedd6886 100644
--- a/rhel/openvswitch.spec.in
+++ b/rhel/openvswitch.spec.in
@@ -37,7 +37,7 @@  BuildRequires: python-six
 BuildRequires: openssl-devel
 BuildRequires: checkpolicy, selinux-policy-devel
 BuildRequires: autoconf, automake, libtool
-BuildRequires: python-sphinx
+BuildRequires: python3-sphinx
 BuildRequires: unbound-devel
 
 %bcond_without check