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

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

Commit Message

Ben Pfaff Sept. 18, 2019, 3:47 p.m. UTC
---
 .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

0-day Robot Sept. 18, 2019, 7:05 p.m. UTC | #1
Bleep bloop.  Greetings Ben Pfaff, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


checkpatch:
ERROR: Author Ben Pfaff <blp@ovn.org> needs to sign off.
Lines checked: 95, Warnings: 0, Errors: 1


Please check this out.  If you feel there has been an error, please email aconole@redhat.com

Thanks,
0-day Robot

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