From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH 0/2] Fix build issues with Sphinx development tree
Date: Thu, 15 Oct 2020 10:12:10 +0200 [thread overview]
Message-ID: <cover.1602749214.git.mchehab+huawei@kernel.org> (raw)
This Sphinx pull:
https://github.com/sphinx-doc/sphinx/pull/8313
Fixes the C domain name conflicts when both a function and an
enum, struct or union have the same name. Those fixes will generate
new C domain warnings if an enum is defined using :c:struct.
So, we need to use different tags for structs or union. Thankfully,
such change is backward compatible with Shinx 3.x. The first
patch address it.
The second patch fix an issue at conf.py.
While Sphinx 4.0 was not released yet, the Sphinx development branch
is using 4.0.0 as its version. There is a small issue at the code that
excludes some macros from functions, if Sphinx major version is > 3.
Mauro Carvalho Chehab (2):
scripts: kernel-doc: use :c:union when needed
sphinx: conf.py: properly handle Sphinx 4.0
Documentation/conf.py | 2 +-
scripts/kernel-doc | 6 +++++-
2 files changed, 6 insertions(+), 2 deletions(-)
--
2.26.2
next reply other threads:[~2020-10-15 8:12 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-15 8:12 Mauro Carvalho Chehab [this message]
2020-10-15 8:12 ` [PATCH 1/2] scripts: kernel-doc: use :c:union when needed Mauro Carvalho Chehab
2020-10-15 8:12 ` [PATCH 2/2] sphinx: conf.py: properly handle Sphinx 4.0 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=cover.1602749214.git.mchehab+huawei@kernel.org \
--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;
as well as URLs for NNTP newsgroup(s).