docs: Better handle kernel-doc class
Get series with b4
b4 am [email protected]Versions newest first
- v1 Latest2 patches 0 repliesNew
Patches in v1 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/2 | scripts: kernel-doc: prevent a KeyError when checking outputscripts/ | +4 | 0 replies | |
| 2/2 | docs: kerneldoc.py: add try/except blocks for kernel-doc class errorsDocumentation/ | +17 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.
Cover letter [PATCH 0/2] docs: Better handle kernel-doc class
Currently, there is an issue with kernel-doc KernelFiles class:
if one tries to add a kernel-doc tag to a non-existing file, it will produce a KeyError, as KernelFiles.msg() will try to pick a key from a non-existing file. Add a check to prevent such error.
With that, building docs with broken files will work as before(*):
$ make htmldocs ... Cannot find file ./drivers/gpio/gpiolib-acpi.c Cannot find file ./drivers/gpio/gpiolib-acpi.c No kernel-doc for file ./drivers/gpio/gpiolib-acpi.c ... Documentation/arch/powerpc/htm.rst: WARNING: document isn't included in any toctree
While here, also better handle errors at the kernel-doc classes.
(*) IMO, this is the wrong behavior, but let's discuss it in separate.
Mauro Carvalho Chehab (2):
scripts: kernel-doc: prevent a KeyError when checking output
docs: kerneldoc.py: add try/except blocks for kernel-doc class errors
Documentation/sphinx/kerneldoc.py | 21 +++++++++++++++++---- scripts/lib/kdoc/kdoc_files.py | 4 ++++ 2 files changed, 21 insertions(+), 4 deletions(-)
Signature · 1 line
2.49.0