netdev - Re: [PATCH net-next v6 1/5] rust: core abstractions for network PHY drivers

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20231025.195741.1692073290373860448.fujita.tomonori@gmail.com>
Date: Wed, 25 Oct 2023 19:57:41 +0900 (JST)
From: FUJITA Tomonori <fujita.tomonori@...il.com>
To: benno.lossin@...ton.me
Cc: fujita.tomonori@...il.com, netdev@...r.kernel.org,
 rust-for-linux@...r.kernel.org, andrew@...n.ch, tmgross@...ch.edu,
 miguel.ojeda.sandonis@...il.com, wedsonaf@...il.com, greg@...ah.com
Subject: Re: [PATCH net-next v6 1/5] rust: core abstractions for network
 PHY drivers

On Wed, 25 Oct 2023 07:24:00 +0000
Benno Lossin <benno.lossin@...ton.me> wrote:

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


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