Some small improvements for kernel-doc generation
Status from this message: Applied, thanks,
Get series with b4
b4 am [email protected]Versions newest first
Patches in v1 Applied
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/3 | docs: Sphinx: kerneldoc: only initialize kernel-doc classes onceDocumentation/ | +11 | 1 reply | |
| 2/3 | scripts/lib/kdoc: change mode to 0644scripts/ scripts/ scripts/ | +0 | 0 replies | |
| 3/3 | scripts/lib/kdoc/kdoc_parser.py: move kernel entry to a classscripts/ | +151 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.
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