linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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/4] Improve Sphinx kerneldoc extension
Date: Tue, 15 Apr 2025 11:12:47 +0800	[thread overview]
Message-ID: <cover.1744685912.git.mchehab+huawei@kernel.org> (raw)

Hi Jon,

As promised, this series improves the Sphinx kerneldoc extension making it using the
kernel-doc.py classes directly if available.

The script still supports excecuting kernel-doc via shell, and, in verbose mode, it will
show the command line arguments to run kernel-doc manually, even when the Python
classes are used. The idea is that the command line verbose will help to eventually
debug issues if one needs to run kernel-doc.py manually. 

On other words, after this series, if one does:

	make htmldocs KERNELDOC=scripts/kernel-doc.py

Or, simply (as internally KERNELDOC is set to scripts/kernel-doc.py):

	make htmldocs

It will use the Python classes instead of running a subprocess.

If one uses, instead:

	make htmldocs KERNELDOC=scripts/kernel-doc
or:
	make htmldocs KERNELDOC=scripts/kernel-doc.pl

As the file extension doesn't end with .py, it will excecute the Python or the Perl
version of kernel-doc via a subprocess.

On this version, I opted to re-create the Python objects for every single kernel-doc
line, so no caches from past runs are used. I'm working on a version that will cache
results, but it is currently causing some regressions. So, let's do the changes
step-by-step, applying first this improvement patch series.

PS.: the first patches on this series are addressing some some bugs and one
improvement that I noticed while debugging the patch changing kerneldoc
Sphinx extension.

Mauro Carvalho Chehab (4):
  scripts/lib/kdoc/kdoc_files.py: don't try to join None
  scripts/lib/kdoc/kdoc_parser.py: move states to a separate class
  scripts:kdoc_files.py: use glob for export_file seek
  docs: sphinx: kerneldoc: Use python class if available

 Documentation/sphinx/kerneldoc.py | 138 ++++++++++++++++++++++++++++--
 scripts/lib/kdoc/kdoc_files.py    |  11 ++-
 scripts/lib/kdoc/kdoc_parser.py   | 119 ++++++++++++++------------
 3 files changed, 200 insertions(+), 68 deletions(-)

-- 
2.49.0



             reply	other threads:[~2025-04-15  3:13 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-15  3:12 Mauro Carvalho Chehab [this message]
2025-04-15  3:12 ` [PATCH 1/4] scripts/lib/kdoc/kdoc_files.py: don't try to join None Mauro Carvalho Chehab
2025-04-15  3:12 ` [PATCH 2/4] scripts/lib/kdoc/kdoc_parser.py: move states to a separate class Mauro Carvalho Chehab
2025-04-15  3:12 ` [PATCH 3/4] scripts:kdoc_files.py: use glob for export_file seek Mauro Carvalho Chehab
2025-04-15  3:12 ` [PATCH 4/4] docs: sphinx: kerneldoc: Use python class if available Mauro Carvalho Chehab
2025-04-21 17:42 ` [PATCH 0/4] Improve Sphinx kerneldoc extension Jonathan Corbet
2025-04-24  0:43   ` 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.1744685912.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).