Re: [RFC PATCH v3 1/3] rust: core abstractions for network PHY drivers

[Andrew Lunn <andrew@lunn.ch>]

On Mon, Oct 02, 2023 at 06:24:33PM +0200, Miguel Ojeda wrote:
> On Mon, Oct 2, 2023 at 4:08 PM Andrew Lunn <andrew@lunn.ch> wrote:
> >
> > Can we expect to see a section maybe referenced in
> > https://docs.kernel.org/next/networking/phy.html generate from the
> > Rust code?
> 
> If I understand correctly, you are asking about having the Rust docs
> linked within the C docs, rather than the other way around, right?

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 <corbet@lwn.net>
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