From: Jonathan Corbet <corbet@lwn.net>
To: Kees Cook <keescook@chromium.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Jani Nikula <jani.nikula@linux.intel.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 0/2] docs: Programmatically render MAINTAINERS into ReST
Date: Tue, 1 Oct 2019 11:05:49 -0600 [thread overview]
Message-ID: <20191001110549.4b497f32@lwn.net> (raw)
In-Reply-To: <201910010913.2BAAC8A@keescook>
On Tue, 1 Oct 2019 09:16:41 -0700
Kees Cook <keescook@chromium.org> wrote:
> > > This almost certainly has to do with the fact that I'm (intentionally)
> > > running the Python2 Sphinx build here. Something's not doing unicode that
> > > should be.
>
> Given this would be for v5.5, and python2 is EOL in 2 months[1], I don't
> think it's unreasonable to deprecate it. Especially considering there
> are already explicit "python3" shebangs in existing code in the sphinx/
> directory.
Two months and 30 days, don't exaggerate, man! :)
FWIW, the "shebangs" in that directory are no-ops. Those are extensions
read into sphinx, not standalone programs; they go into a Python 2 sphinx
instance just fine.
Which isn't an argument against dropping Python 2, of course. That's
really just a matter of when.
> > I'm almost sure we got this already. If I'm not mistaken, the solution
> > is to add the encoding line after shebang. Looking at
> > Documentation/sphinx/maintainers_include.py (patch 2/2), the script
> > starts with:
> >
> > #!/usr/bin/env python
> > # SPDX-License-Identifier: GPL-2.0
> > # -*- coding: utf-8; mode: python -*-
> > # pylint: disable=R0903, C0330, R0914, R0912, E0401
> >
> > But, as I pointed before, the SPDX header at the wrong place is causing the
> > crash, as the encoding line should be the second line, not the third one,
> > e. g.:
> >
> > #!/usr/bin/env python
> > # -*- coding: utf-8; mode: python -*-
> > # SPDX-License-Identifier: GPL-2.0
> > # pylint: disable=R0903, C0330, R0914, R0912, E0401
> >
> > I also suspect that this would happen even with python3, depending on
> > how LC_ALL, LANG, ... are set on the distro you use.
>
> Oh that's a delightful bug. :P I haven't been able to reproduce this
> failure (maybe all my LANG junk is accidentally correct)?
Delightful - and wrong; moving that line around doesn't change anything.
The crash comes from deep within sphinx; the more I look at it the more
confused I get. Stay tuned...
jon
next prev parent reply other threads:[~2019-10-01 17:05 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-24 23:02 [PATCH 0/2] docs: Programmatically render MAINTAINERS into ReST Kees Cook
2019-09-24 23:02 ` [PATCH 1/2] doc-rst: Reduce CSS padding around Field Kees Cook
2019-09-24 23:02 ` [PATCH 2/2] doc-rst: Programmatically render MAINTAINERS into ReST Kees Cook
2019-10-01 14:31 ` [PATCH 0/2] docs: " Jonathan Corbet
2019-10-01 15:09 ` Mauro Carvalho Chehab
2019-10-01 16:16 ` Kees Cook
2019-10-01 17:05 ` Jonathan Corbet [this message]
2019-10-01 17:35 ` Jonathan Corbet
2019-10-01 18:26 ` Kees Cook
2019-10-01 16:27 ` Kees Cook
2019-10-01 17:36 ` 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=20191001110549.4b497f32@lwn.net \
--to=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).