Re: [LTP] [PATCH v3 1/2] doc: Document process_state

Petr Vorel
2026-01-07T15:06:06Z

> Hi!

> > @Andrea: I wish sphinx doc would warn about "undescribed" and I thought it did
> > in the past, but I don't see it.

> That's not sphinx, but the 'linuxdoc.rstKernelDoc' plugin we are using.
> It's developed for the kernel documentation (perhaps, we might upgrade
> it to the newest version) and it doesn't provide this.

I tried to update linuxdoc in the past. I remember warning were always there.

Update to 20240924 has only:
* a87ed0a ("[fix] export option to kernel-doc directive")
* 942fecd ("[fix]] kernel_include.py: cope with docutils 0.21")

And warnings are still there. But I might send a patch, better to stay on the
latest release (there are few more fixes, but unreleased).

> > Also we have too many (~ 220x) warnings:
> > "WARNING: duplicate label description, other instance in ..." it's not usable.
> > Any hint you could have look on it? If we solve this warning would get useful.

> The warnings you see are generated by:

> pip install linuxdoc
> linuxdoc.lintdoc include/

Thanks for a hint.

Kind regards,
Petr