From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 04/33] docs: update recommended Sphinx version to 2.4.4
Date: Mon, 20 Apr 2020 15:27:29 -0600 [thread overview]
Message-ID: <20200420152729.40cb10e1@lwn.net> (raw)
In-Reply-To: <498f701c618f7d0cf5f0a37e5889ee926f7c8bf4.1586881715.git.mchehab+huawei@kernel.org>
On Tue, 14 Apr 2020 18:48:30 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> The Sphinx check script is already smart enough to keep
> working, with older versions, warning the users that
> an upgrade is recommended (and explaining how):
>
> Sphinx version 1.7.9
> Warning: It is recommended at least Sphinx version 2.4.4.
> Detected OS: Fedora release 31 (Thirty One).
>
> To upgrade Sphinx, use:
>
> /usr/bin/virtualenv sphinx_2.4.4
> . sphinx_2.4.4/bin/activate
> pip install -r ./Documentation/sphinx/requirements.txt
Sigh...that version is all of a month and some old. I hate to be pushing
people that hard on the upgrade treadmill.
I'm still looking over the set, and will probably apply this, but I think
we should consider tweaking this before 5.8:
- Can we make the warning more explicit that 2.4.4 is needed *if you are
generating PDF*? Most people, I think, don't do that, and can live
happily with an older version.
- Perhaps the time has come to raise the lower bound to, say, 1.7? That
might let us get rid of a bit of cruft.
Thanks,
jon
next prev parent reply other threads:[~2020-04-20 21:27 UTC|newest]
Thread overview: 81+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-14 16:48 [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [Ocfs2-devel] " Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 01/33] scripts: kernel-doc: proper handle @foo->bar() Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 02/33] scripts: kernel-doc: accept negation like !@var Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 03/33] scripts: kernel-doc: accept blank lines on parameter description Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 04/33] docs: update recommended Sphinx version to 2.4.4 Mauro Carvalho Chehab
2020-04-20 21:27 ` Jonathan Corbet [this message]
2020-04-20 22:12 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 05/33] docs: LaTeX/PDF: drop list of documents Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 06/33] MAINTAINERS: dt: update display/allwinner file entry Mauro Carvalho Chehab
2020-04-16 21:14 ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 07/33] MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and RealView Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 08/33] docs: dt: fix broken reference to phy-cadence-torrent.yaml Mauro Carvalho Chehab
2020-04-14 21:01 ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 09/33] docs: fix broken references to text files Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 10/33] docs: fix broken references for ReST files that moved around Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-16 8:31 ` Corentin Labbe
2020-04-16 8:31 ` Corentin Labbe
2020-04-14 16:48 ` [PATCH v2 11/33] docs: filesystems: fix renamed references Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [Ocfs2-devel] " Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 12/33] docs: amu: supress some Sphinx warnings Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 13/33] docs: arm64: booting.rst: get rid of some warnings Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 14/33] docs: pci: boot-interrupts.rst: improve html output Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 15/33] docs: ras: get rid of some warnings Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 16/33] docs: ras: don't need to repeat twice the same thing Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 17/33] docs: infiniband: verbs.c: fix some documentation warnings Mauro Carvalho Chehab
2020-04-14 19:33 ` Jason Gunthorpe
2020-04-14 16:48 ` [PATCH v2 18/33] docs: spi: spi.h: fix a doc building warning Mauro Carvalho Chehab
2020-04-14 16:54 ` Mark Brown
2020-04-14 16:48 ` [PATCH v2 19/33] docs: drivers: fix some warnings at base/platform.c when building docs Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 20/33] docs: mm: userfaultfd.rst: use ``foo`` for literals Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 21/33] docs: mm: userfaultfd.rst: use a cross-reference for a section Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 22/33] docs: vm: index.rst: add an orphan doc to the building system Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 23/33] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file Mauro Carvalho Chehab
2020-04-14 21:01 ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 24/33] docs: dt: fix a broken reference for a file converted to json Mauro Carvalho Chehab
2020-04-14 21:02 ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 25/33] docs: powerpc: cxl.rst: mark two section titles as such Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-15 0:16 ` Andrew Donnellan
2020-04-15 0:16 ` Andrew Donnellan
2020-04-14 16:48 ` [PATCH v2 26/33] docs: i2c: rename i2c.svg to i2c_bus.svg Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 27/33] docs: Makefile: place final pdf docs on a separate dir Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 28/33] docs: dt: rockchip, dwc3.txt: " Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 21:02 ` [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: " Rob Herring
2020-04-14 21:02 ` [PATCH v2 28/33] docs: dt: rockchip, dwc3.txt: " Rob Herring
2020-04-14 21:02 ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 29/33] ata: libata-core: fix a doc warning Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 30/33] firewire: firewire-cdev.hL get rid of a docs warning Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 31/33] fs: inode.c: get rid of docs warnings Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 32/33] futex: get rid of a kernel-docs build warning Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 33/33] lib: bitmap.c: get rid of some doc warnings Mauro Carvalho Chehab
2020-04-24 17:30 ` Peter Lister
2020-04-20 21:43 ` [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Jonathan Corbet
2020-04-20 21:43 ` Jonathan Corbet
2020-04-20 21:43 ` Jonathan Corbet
2020-04-20 21:43 ` Jonathan Corbet
2020-04-20 21:43 ` Jonathan Corbet
2020-04-20 21:43 ` Jonathan Corbet
2020-04-20 21:43 ` Jonathan Corbet
2020-04-20 21:43 ` [Ocfs2-devel] " Jonathan Corbet
2020-04-20 21:43 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200420152729.40cb10e1@lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.