From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/2] docs: cdomain.py: add support for two new Sphinx 3.1+ tags
Date: Thu, 24 Sep 2020 18:13:54 +0200 [thread overview]
Message-ID: <20200924181354.59087a8d@coco.lan> (raw)
In-Reply-To: <20200924094335.65944316@lwn.net>
Em Thu, 24 Sep 2020 09:43:35 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:
> So I'm just getting into this and trying to understand what's really going
> on, but one thing jumped at me:
>
> On Thu, 24 Sep 2020 13:22:04 +0200
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
>
> > +# Namespace to be prepended to the full name
> > +namespace = None
^^^ See here....
> > +
> > +#
> > +# Handle trivial newer c domain tags that are part of Sphinx 3.1 c domain tags
> > +# - Convert :c:expr:`foo` into ``foo``
> > +# - Store the namespace if ".. c:namespace::" tag is found
> > +
> > +RE_namespace = re.compile(r'^\s*..\s*c:namespace::\s*(\S+)\s*$')
> > +RE_expr = re.compile(r':c:expr:`([^\`]+)`')
> > +
> > +def markup_namespace(match):
> > + namespace = match.group(1)
> > +
> > + return ""
> > +
>
> How can this possibly work without a "global namespace" declaration in
> markup_namespace()?
... While I'm not a python expert, the namespace variable is global
because it was defined outside the "markup_namespace" function.
-
On a quick check at the internet, this is supposed to work properly:
https://www.programiz.com/python-programming/global-local-nonlocal-variables
-
In any cases, on my tests, this is working properly.
Anyway, I'm sending a version 2 of the series, addressing the
namespace for the remaining files under userspace-api/media.
You can try building the media books without and with the
patch series, in order to see the differences.
There are still ~200 warnings produced after that, but it
sounds that the remaining issues will require changes at
kernel-doc.
Thanks,
Mauro
next prev parent reply other threads:[~2020-09-24 16:14 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20200924090230.6f3b0ca1@coco.lan>
2020-09-24 11:22 ` [PATCH 0/2] Start supporting builds with Sphinx 3.1+ Mauro Carvalho Chehab
2020-09-24 11:22 ` [PATCH 1/2] docs: cdomain.py: add support for two new Sphinx 3.1+ tags Mauro Carvalho Chehab
2020-09-24 15:43 ` Jonathan Corbet
2020-09-24 16:13 ` Mauro Carvalho Chehab [this message]
2020-09-24 16:22 ` Jonathan Corbet
2020-09-25 4:14 ` Mauro Carvalho Chehab
2020-09-24 11:22 ` [PATCH 2/2] media: docs: make CEC documents compatible with Sphinx 3.1+ Mauro Carvalho Chehab
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=20200924181354.59087a8d@coco.lan \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.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