From: Petr Vorel <pvorel@suse.cz>
To: Andrea Cervesato <andrea.cervesato@suse.com>
Cc: ltp@lists.linux.it
Subject: Re: [LTP] [PATCH v3 1/2] doc: Document process_state
Date: Wed, 7 Jan 2026 16:05:41 +0100 [thread overview]
Message-ID: <20260107150541.GA781042@pevik> (raw)
In-Reply-To: <DFICR5JD80LT.3B77J5KV4VLAY@suse.com>
> 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
--
Mailing list info: https://lists.linux.it/listinfo/ltp
next prev parent reply other threads:[~2026-01-07 15:06 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-07 11:11 [LTP] [PATCH v3 0/2] Add ground rules doc page Cyril Hrubis
2026-01-07 11:11 ` [LTP] [PATCH v3 1/2] doc: Document process_state Cyril Hrubis
2026-01-07 11:31 ` Petr Vorel
2026-01-07 12:23 ` Andrea Cervesato via ltp
2026-01-07 15:05 ` Petr Vorel [this message]
2026-01-12 8:32 ` Petr Vorel
2026-01-07 11:11 ` [LTP] [PATCH v3 2/2] doc: Add ground rules page Cyril Hrubis
2026-01-07 13:00 ` Li Wang via ltp
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260107150541.GA781042@pevik \
--to=pvorel@suse.cz \
--cc=andrea.cervesato@suse.com \
--cc=ltp@lists.linux.it \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox