Skip to content

Some small improvements for kernel-doc generation

Mauro Carvalho Chehab linux-doc lkml 1 version Applied

Status from this message: Applied, thanks,

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest3 patches 2 repliesApplied

Patches in v1 Applied

#Subject and filesSizeRepliesApplied
1/3docs: Sphinx: kerneldoc: only initialize kernel-doc classes onceDocumentation/sphinx/kerneldoc.py+11 -121 reply
2/3scripts/lib/kdoc: change mode to 0644scripts/lib/kdoc/kdoc_output.py scripts/lib/kdoc/kdoc_parser.py scripts/lib/kdoc/kdoc_re.py+0 -00 replies
3/3scripts/lib/kdoc/kdoc_parser.py: move kernel entry to a classscripts/lib/kdoc/kdoc_parser.py+151 -1260 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/3] Some small improvements for kernel-doc generation

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
Signature · 1 line
2.49.0