Hi Jon,
That's the second version of the Python kernel-doc tool.
As the previous version, I tried to stay as close as possible of the original
Perl implementation, as it helps to double check if each function was
properly translated to Python. This have been helpful debugging troubles
that happened during the conversion.
On this version, the ReST output for the files included under Documentation
is identical to the perl version, except for:
- blank lines;
- white spaces;
- this version suppresses return (and description) sections on a few places
where this is left in blank.
This version also replaces the old script by the new one for doc generation,
to make easier to test its results.
It should be noticed that there are some sutile nuances on the way Perl
and Python handle regular expressions. In particular, Perl compiled
expressions with qr{} behaves as non-capturing groups, sometimes optional
ones. I documented it on one place, but I had to use non-capturing groups
on other parts of the logic to achieve the desired results.
This version is on a minimal integration scenario: it just replaces the
exec file to use the new one and gets rid of an obsolete parameter
as on this version I didn't implement support for Sphinx < 3.1.
On other words, it assumes that the patch requiring Sphinx >= 3.4
will be merged.
I also didn't remove on this series the old kernel-doc script, as this makes
easier to test both variations, e. g. using:
make cleandocs && make KERNELDOC=scripts/kernel-doc htmldocs
will make it use the original Perl version.
Comments?
Mauro Carvalho Chehab (5):
include/asm-generic/io.h: fix kerneldoc markup
scripts/kernel-doc: remove an obscure logic from kernel-doc
scripts/kernel-doc: don't add not needed new lines
scripts/kernel-doc.py: add a Python parser
docs: use kernel-doc.py script for kerneldoc output
Documentation/Makefile | 2 +-
Documentation/conf.py | 2 +-
Documentation/sphinx/kerneldoc.py | 5 -
include/asm-generic/io.h | 6 +-
scripts/kernel-doc | 23 +-
scripts/kernel-doc.py | 2752 +++++++++++++++++++++++++++++
6 files changed, 2762 insertions(+), 28 deletions(-)
create mode 100755 scripts/kernel-doc.py
--
2.48.1
