Re: [PATCH net-next v6 1/5] rust: core abstractions for network PHY drivers
From: FUJITA Tomonori <fujita.tomonori@gmail.com>
Date: 2023-10-25 10:57:45
Also in:
rust-for-linux
From: FUJITA Tomonori <fujita.tomonori@gmail.com>
Date: 2023-10-25 10:57:45
Also in:
rust-for-linux
On Wed, 25 Oct 2023 07:24:00 +0000 Benno Lossin [off-list ref] wrote:
quoted
/// PHY state machine states. /// /// Corresponds to the kernel's /// [`enum phy_state`](../../../../../networking/kapi.html#c.phy_state). /// /// Some of PHY drivers access to the state of PHY's software state machine.That is one way, another would be to do:
This looks nicer.
/// PHY state machine states. /// /// Corresponds to the kernel's [`enum phy_state`]. /// /// Some of PHY drivers access to the state of PHY's software state machine. /// /// [`enum phy_state`]: ../../../../../networking/kapi.html#c.phy_state But as I noted before, then people who only build the rustdoc will not be able to view it. I personally would prefer to have the correct link offline, but do not know about others.
I prefer a link to online docs but either is fine by me. You prefer a link to a header file like? /// [`enum phy_state`]: ../../../include/linux/phy.h
quoted
quoted
quoted
+ /// Gets the current link state. It returns true if the link is up.I just noticed this as well, here also please split the line.
Fixed all.