From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org
Subject: [PATCH 0/3] Some small improvements for kernel-doc generation
Date: Fri, 25 Apr 2025 15:13:37 +0800 [thread overview]
Message-ID: <cover.1745564565.git.mchehab+huawei@kernel.org> (raw)
Hi Jon,
This series contain 3 patches for kernel-doc:
Patch 1 creates a kernel doc class at the beginning of kerneldoc Sphinx
module and preserves it. With that, some caching is enabled;
Patch 2 fixes some permissions;
Patch 3 is mostly a cleanup patch to simplify a little bit the complex parser.
On my tests here, it runs about 10 seconds faster on my machine
and I didn't notice any regressions.
I guess there are still space to optimize the cache, but I don't want to
do too much optimization on a single series.
Please also notice that I didn't check the amount of memory that it is
now consumed storing the entire kernel-doc data on a dictionary.
I assume it is not that much, as I can still compile docs on my 16GB
laptop.
Mauro Carvalho Chehab (3):
docs: Sphinx: kerneldoc: only initialize kernel-doc classes once
scripts/lib/kdoc: change mode to 0644
scripts/lib/kdoc/kdoc_parser.py: move kernel entry to a class
Documentation/sphinx/kerneldoc.py | 23 ++-
scripts/lib/kdoc/kdoc_output.py | 0
scripts/lib/kdoc/kdoc_parser.py | 277 ++++++++++++++++--------------
scripts/lib/kdoc/kdoc_re.py | 0
4 files changed, 162 insertions(+), 138 deletions(-)
mode change 100755 => 100644 scripts/lib/kdoc/kdoc_output.py
mode change 100755 => 100644 scripts/lib/kdoc/kdoc_parser.py
mode change 100755 => 100644 scripts/lib/kdoc/kdoc_re.py
--
2.49.0
next reply other threads:[~2025-04-25 7:13 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-25 7:13 Mauro Carvalho Chehab [this message]
2025-04-25 7:13 ` [PATCH 1/3] docs: Sphinx: kerneldoc: only initialize kernel-doc classes once Mauro Carvalho Chehab
2025-04-25 7:29 ` Mauro Carvalho Chehab
2025-04-25 7:13 ` [PATCH 2/3] scripts/lib/kdoc: change mode to 0644 Mauro Carvalho Chehab
2025-04-25 7:13 ` [PATCH 3/3] scripts/lib/kdoc/kdoc_parser.py: move kernel entry to a class Mauro Carvalho Chehab
2025-04-28 23:34 ` [PATCH 0/3] Some small improvements for kernel-doc generation 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.1745564565.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).