[PATCH] docs: update requirements to install six module

[PATCH] docs: update requirements to install six module

[JaeSang Yoo]

On the update of Sphinx version to 2.4.4, the "six" library won't be
installed automatically. (which is required by kfigure.py)

Main reason of this issue were occurred by the requirements changed from
the sphinx library. In Sphinx v1.7.9, six was listed on the
install_requires, but it has been removed since 2.x

The kfigure.py uses six library explicitly, adding six to
requirements.txt seems reasonable

Signed-off-by: JaeSang Yoo <jsyoo5b@gmail.com>
---
 Documentation/sphinx/requirements.txt | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
index 489f6626de67..5030d346d23b 100644
--- a/Documentation/sphinx/requirements.txt
+++ b/Documentation/sphinx/requirements.txt
@@ -1,3 +1,4 @@
 docutils
 Sphinx==2.4.4
 sphinx_rtd_theme
+six
-- 
2.25.1

Re: [PATCH] docs: update requirements to install six module

[Mauro Carvalho Chehab]

Em Tue, 8 Dec 2020 10:46:28 +0900
JaeSang Yoo <js.yoo.5b@gmail.com> escreveu:

> On the update of Sphinx version to 2.4.4, the "six" library won't be
> installed automatically. (which is required by kfigure.py)
> 
> Main reason of this issue were occurred by the requirements changed from
> the sphinx library. In Sphinx v1.7.9, six was listed on the
> install_requires, but it has been removed since 2.x
> 
> The kfigure.py uses six library explicitly, adding six to
> requirements.txt seems reasonable
> 
> Signed-off-by: JaeSang Yoo <jsyoo5b@gmail.com>

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> ---
>  Documentation/sphinx/requirements.txt | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
> index 489f6626de67..5030d346d23b 100644
> --- a/Documentation/sphinx/requirements.txt
> +++ b/Documentation/sphinx/requirements.txt
> @@ -1,3 +1,4 @@
>  docutils
>  Sphinx==2.4.4
>  sphinx_rtd_theme
> +six



Thanks,
Mauro

Re: [PATCH] docs: update requirements to install six module

[Jonathan Corbet]

On Tue, 8 Dec 2020 10:46:28 +0900
JaeSang Yoo <js.yoo.5b@gmail.com> wrote:

> On the update of Sphinx version to 2.4.4, the "six" library won't be
> installed automatically. (which is required by kfigure.py)
> 
> Main reason of this issue were occurred by the requirements changed from
> the sphinx library. In Sphinx v1.7.9, six was listed on the
> install_requires, but it has been removed since 2.x
> 
> The kfigure.py uses six library explicitly, adding six to
> requirements.txt seems reasonable
> 
> Signed-off-by: JaeSang Yoo <jsyoo5b@gmail.com>
> ---
>  Documentation/sphinx/requirements.txt | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
> index 489f6626de67..5030d346d23b 100644
> --- a/Documentation/sphinx/requirements.txt
> +++ b/Documentation/sphinx/requirements.txt
> @@ -1,3 +1,4 @@
>  docutils
>  Sphinx==2.4.4
>  sphinx_rtd_theme
> +six

Sigh...what we really need to do is to leave Python 2 behind.  Until then,
though, we need to install "six".  Patch applied, thanks.

jon

Re: [PATCH] docs: update requirements to install six module

[JaeSang Yoo]

On Thu, Dec 10, 2020 at 9:29 AM Jonathan Corbet <corbet@lwn.net> wrote:
>
> On Tue, 8 Dec 2020 10:46:28 +0900
> JaeSang Yoo <js.yoo.5b@gmail.com> wrote:
>
> > On the update of Sphinx version to 2.4.4, the "six" library won't be
> > installed automatically. (which is required by kfigure.py)
> >
> > Main reason of this issue were occurred by the requirements changed from
> > the sphinx library. In Sphinx v1.7.9, six was listed on the
> > install_requires, but it has been removed since 2.x
> >
> > The kfigure.py uses six library explicitly, adding six to
> > requirements.txt seems reasonable
> >
> > Signed-off-by: JaeSang Yoo <jsyoo5b@gmail.com>
> > ---
> >  Documentation/sphinx/requirements.txt | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
> > index 489f6626de67..5030d346d23b 100644
> > --- a/Documentation/sphinx/requirements.txt
> > +++ b/Documentation/sphinx/requirements.txt
> > @@ -1,3 +1,4 @@
> >  docutils
> >  Sphinx==2.4.4
> >  sphinx_rtd_theme
> > +six
>
> Sigh...what we really need to do is to leave Python 2 behind.  Until then,
> though, we need to install "six".  Patch applied, thanks.

While I was surveying the Sphinx library, it requires Python version
3.5 as a minimum.
You can figure it out in the setup.py of Sphinx library source:
https://github.com/sphinx-doc/sphinx/blob/72ad5f2a/setup.py#L13-L15

I assume this would be a certain reason to leave Python 2 behind. The
Sphinx check script recommends using virtualenv. How do you think
about leaving Python 2 compatibility issue in this documentation
script range?
> jon

Re: [PATCH] docs: update requirements to install six module

[Jonathan Corbet]

On Thu, 10 Dec 2020 12:39:42 +0900
JaeSang Yoo <js.yoo.5b@gmail.com> wrote:

> While I was surveying the Sphinx library, it requires Python version
> 3.5 as a minimum.
> You can figure it out in the setup.py of Sphinx library source:
> https://github.com/sphinx-doc/sphinx/blob/72ad5f2a/setup.py#L13-L15

That, of course, applies to current Sphinx releases. We have people
building with older releases, though, which still work with Python 2.

> I assume this would be a certain reason to leave Python 2 behind. The
> Sphinx check script recommends using virtualenv. How do you think
> about leaving Python 2 compatibility issue in this documentation
> script range?

I'm sorry, I don't quite understand your question.

Thanks,

jon

Re: [PATCH] docs: update requirements to install six module

[JaeSang Yoo]

On Fri, Dec 11, 2020 at 8:02 AM Jonathan Corbet <corbet@lwn.net> wrote:
>
> On Thu, 10 Dec 2020 12:39:42 +0900
> JaeSang Yoo <js.yoo.5b@gmail.com> wrote:
>
> > While I was surveying the Sphinx library, it requires Python version
> > 3.5 as a minimum.
> > You can figure it out in the setup.py of Sphinx library source:
> > https://github.com/sphinx-doc/sphinx/blob/72ad5f2a/setup.py#L13-L15
>
> That, of course, applies to current Sphinx releases. We have people
> building with older releases, though, which still work with Python 2.
>
Is this meaning that some people are using older Sphinx?
Then, there's no chance to leave from Python2.
By the way, the previous linked commit ID is tagged as v2.4.4
which is selected in requirements.txt

> > I assume this would be a certain reason to leave Python 2 behind. The
> > Sphinx check script recommends using virtualenv. How do you think
> > about leaving Python 2 compatibility issue in this documentation
> > script range?
>
> I'm sorry, I don't quite understand your question.
Sorry for my poor English writings.

I thought most users are using virtualenv. As you know that virtualenv will
help using the specific version of Python libraries and the Python
interpreter's version.

I'll try to describe what I tried to say.
1. The Sphinx check script recommends using virtualenv for preparing
    Sphinx document generation environment.
2. By the virtualenv, we can isolate the Python libraries and the
interpreter's version.
    (for the Sphinx documentation build)
3. When all the people are using the virtualenv, It will install Sphinx v2.4.4,
    which doesn't support Python2.
4. The Sphinx installation will fail for Python2 users.
    And it could lead to "no need to consider Python2 compatibility"

But as you told me above, Step 3 seems false. Still, we need to
consider Python2.

Thanks,
JaeSang

Re: [PATCH] docs: update requirements to install six module

[Jonathan Corbet]

On Fri, 11 Dec 2020 10:15:36 +0900
JaeSang Yoo <js.yoo.5b@gmail.com> wrote:

> Is this meaning that some people are using older Sphinx?
> Then, there's no chance to leave from Python2.

We still support Sphinx back to 1.3, though that's pushing forward to 1.7
shortly.  The virtualenv approach is recommended as a way to get a
relatively predictable setup, but we don't force it on people.

And yes, decisions to drop Python 2 support and support for older Sphinx
versions kind of go together.

Thanks,

jon