Thread (49 messages) 49 messages, 5 authors, 2023-10-09

Re: [PATCH v2 0/3] Rust abstractions for network PHY drivers

From: Trevor Gross <tmgross@umich.edu>
Date: 2023-10-07 00:42:50
Also in: rust-for-linux

Replying here to a missed followup on rfc v3 [1]

On Mon, Oct 2, 2023 at 3:08 PM Andrew Lunn [off-list ref] wrote:
The kernel is documented using kerneldoc. It would seem odd to me to
have a second parallel set of Documentation for Rust. Just like Rust
is integrated into the kernel tree, is configured using Kconfig, built
using make at the top level, i would also expect it to integrate into
kerneldoc somehow. I see the Rust API for PHY drivers next to the C
API for PHY drivers. Its just another API in the kernel, nothing
special. I just use 'make htmldocs' at the top level and out come the
HTML documentation in Documentation/output/

But kerneldoc is not my subsystem. MAINTAINERS say:

DOCUMENTATION
M:      Jonathan Corbet [off-list ref]
L:      linux-doc@vger.kernel.org
S:      Maintained

So this discussion should really have Jonathon Corbet involved, if it
has not already been done.

    Andrew
Having the documentation in the same place and able to easily
crosslink is a goal, but it's still a work in progress. It won't look
the same of course but I think that the rustdoc output will be under
kerneldoc, with some sort of automated crosslinking between related
modules.

The docs team is in the loop, see [2] which was merged. (I suppose it
must not be getting published still)

- Trevor

[1]: https://lore.kernel.org/rust-for-linux/78da96fc-cf66-4645-a98f-80e404800d3e@lunn.ch/ (local)
[2]: https://lore.kernel.org/rust-for-linux/20230718151534.4067460-1-carlos.bilbao@amd.com/ (local)
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help