From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
linux-kernel@vger.kernel.org, Hans de Goede <hdegoede@redhat.com>,
Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH v3 0/6] Better handle dependencies on Sphinx extensions
Date: Sat, 26 Mar 2022 11:27:18 +0100 [thread overview]
Message-ID: <cover.1648290305.git.mchehab@kernel.org> (raw)
Sphinx has its own way to identify the need of rebuilding the documentation.
It means that extensions need to use an internal API in order to notify about
the need to consider other files.
The kerneldoc.py extension already does that, maintainers_include.py doesn't
need (as it uses an API that internally does that), and kfigure.py does it on a
different way. So, those are already safe.
However, other extensions don't notify nor implement their own checks,
so, when a file that was parsed by them is changed, the corresponding
documentation won't be rebuilt.
This series add support for it for ABI, features and kernel-include.
---
v3:
- Changed the meta-tag used when --enable-lineno and --enable-fname
are used at the scripts that generate ReST output.
Mauro Carvalho Chehab (6):
scripts/get_feat.pl: allow output the parsed file names
docs: kernel_feat.py: add build dependencies
docs: kernel_abi.py: add sphinx build dependencies
docs: kernel_include.py: add sphinx build dependencies
scripts/get_abi: change the file/line number meta info
scripts/kernel-doc: change the line number meta info
Documentation/sphinx/kernel_abi.py | 6 +++++-
Documentation/sphinx/kernel_feat.py | 20 ++++++++++++++++++--
Documentation/sphinx/kernel_include.py | 3 +++
Documentation/sphinx/kerneldoc.py | 2 +-
scripts/get_abi.pl | 4 ++--
scripts/get_feat.pl | 11 +++++++++++
scripts/kernel-doc | 4 ++--
7 files changed, 42 insertions(+), 8 deletions(-)
--
2.35.1
next reply other threads:[~2022-03-26 10:27 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-26 10:27 Mauro Carvalho Chehab [this message]
2022-03-26 10:27 ` [PATCH v3 1/6] scripts/get_feat.pl: allow output the parsed file names Mauro Carvalho Chehab
2022-03-26 10:27 ` [PATCH v3 2/6] docs: kernel_feat.py: add build dependencies Mauro Carvalho Chehab
2022-03-26 10:27 ` [PATCH v3 3/6] docs: kernel_abi.py: add sphinx " Mauro Carvalho Chehab
2022-03-26 10:27 ` [PATCH v3 4/6] docs: kernel_include.py: " Mauro Carvalho Chehab
2022-03-26 10:27 ` [PATCH v3 5/6] scripts/get_abi: change the file/line number meta info Mauro Carvalho Chehab
2022-03-26 10:27 ` [PATCH v3 6/6] scripts/kernel-doc: change the line " Mauro Carvalho Chehab
2022-03-28 20:00 ` [PATCH v3 0/6] Better handle dependencies on Sphinx extensions 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=cover.1648290305.git.mchehab@kernel.org \
--to=mchehab@kernel.org \
--cc=corbet@lwn.net \
--cc=hdegoede@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
/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.