linux-kernel - Re: [PATCH RFC] docs: add python module documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87wm1lw89g.fsf@trenco.lwn.net>
Date: Tue, 13 Jan 2026 13:46:35 -0700
From: Jonathan Corbet <corbet@....net>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Linux Doc Mailing
 List <linux-doc@...r.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
 linux-kernel@...r.kernel.org, Mauro Carvalho Chehab <mchehab@...nel.org>,
 Randy Dunlap <rdunlap@...radead.org>, Shuah Khan
 <skhan@...uxfoundation.org>
Subject: Re: [PATCH RFC] docs: add python module documentation

Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:

> Hi Jon,
>
> While checking/improving docstrings inside kernel-doc, I noticed
> that some changes there aren't Sphinx-compatible. Also, there are
> several functions and some classes that miss documentation.
>
> Being responsible for doing some documentation work, I felt blamed
> on not having a good documentation of our own dog food :-)
>
> So, I'm adding kdoc documentation to the Kernel documentation. The basic
> change is just a couple of extra lines at conf.py, plus a few *.rst files
> pointing to the files we want to document:

At a first glance, this looks like a worthy task.

I've never really played with autodoc.  Sure you don't want to fix up
kernel-doc to read Python code too? :)  Seriously, though, I worry that
it could end up cluttering the code with a bunch of sphinxstuff, but the
only way to really see is to try it.

Thanks,

jon