linux-kernel - Re: [PATCH v2] docs: sphinx-requirements: Move sphinx_rtd

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 10 Aug 2021 11:22:59 +0200
From:   Mauro Carvalho Chehab <mchehab@...nel.org>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] docs: sphinx-requirements: Move sphinx_rtd_theme to
 top

Em Tue, 10 Aug 2021 18:16:32 +0900
Akira Yokosawa <akiyks@...il.com> escreveu:

> sphinx_rtd_theme 0.5.2 has "docutils<0.17" in its requirements.
> docutils 0.17 released this April caused regression in
> sphinx_rtd_theme 0.5.1 [1].
> 
> By removing docutils and moving sphinx_rtd_theme before Sphinx in
> requirements.txt, the requirement of "docutils<0.17" can be met
> naturally.
> 
> [1]: https://github.com/readthedocs/sphinx_rtd_theme/issues/1112
> 
> Signed-off-by: Akira Yokosawa <akiyks@...il.com>
> Cc: Mauro Carvalho Chehab <mchehab@...nel.org>

This was needed when the minimal version was 1.x, but I guess
we can just get rid of docutils explicit dependency nowadays.

Acked-by: Mauro Carvalho Chehab <mchehab@...nel.org>

> ---
> Hi,
> 
> It is better to keep requirements as minimal as possible.
> Let's leave the dependency to the sphinx_rtd_theme package.
> 
> Changes in v1 [2] -> v2:
> 
>     o Remove docutils entry.
>     o Move sphinx_rtd_theme to top.
>     o Adjust patch title.
> 
> [2]: https://lore.kernel.org/linux-doc/974babfe-540f-40e4-38b3-ab294ba70ccc@gmail.com/
> 
>         Thanks, Akira
> --
>  Documentation/sphinx/requirements.txt | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
> index 489f6626de67..9a35f50798a6 100644
> --- a/Documentation/sphinx/requirements.txt
> +++ b/Documentation/sphinx/requirements.txt
> @@ -1,3 +1,2 @@
> -docutils
> -Sphinx==2.4.4
>  sphinx_rtd_theme
> +Sphinx==2.4.4



Thanks,
Mauro