From: Trevor Gross <tmgross@umich.edu>
To: FUJITA Tomonori <fujita.tomonori@gmail.com>, andrew@lunn.ch
Cc: netdev@vger.kernel.org, rust-for-linux@vger.kernel.org,
miguel.ojeda.sandonis@gmail.com, greg@kroah.com
Subject: Re: [PATCH v2 0/3] Rust abstractions for network PHY drivers
Date: Fri, 6 Oct 2023 20:42:37 -0400 [thread overview]
Message-ID: <CALNs47uzWDOt2ZS9JHOfPYRC4B4pm+bPrp1EnyT-PCRUwUVsFQ@mail.gmail.com> (raw)
In-Reply-To: <20231006094911.3305152-1-fujita.tomonori@gmail.com>
Replying here to a missed followup on rfc v3 [1]
On Mon, Oct 2, 2023 at 3:08 PM Andrew Lunn <andrew@lunn.ch> 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 <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
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/
[2]: https://lore.kernel.org/rust-for-linux/20230718151534.4067460-1-carlos.bilbao@amd.com/
prev parent reply other threads:[~2023-10-07 0:42 UTC|newest]
Thread overview: 49+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-06 9:49 [PATCH v2 0/3] Rust abstractions for network PHY drivers FUJITA Tomonori
2023-10-06 9:49 ` [PATCH v2 1/3] rust: core " FUJITA Tomonori
2023-10-07 5:06 ` Trevor Gross
2023-10-07 10:58 ` FUJITA Tomonori
2023-10-07 11:17 ` Greg KH
2023-10-07 11:23 ` FUJITA Tomonori
2023-10-07 11:30 ` Greg KH
2023-10-07 22:33 ` FUJITA Tomonori
2023-10-08 6:19 ` Trevor Gross
2023-10-08 7:49 ` FUJITA Tomonori
2023-10-08 8:54 ` Trevor Gross
2023-10-08 9:02 ` FUJITA Tomonori
2023-10-08 9:58 ` Trevor Gross
2023-10-07 23:26 ` Trevor Gross
2023-10-07 14:47 ` Andrew Lunn
2023-10-08 5:41 ` Trevor Gross
2023-10-07 15:13 ` Andrew Lunn
2023-10-08 6:07 ` Trevor Gross
2023-10-08 14:28 ` FUJITA Tomonori
2023-10-09 3:07 ` Trevor Gross
2023-10-06 9:49 ` [PATCH v2 2/3] MAINTAINERS: add Rust PHY abstractions to the ETHERNET PHY LIBRARY FUJITA Tomonori
2023-10-06 9:49 ` [PATCH v2 3/3] net: phy: add Rust Asix PHY driver FUJITA Tomonori
2023-10-06 10:31 ` Greg KH
2023-10-06 13:53 ` FUJITA Tomonori
2023-10-06 14:12 ` Greg KH
2023-10-06 14:30 ` FUJITA Tomonori
2023-10-06 14:37 ` Greg KH
2023-10-06 14:40 ` Andrew Lunn
2023-10-06 14:35 ` Andrew Lunn
2023-10-06 15:26 ` FUJITA Tomonori
2023-10-06 15:57 ` Andrew Lunn
2023-10-06 16:21 ` FUJITA Tomonori
2023-10-06 16:55 ` Andrew Lunn
2023-10-06 23:54 ` FUJITA Tomonori
2023-10-07 0:20 ` Andrew Lunn
2023-10-07 7:41 ` FUJITA Tomonori
2023-10-07 7:19 ` Trevor Gross
2023-10-07 12:07 ` FUJITA Tomonori
2023-10-07 15:39 ` Andrew Lunn
2023-10-08 7:11 ` Trevor Gross
2023-10-07 15:35 ` Andrew Lunn
2023-10-08 7:17 ` Trevor Gross
2023-10-06 12:54 ` [PATCH v2 0/3] Rust abstractions for network PHY drivers Andrew Lunn
2023-10-06 14:09 ` FUJITA Tomonori
2023-10-06 14:47 ` Andrew Lunn
2023-10-06 23:37 ` Trevor Gross
2023-10-07 3:26 ` FUJITA Tomonori
2023-10-09 12:39 ` Miguel Ojeda
2023-10-07 0:42 ` Trevor Gross [this message]
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=CALNs47uzWDOt2ZS9JHOfPYRC4B4pm+bPrp1EnyT-PCRUwUVsFQ@mail.gmail.com \
--to=tmgross@umich.edu \
--cc=andrew@lunn.ch \
--cc=fujita.tomonori@gmail.com \
--cc=greg@kroah.com \
--cc=miguel.ojeda.sandonis@gmail.com \
--cc=netdev@vger.kernel.org \
--cc=rust-for-linux@vger.kernel.org \
/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;
as well as URLs for NNTP newsgroup(s).