On 25.10.23 12:57, FUJITA Tomonori wrote:

On Wed, 25 Oct 2023 07:24:00 +0000
Benno Lossin [off-list ref] wrote:

quoted

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.

quoted

/// 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

No. I think the header file should be mentioned for the whole
abstraction. I personally always use [1] to search for C symbols, so
the name suffices for me. And the documentation is (for me at least)
less accessible (if there is a nice tool for that as well, please tell me).

[1]: https://elixir.bootlin.com/linux/latest/source

-- 
Cheers,
Benno