linux-kernel - Re: [PATCH net-next v1 1/1] net: phy: Move callback comments from struct to kernel-doc section

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <7801c223-b45f-4f21-9ba1-bddce2ab0d9e@intel.com>
Date: Tue, 10 Dec 2024 13:03:44 +0100
From: Mateusz Polchlopek <mateusz.polchlopek@...el.com>
To: Oleksij Rempel <o.rempel@...gutronix.de>, "David S. Miller"
	<davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, Jakub Kicinski
	<kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>, Andrew Lunn
	<andrew+netdev@...n.ch>, Heiner Kallweit <hkallweit1@...il.com>, "Jonathan
 Corbet" <corbet@....net>
CC: <kernel@...gutronix.de>, <linux-kernel@...r.kernel.org>,
	<netdev@...r.kernel.org>, Simon Horman <horms@...nel.org>, Russell King
	<linux@...linux.org.uk>, Maxime Chevallier <maxime.chevallier@...tlin.com>,
	<linux-doc@...r.kernel.org>
Subject: Re: [PATCH net-next v1 1/1] net: phy: Move callback comments from
 struct to kernel-doc section



On 12/6/2024 12:39 PM, Oleksij Rempel wrote:
> Relocate all callback-related comments from the `struct phy_driver`
> definition to a dedicated `kernel-doc` section. This improves code
> readability by decluttering the structure definition and consolidating
> callback documentation in a central place for kernel-doc generation.
> 
> No functional changes are introduced by this patch.
> 
> Signed-off-by: Oleksij Rempel <o.rempel@...gutronix.de>
> ---
>   include/linux/phy.h | 705 ++++++++++++++++++++++++++++++++------------
>   1 file changed, 522 insertions(+), 183 deletions(-)

[...]

Nice cleanup! The only nitpick is about the "Returns" statement in
functions. According to the kdoc it should be "Return:" . But
nevertheless it looks good, so:

Reviewed-by: Mateusz Polchlopek <mateusz.polchlopek@...el.com>